{https://yourApp/callback}
.Parameter Name | Description |
---|---|
response_type | Denotes the kind of credential that Auth0 will return (code or token). For the Implicit Flow, the value can be id_token , token , or id_token token . Specifically, id_token returns an ID Token, and token returns an Access Token. |
response_mode | Specifies the method with which response parameters should be returned. For security purposes, the value should be form_post . In this mode, response parameters will be encoded as HTML form values that are transmitted via the HTTP POST method and encoded in the body using the application/x-www-form-urlencoded format. |
client_id | Your application’s Client ID. You can find this value at your Application’s Settings. |
redirect_uri | The URL to which Auth0 will redirect the browser after authorization has been granted by the user. You must specify this URL as a valid callback URL in your Application Settings. Warning: Per the OAuth 2.0 Specification, Auth0 removes everything after the hash and does not honor any fragments. |
scope | Specifies the scopes for which you want to request authorization, which dictate which claims (or user attributes) you want returned. These must be separated by a space. You can request any of the standard OpenID Connect (OIDC) scopes about users, such as profile and email , custom claims conforming to a namespaced format, or any scopes supported by the target API (for example, read:contacts ). |
state | (recommended) An opaque arbitrary alphanumeric string that your app adds to the initial request and Auth0 includes when redirecting back to your application. To see how to use this value to prevent cross-site request forgery (CSRF) attacks, see Mitigate CSRF Attacks With State Parameters. |
nonce | (required for response_type containing id_token token , otherwise recommended) A cryptographically random string that your app adds to the initial request and Auth0 includes inside the ID Token, used to prevent token replay attacks. |
connection | (optional) Forces the user to sign in with a specific connection. For example, you can pass a value of github to send the user directly to GitHub to log in with their GitHub account. When not specified, the user sees the Auth0 Lock screen with all configured connections. You can see a list of your configured connections on the Connections tab of your application. |
organization | (optional) ID of the organization to use when authenticating a user. When not provided, if your application is configured to Display Organization Prompt, the user will be able to enter the organization name when authenticating. |
invitation | (optional) Ticket ID of the organization invitation. When inviting a member to an Organization, your application should handle invitation acceptance by forwarding the invitation and organization key-value pairs when the user accepts the invitation. |
HTTP 302
response. The requested credentials are encoded in the body:
response_type
.
Response Type | Components |
---|---|
id_token | ID Token |
token | Access Token (plus expires_in and token_type values) |
id_token token | ID Token, Access Token (plus expires_in and token_type values) |
connection
parameter and set its value to the connection name (in this case, github
) when authorizing the user:
sub
claim with the user’s unique ID returned from GitHub. When you decode the ID Token, it will look similar to: