Authenticate
The
authenticate
operation is used to fetch an authentication token from the application. The token has to be sent back as a header in all other operations.
Authenticate Request
This message is sent by the client application to the TIBCO Product and Service Inventory system. The authenticate request has the following payload:
Element | Type | Cardinality | Description |
---|---|---|---|
username | String | Mandatory | The user name has to be in the format of ABC@XYZ where ABC is the user id and XYZ is the tenant. |
password | String | Mandatory | This is the password for the user. |
Authenticate Response
This message is sent by the TIBCO Product and Service Inventory system to the requesting application to return the results of the operation invocation. The authenticate response has the following payload:
Element | Type | Cardinality | Description |
---|---|---|---|
token | String | Mandatory | The token is a string value which has to be returned as a header for all the other operations. |
active | Boolean | Mandatory | This indicates if the user has been disabled. |
roles | RolesType | Mandatory | This is the list of the roles attached to the user. |