Users

Users can only be added to TIBCO Scribe® by inviting them to an Organization. See InvitedUsers for information on those endpoints. Use the Users endpoints to view and manage Users that have accepted an invitation to the Organization, to retrieve your User information, or to view and modify email notification settings for a User. See Managing Users in the TIBCO Scribe® Help.

To modify or delete an existing User, use one of the Organizations endpoints. See Organizations for additional information.

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 Users 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.

TIBCO Cloud™ Integration - Connect User Notes

Some API calls apply only to TIBCO Scribe® Online Classic Organizations. Using any of the following calls for a TIBCO Cloud™ Integration - Connect Organization is not supported.

PUT /v1/users
PUT /v1/users/invitations/{inviteId}

Refer to the following documentation for TIBCO Cloud™ API information:

Endpoints

/v1/users

Return your User information

/v1/users )

Modify your User information

/v1/users/{userId}/alertsettings

Return a list of email notification settings

/v1/users/{userId}/alertsettings

Modify email notification settings

/v1/users/invitations

Return a list of Invitations

/v1/users/invitations/{inviteId}

Modify Invitation status

Fields For Users Endpoints

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

Name Type Data Type	Description	Endpoints
Parameters
accept query boolean	Accept or decline the selected invitation. true — Accept false — Decline	PUT /v1/users/invitations/{inviteId}
email path string	Email address of the invited User. Required If the User has accepted the invitation, the invitation record no longer exists and no records are returned. NOTE: You can only retrieve your own invitations.	GET /v1/users/invitations
inviteId path string	ID of the invitation. Required If the User has accepted the invitation, the invitation record no longer exists and no records are returned.	PUT /v1/users/invitations/{inviteId}
limit query integer	Maximum number of Users to return. Default value is 100. See Reading Resources for more information on offset and limit parameters.	GET /v1/users/{userId}/alertsettings
model body model	Model to update a User notification record. Required	PUT /v1/users/{userId}/alertsettings
offset query integer	Number of Users to skip before returning results. Default value is 0. See Reading Resources for more information on offset and limit parameters.	GET /v1/users/{userId}/alertsettings
userId path string	ID of the User. Required	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
userModel body model	Model to update your User record. Required	PUT /v1/users
Response
company response string	Name of the Company for this User.	GET /v1/users PUT /v1/users
connectorActivationEmail response boolean	Indicates whether or not to send email notifications when a Connector is installed or uninstalled. true — Notification is enabled. false — Notification is disabled.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
country response string	User's Country address field.	GET /v1/users PUT /v1/users
email response string	User's email address. Email address serves as an ID and must be unique for each User. Required when modifying User information.	GET /v1/users PUT /v1/users
eventFailedJobEmail response boolean	Indicates whether or not to send email notifications when an Integration Services Event Solution fails. This email notification is not generated if Record or Run failure messages are enabled, because a message is generated by those options.. true — Notification is enabled. false — Notification is disabled.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
failedJobEmail response boolean	Indicates whether or not to send email notifications when a Solution execution fails. true — Notification is enabled. false — Notification is disabled.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
failedRowsEmail response boolean	Indicates whether or not to send email notifications when one or more records fail during a Solution execution. true — Notification is enabled. false — Notification is disabled.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
firstName response string	User's first name. Required when modifying User information.	GET /v1/users PUT /v1/users
heartbeatEmail response boolean	Indicates whether or not to send email notifications for Agent Heartbeat Failure. true — Notification is enabled. false — Notification is disabled.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
httpReferrer response string	URL associated with this User. It could be their Company web site or a URL for the account registration page. A user could request an account by filling out this form.	GET /v1/users PUT /v1/users
id response string	User's system ID. GUID / UUID of an invitation.	GET /v1/users PUT /v1/users GET /v1/users/invitations
invitationDate response string	Date and time in UTC time that the invitation was sent to the invited User.	GET /v1/users/invitations
isApproved response boolean	Indicates whether or not the User's email address has been validated. Users cannot be given an account if their email address is invalid. true — Email address has been validated and approved. false — Email address has not been validated.	GET /v1/users PUT /v1/users
jobTitle response string	User's title.	GET /v1/users PUT /v1/users
lastName response string	User's last name. Required when modifying User information.	GET /v1/users PUT /v1/users
leadSource response string	How the User heard about TIBCO Scribe®, such as Direct Trial, indicating that the user requested a Trial Subscription.	GET /v1/users PUT /v1/users
message response string	Message sent to the invited User in an invitation.	GET /v1/users/invitations
omittedFields response string	Returns a list of fields that were omitted in the user model sent to the API.	PUT /v1/users
orgId response integer	ID of the Organization to which the User has been invited.	GET /v1/users/invitations
orgName response string	Name of the Organization. Required when modifying email notification settings.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings GET /v1/users/invitations
password response string	Password field for the User. Returns null when included in a response.	GET /v1/users PUT /v1/users
phone response string	User's telephone number.	GET /v1/users PUT /v1/users
postalCode response string	User's Postal or Zip code address field.	GET /v1/users PUT /v1/users
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/users/invitations
sender response string	Email address of the User who sent the invitation.	GET /v1/users/invitations
state response string	User's State address field.	GET /v1/users PUT /v1/users
status 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/users/invitations
systemUpdateEmail response boolean	Indicates whether or not to send email notifications when the TIBCO Scribe® software is updated. true — Notification is enabled. false — Notification is disabled. Note: This option is no longer used.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
tenantId response string	GUID / UUID of the Organization. Required when modifying email notification settings.	GET /v1/users/{userId}/alertsettings PUT /v1/users/{userId}/alertsettings
underPostDefaults response string	For internal use only. Not required.	PUT /v1/users

See

Endpoints

API Basics