Provides methods to allow users the ability to single sign on to the DirectScale web sites.
Given an external SSO token this method will validate the token and return the summary customer information.<br/><br/>
The DirectScale back office navigation features can generate an encrypted token, which can be added to a navigation link within the back office application. When the user clicks on the link the target web site can then validate this token using this method. The links/tokens are always generated within the specific security scope of the individual customer that is logged into the back office.<br/>
<br/>
On success, the method returns the summary customer information that indicates that the token belongs to the individual that triggered the link.<br/>
<br/>
<b>Note:</b> These tokens have a small Time To Live (TTL), 1 minutes by default. Once the token has expired this method will consider the token invalid and return the appropriate status back to the caller. Calling applications should not cache or persist these tokens.<br/>
<br/>
You can get the **Request Parameters** at these calls:
**token**
- DirectScale provides documentation [here](https://help.directscale.com/hc/en-us/articles/360038403693-Inbound-and-Outbound-Single-Sign-On-SSO-) on getting tokens. Go to the section labeled "Linking From DirectScale to an External Application (Outbound SSO)". It is about halfway down the page.
This comes back when the token is not expired, and relates to a valid user in the system.
{
"CustomerId": "45678",
"ExternalReferenceId": "ABC123",
"DisplayName": "John Doe",
"Username": "jonedoe45",
"EmailAddress": "someone@directscale.com",
"BackOfficeId": "15F92"
}
Get an SSO URL for a specific customer.<br/><br/>
This method will return a fully qualified URL that will allow an external application to redirect the browser to the DirectScale back office application. By using this URL the customer will automatically be logged in and placed on the proper view.<br/><br/>
<b>Note:</b> These URLs have a small Time To Live (TTL), just a few minutes by default. Once the URL has expired the customers will be required to login using their username and password. Calling applications should not cache or persist these URLs.<br/><br/>
<b>WARNING:</b> It is up to the caller to verify the identity of the customer. The DirectScale back office has no additional process to validate the identify of the customer.<br/><br/>
You can get the **Request Parameter** at these calls:
**customerId**
- Get Customer IDs
- Get Customer IDs by Filter
This is the commission system-assigned ID.
Named destination - the API team will need to create a URL target in DirectScale configuration to use this
When a destination page/view needs extra data, it can be provided with this parameter. The format of this value is a query string (IE Name=Joe&Age=24). Because this service method uses a GET, make sure you pass this parameter's value URL encoded.
Returns a URL that contains the SSO login token. This can be used to log into the DS back office directly, in the corresponding environment (Dev, Stage, Production)
Get an SSO URL for a specific customer using the external reference id.<br/><br/>
This method will return a fully qualified URL that will allow an external application to redirect the browser to the DirectScale back office application. By using this URL the customer will automatically be logged in and placed on the proper view.<br/><br/>
<b>Note:</b> These URLs have a small Time To Live (TTL), just a few minutes by default. Once the URL has expired the customers will be required to login using their username and password. Calling applications should not cache or persist these URLs.<br/><br/>
<b>WARNING:</b> It is up to the caller to verify the identity of the customer. The DirectScale back office has no additional process to validate the identify of the customer.<br/><br/>
You can get the **Request Parameters** at these calls:
**externalId**
- Get Customer
- Get Customer by Parameter
Named destination - the API team will need to create a URL target in DirectScale configuration to use this
When a destination page/view needs extra data, it can be provided with this parameter. The format of this value is a query string (IE Name=Joe&Age=24). Because this service method uses a GET, make sure you pass this parameter's value URL encoded.
Customer-specific ID
Given an admin site SSO token this method will validate the token and return the admin user.<br/><br/>
When creating an external admin page in the DirectScale admin site, you can use the ``?token={DirectScale:Token}`` tag in the URL. When an admin user clicks to navigate to the external page, that tag will be replaced by a short-lived encrypted token. That token can be passed to this endpoint to verify it and retrieve the details for that admin user.
You can get the **Request Parameters** at these calls:
**token**
- DirectScale provides documentation [here](https://help.directscale.com/hc/en-us/articles/360038402713-6-Managing-External-Pages) on getting tokens for admin users.
This comes back when the token is not expired, and relates to a valid user in the system.
{
"CustomerId": "45678",
"ExternalReferenceId": "ABC123",
"DisplayName": "John Doe",
"Username": "jonedoe45",
"EmailAddress": "someone@directscale.com"
}