{ "opencollection": "1.0.0", "info": { "name": "Auth0 Authentication actions Authorize User API", "version": "1.0.0" }, "items": [ { "info": { "name": "Authorize User", "type": "folder" }, "items": [ { "info": { "name": "Auth0 Authenticate a User with a Social Provider, Database/AD/LDAP (Passive), SAML/Windows Azure AD (Passive), Authorization Code Flow, Authorization Code Grant (PKCE) Flow, or Implicit Flow", "type": "http" }, "http": { "method": "GET", "url": "{auth0_domain}/authorize", "params": [ { "name": "audience", "value": "", "type": "query", "description": "The unique identifier of the target API you want to access" }, { "name": "scope", "value": "", "type": "query", "description": "The scopes which you want to request authorization for. 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 that must conform to a namespaced format, or any scopes supported by the target API (for example, read:contacts). Include offline_access to get a Refresh Token." }, { "name": "response_type", "value": "", "type": "query", "description": "Indicates to Auth0 which OAuth 2.0 flow you want to perform. Use code for Authorization Code Grant Flow, token for Implicit Flow, or id_token token for both an ID Token and an Access Token." }, { "name": "client_id", "value": "", "type": "query", "description": "Your application's ID." }, { "name": "redirect_uri", "value": "", "type": "query", "description": "The URL to which Auth0 will redirect the browser after authorization has been granted by the user." }, { "name": "state", "value": "", "type": "query", "description": "An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks." }, { "name": "nonce", "value": "", "type": "query", "description": "A string value which will be included in the ID Token response from Auth0, used to prevent token replay attacks. It is required for response_type=id_token token." }, { "name": "code_challenge_method", "value": "", "type": "query", "description": "Method used to generate the challenge. The PKCE spec defines two methods, S256 and plain, however, Auth0 supports only S256 since the latter is discouraged." }, { "name": "code_challenge", "value": "", "type": "query", "description": "Generated challenge from the code_verifier." }, { "name": "connection", "value": "", "type": "query", "description": "The name of the connection configured to your application." }, { "name": "prompt", "value": "", "type": "query", "description": "To initiate a silent authentication request, use prompt=none." }, { "name": "organization", "value": "", "type": "query", "description": "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." }, { "name": "invitation", "value": "", "type": "query", "description": "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." } ] }, "docs": "Use this endpoint to authenticate a user. The following flows are supported:\n - Social Provider Authentication\n - Database/AD/LDAP (Passive) Authentication\n - SAML/Windows Azure AD (Passive) Authentication\n - Authorization Code Flow\n - Authorization Code Grant (PKCE) Flow\n - Implicit Flow\n" } ] } ], "bundled": true }