InvitedUsers

To add new users to an Organization, you need to send each one an Invitation to join your TIBCO Scribe® Organization, either as a User or as another Administrator. They can either Accept or Decline the Invitation. Once the Invitation has been sent and accepted, the person you invited has access to this Organization. How they can use TIBCO Scribe® and the Organization depends on their role, as either a User or an Administrator. See roleType in the Fields table.

Endpoints — Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.

Fields For InvitedUsers Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Considerations

In some cases there are special considerations or use cases for specific endpoints that you should know about before you use the endpoint.

DELETE /v1/orgs/{orgId}/invitedusers

  • Only pending and declined invitations can be deleted. Use the Delete User command under Organizations to delete users who have accepted their invitations.

Endpoints

Delete an invited User

Return a list of invited Users

Invite a User

Return information about an invited User

Modify an invited User

Fields For InvitedUsers Endpoints

The list of fields defined in this table is comprehensive across all InvitedUsers endpoints. See Endpoints for a list of InvitedUsers endpoints with links to the associated Swagger page.

Name
Type
Data Type

Description

Endpoints

Parameters

email

query

string

Email address of the invited User. Required
  • DELETE /v1/orgs/{orgId}/invitedusers
  • GET /v1/orgs/{orgId}/invitedusers/{email}
  • PUT /v1/orgs/{orgId}/invitedusers/{email}

model

body

model

Model for the new invited user record. Required fields include: email, statusType, and roleType. Required
  • POST /v1/orgs/{orgId}/invitedusers
  • PUT /v1/orgs/{orgId}/invitedusers/{email}

orgId

path

integer

Unique ID for each Organization. Required

All

Response

email

response

string

Email address of the invited User. Email address serves as an ID and must be unique for each User.

  • GET /v1/orgs/{orgId}/invitedusers
  • POST /v1/orgs/{orgId}/invitedusers
  • GET /v1/orgs/{orgId}/invitedusers/{email}
  • PUT /v1/orgs/{orgId}/invitedusers/{email}

invitedDate

response

string

Date and time in UTC time that the invitation was sent to the User.
  • GET /v1/orgs/{orgId}/invitedusers
  • GET /v1/orgs/{orgId}/invitedusers/{email}

roleType

response

string

User role in TIBCO Scribe® which controls permissions. Roles include: 

  • Administrator — A TIBCO Scribe® Administrator has full access to TIBCO Scribe® functionality, including tasks such as creating and managing Organizations and Solutions, installing or provisioning Agents, and inviting other users to join Organizations.
  • User — Non-administrative users become members of an Organization by being invited to join by an Administrator. Users can perform many of the tasks that Administrators can, including creating and managing Solutions, and installing Agents. However, a TIBCO Scribe® User cannot make changes to the Organization or its members.
  • GET /v1/orgs/{orgId}/invitedusers
  • POST /v1/orgs/{orgId}/invitedusers
  • GET /v1/orgs/{orgId}/invitedusers/{email}
  • PUT /v1/orgs/{orgId}/invitedusers/{email}

statusType

response

string

Status of the invitation. Options include: 

  • Pending — Invitation has been sent but the User has not responded.
  • Declined — User has declined the invitation.
  • GET /v1/orgs/{orgId}/invitedusers
  • POST /v1/orgs/{orgId}/invitedusers
  • GET /v1/orgs/{orgId}/invitedusers/{email}
  • PUT /v1/orgs/{orgId}/invitedusers/{email}

 

See

Endpoints

API Basics