Additional Authorization Parameters
Additional parameters can be sent to the the /oauth/authorize URL to further streamline the login process.
Specify Login Provider
If the organization name and authentication provider are known ahead of time, you can supply that information as query string parameters so the user will automatically be directed to that authentication provider.
Parameter | Description |
| The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified. |
| Authentication provider to log in with. Valid values are "okta", "adfs", "salesforce", "onelogin", "gsuite", or "ping". |
Force Prompt the User for Credentials
Use the prompt=login parameter to require that the user be prompted to enter credentials at the Gensys Cloud login screen and ignore any remembered sessions (auth cookies).
Parameter | Value | Description |
|
| Specify this parameter and value to always prompt the user to enter credentials. |
Specify Target Organization
When intending to log in to a specific target organization using Authorized Organizations, providing this value will skip the org selection screen after authentication and will automatically complete the log in process for the specified target org.
Parameter | Description |
| The organization ID of the target organization |
The State Parameter
The state parameter allows an application to pass a value to the authorization server that will be returned when the authorization process has been completed. This allows the requesting application to associate the redirect for authorization with the response from the authorization server.
Parameter | Description |
state | An arbitrary URL encoded value |
Examples
The following example illustrates a query string utilizing all parameters listed above. The < > brackets indicate values provided by the application. Do not include the bracket characters in the query string.
https://login.mypurecloud.com/oauth/authorize
?client_id=<my-client-id>
&response_type=code
&redirect_uri=<http://example.com/oauth/callback>
&org=<orgname>
&provider=<providername>
&target=<orgid>
&state=<uri%20encoded%20value>
&prompt=login