Resource Owner Password Credentials Grant

Endpoints

/oauth2/access_token

The Resource Owner Password Credentials (ROPC) grant flow lets the client use the resource owner's user name and password to get an access token.

Since the resource owner shares their credentials with the client, this flow is deemed the most insecure of the OAuth 2.0 flows. The resource owner's credentials can potentially be leaked or abused by the client application, and the resource owner has no control over the authorization process.

You should implement the ROPC grant flow only if the resource owner has a trust relationship with the client (such as the device operating system, or a highly privileged application).

ROPC Grant Flow

OAuth 2.0 Resource Owner Password Credentials Grant Flow

The steps in the diagram are described below:

The resource owner provides the client with their username and password.
The client sends the resource owner's and its own credentials to the authorization server, which authenticates the credentials and authorizes the resource owner's request.
If the credentials are valid, the authorization server returns an access token to the client.
The client requests access to the protected resources presenting the access token to the resource server.
The resource server contacts the authorization server to validate the access token.
The authorization server validates the token and responds to the resource server.
If the token is valid, the resource server allows the client to access the protected resources.

Perform the following procedure to obtain an access token:

To Obtain an Access Token Using the ROPC Grant Flow

This procedure assumes the following configuration:

An authentication service - a chain or tree - that is able to authenticate a username and password combination, without requiring any UI-based interaction from the resource owner, is available.
For example, the ldapService chain (the default), or the Example tree.
Specify the chain or tree by using one or more of the methods below. AM checks for the configured value in the following order, using the first value found:
1. For a specific access token REST request.
  Set the auth_chain parameter.
2. Individually for a realm, overriding the realm-level setting below.
  Navigate to Realms > Realm Name > Services > OAuth2 Provider > Advanced, and set the Password Grant Authentication Service property.
3. Individually for a realm.
  Navigate to Realms > Realm Name > Authentication > Settings > Core, and set the Organization Authentication Configuration property.
4. Globally, for all realms.
  Navigate to Configure > Authentication > Core Attributes > Core, and set the Organization Authentication Configuration property.
For more information, see Configure Sensible Default Authentication Services.
AM is configured as an OAuth 2.0 authorization server. Ensure that:
- The token plugin is configured in the Response Type Plugins field.
- The Resource Owner Password Credentials grant type is configured in the Grant Types field.
For more information, see Authorization Server Configuration.
A confidential client called myClient is registered in AM with the following configuration:
- Client secret: forgerock
- Scopes: write
- Response Types: token
- Grant Types: Resource Owner Password Credentials

For more information, see Client Registration.

Perform the following steps to obtain an access token using the ROPC grant flow:

The resource owner provides their credentials to the client. This is done outside the scope of this procedure.
The client creates a POST request to the authorization server's token endpoint specifying, at least, the following parameters:
- username= your_resource_owner_username
- password= your_resource_owner_password
- grant_type=password
For information about the parameters supported by the /oauth2/access_token endpoint, see "/oauth2/access_token".
Confidential clients can authenticate to the OAuth 2.0 endpoints in several ways. This example uses the following form parameters:
- client_id=your_client_id
- client_secret=your_client_secret
For more information, see OAuth 2.0 Client Authentication.
If the OAuth 2.0 provider is configured for a subrealm rather than the Top Level Realm, you must specify it in the endpoint. For example, if the OAuth 2.0 provider is configured for the /customers realm, then use /oauth2/realms/root/realms/customers/access_token.
For example:
```
$ curl --request POST \
--data "grant_type=password" \
--data "username=demo" \
--data "password=Ch4ng31t" \
--data "scope=write" \
--data "client_id=myClient" \
--data "client_secret=forgerock" \
"https://openam.example.com:8443/openam/oauth2/realms/root/access_token"
```
Note that the scope parameter has been included. Scopes are not required, since they can be configured by default in the authorization server and the client, and have been added only as an example.
The authorization server returns an access token in the access_token property. For example:
```
{
  "access_token": "sbQZuveFumUDV5R1vVBl6QAGNB8",
  "scope": "write",
  "token_type": "Bearer",
  "expires_in": 3599
}
```
Tip
The authorization server can also issue refresh tokens at the same time the access tokens are issued. For more information, see Refresh Tokens.

Resource Owner Password Credentials Grant

Tip