OAuth 2.0 grant flows
This section describes the OAuth 2.0 flows that AM supports, and also provides the information required to implement them. All the examples assume the realm is configured for server-side tokens; however, the examples also apply to client-side tokens.
You should decide which flow is best for your environment based on the application that will be the OAuth 2.0 client. The following table provides an overview of the flows AM supports and when they should be used:
| Client Type | Which Grant to use? | Description |
|---|---|---|
The client is a web application running on a server.
For example, a |
(RFC 6749) The authorization server uses the user-agent, for example, the resource owner’s browser, to transport a code that is later exchanged for an access token. |
|
The client is a native application or a single-page application (SPA). For example, a desktop, a mobile application, or a JavaScript application. |
(RFC 6749, RFC 7636) The authorization server uses the user-agent, for example, the resource owner’s browser, to transport a code that is later exchanged for an access token. Since the client does not communicate securely with the authorization server, the code may be intercepted by malicious users. The implementation of the Proof Key for Code Exchange (PKCE) standard mitigates against those attacks. |
|
The client is a web application, a native application, or a SPA, that needs to make complex and highly secure authorization requests. |
(RFC 9126) Clients can push the payload of an authorization request directly to the authorization server without exposing sensitive request data to the browser. The server provides them with a request URI that is used to secure a subsequent authorization request. |
|
The client is a SPA. For example, a JavaScript application. |
(RFC 6749) The authorization server gives the access token to the user-agent so it can forward the token to the client. Therefore, the access token might be exposed to the user and other applications. For security purposes, you should use the authorization code grant with PKCE when possible. |
|
The client is trusted with the resource owner credentials. For example, the resource owner’s operating system. |
(RFC 6749) The resource owner provides their credentials to the client, which uses them to obtain an access token from the authorization server. This flow should only be used if other flows are not available. |
|
The client is the resource owner, or the client does not act on behalf of the resource owner. |
(RFC 6749) Similar to the Resource Owner Password Credentials grant type, but the resource owner is not part of the flow and the client accesses information relevant to itself. |
|
The client is an input-constrained device. For example, a TV set. |
(RFC 8628) The resource owner authorizes the client to access protected resources on their behalf by using a different user-agent and entering a code displayed on the client device. |
|
The client is an input-constrained device that can generate a PKCE challenge. |
(AM-only, based on RFC 8628 and RFC 7636) The resource owner authorizes the client to access protected resources on their behalf by using a different user-agent and entering a code displayed on the client device. Since the client does not communicate securely with the authorization server, the code may be intercepted by malicious users. The implementation of the Proof Key for Code Exchange (PKCE) standard mitigates against those attacks. |
|
The client has a SAML v2.0 trust relationship with the resource owner. For example, an application in an environment where a SAML v2.0 ecosystem coexists with an OAuth 2.0 one. |
(RFC 7522) The client uses the resource owner’s SAML v2.0 assertion to obtain an access token from the authorization server without interacting with the resource owner again. |
|
The client has a trust relationship with the resource owner that is specified as a JWT. For example, an application in an environment where a non-SAML v2.0 identity ecosystem coexists with an OAuth 2.0 one. |
(RFC 7523) The client uses a signed JWT to obtain an access token from the authorization server without interacting with the resource owner. |
ForgeRock provides a Postman collection to try out the flows. See ForgeRock grant flows collection.
|
AM supports associating a confirmation key or a certificate with an access token to support proof-of-possession interactions. For more information, see Certificate-bound proof-of-possession and JWK-based proof-of-possession. |