To begin the flow, you'll need to get the user's authorization. This step may include one or more of the following processes:
- Authenticating the user;
- Redirecting the user to an Identity Provider to handle authentication;
- Checking for active SSO sessions;
- Obtaining user consent for the requested permission level, unless consent has been previously given.
To authorize the user, your app must send the user to the authorization URL.
https://YOUR_DOMAIN/authorize? response_type=YOUR_RESPONSE_TYPE& client_id=YOUR_CLIENT_ID& redirect_uri=https://YOUR_APP/callback& state=STATE& nonce=NONCE
||Denotes the kind of credential that Auth0 will return (code or token). For the Implicit Flow, the value can be
||Your application's Client ID. You can find this value at your Application's Settings.|
||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.
||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 OIDC scopes about users, such as
||(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.|
||(optional) Forces the user to sign in with a specific connection. For example, you can pass a value of
As an example, your HTML snippet for your authorization URL when adding login to your app might look like:
<a href="https://YOUR_DOMAIN/authorize? response_type=id_token token& client_id=YOUR_CLIENT_ID& redirect_uri=https://YOUR_APP/callback& scope=read:tests& state=xyzABC123& nonce=eq...hPmz"> Sign In </a>
If all goes well, you'll receive an
HTTP 302 response. The requested credentials are included in a hash fragment at the end of the URL:
HTTP/1.1 302 Found Location: https://YOUR_APP/callback#access_token=ey...MhPw&expires_in=7200&token_type=Bearer&id_token=ey...Fyqk&state=xyzABC123
Note that the returned values depend on what you requested as a
|token||Access Token (plus
|id_token token||ID Token, Access Token (plus
Auth0 will also return any state value you included in your call to the authorization URL.