getSignonToken

Overview

This method generates a signon token for a specified user, to enable single signon into Catch-e for that user.

This method requires the SignonToken:Create permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'SignonToken:Create'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/gb/signon https://api.{{environment}}.catch-e.com/gb/signon https://api.test.catch-e.com/gb/signon

Input Fields (Header)

Key	Format	Notes	Mandatory
Authorization	string	`Bearer [ACCESS-TOKEN]`	Yes
Content-Type	string	`application/json`	Yes

Input Fields (JSON)

Key	Format	Notes	Mandatory
user_login	string	The login of the user to generate the signon token for.	Yes
token_timeout	integer	Token timeout in seconds, from 0 to 28800 (8 hours). If specified, the signon token expires after this number of seconds.	No
single_signon_role_flag	string	`yes` or `no`. Default `no`. If `yes`, the user login must be linked to a role that has its single_signon_flag set to 'yes'.	No
screen_width	integer	Screen width in pixels.	No
screen_height	integer	Screen height in pixels.	No
create_gb_user_with_this_role	string	`driver` or `package_employee`. If specified, a `gb_users` record is generated for that role. The entity association is inferred from the user_login value.	No

Example

{ "user_login": "jane.driver@example.com", "token_timeout": 300, "single_signon_role_flag": "yes" }

Response Details

Success

200 - OK

Key	Format	Notes
signon_token	string	The single signon token for the user.
expires_in	integer	Token expiry time in seconds.

{ "signon_token": "[SIGNON-TOKEN]", "expires_in": 300 }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	The requested record could not be found.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }