Modifying the Content of Access Tokens

In this procedure, add an email address and telephone number value to the demo user's profile. The access token modification script injects the values provided into the OAuth 2.0 access token before it is issued to the resource owner.

1. Log in as an AM administrator. For example amAdmin.

2. Select Realms > Top Level Realm > Identities.

3. On the Identities tab, select the demo user.

   1. In Email Address, enter a valid address. For example:

      demo.user@example.com

   2. In Telephone Number, enter a value. For example:

      +44 117 496 0228

4. Select Save Changes.

In this procedure, uncomment functionality in the default access token modification script in order to demonstrate how to modify access tokens.

1. Log in as an AM administrator. For example amAdmin.

2. Navigate to Realms > Top Level Realm > Scripts, and then click OAuth2 Access Token Modification Script.

3. In the Script field:

   1. Uncomment line 34 of the script, by surrounding the line with a pair of */ and /* strings:

      */
      accessToken.setField("hello", "world")
      /*

   2. Uncomment lines 59 to 61 of the script, by surrounding them with a pair of */ and /* strings:

      */
      def attributes = identity.getAttributes(["mail", "telephoneNumber"].toSet())
      accessToken.setField("mail", attributes["mail"])
      accessToken.setField("phone", attributes["telephoneNumber"])
      /*

4. Select Save Changes.

In this procedure, create an OAuth 2.0 provider that uses the default access token modification script, as well as an OAuth 2.0 client. Obtaining an access token as the demo user can then be performed to test the script functionality.

1. Log in as an AM administrator. For example amAdmin.

2. Create an OAuth 2.0 provider by performing the following steps:

   1. Navigate to Realms > Top Level Realm > Configure OAuth Provider, and then click Configure OAuth 2.0.

   2. Keep the suggested settings, click Create, and then click OK.

      The default setting for a new OAuth 2.0 provider is to use the default access token modification script.

      For information on OAuth 2.0 provider properties, see "OAuth2 Provider".

3. Create an OAuth 2.0 client by performing the following steps:

   1. Navigate to Realms > Top Level Realm > Applications > OAuth 2.0 > Clients, and then click Add Client.

   2. Enter the following values:

      • Client ID: myClient

      • Client secret: forgerock

      • Redirection URIs: https://www.example.com:443/callback

      • Scope(s): access|Access to your data

   3. Click Create.

      AM is now configured to issue access tokens using the default access token modification script.

1. In a web browser, navigate to the /oauth2/authorize endpoint, including the parameters and values configured for the OAuth 2.0 client in the previous section.

   For example:

   https://openam.example.com:8443/openam/oauth2/realms/root/authorize?client_id=myClient&response_type=code&scope=access&state=abc123&redirect_uri=https://www.example.com:443/callback

   The AM sign in page is displayed.

2. Log in as the demo user, with password Ch4ng31t.

   The AM OAuth 2.0 consent page is displayed.

3. Review the scopes being requested, and then click Allow.

   AM redirects the browser to the location specified in the redirect_uri parameter, https://www.example.com:443/callback in this example, and appends a number of query parameters. For example:

   

4. Record the value of the code query parameter.

   This is the authorization code and is exchanged for an access token in the next procedure.

1. Create a POST request to the /oauth2/access_token endpoint, including the authorization code obtained in the previous procedure, and the parameters and values configured for the OAuth 2.0 client earlier.

   For example:

   $ curl --request POST \
     --data "grant_type=authorization_code" \
     --data "code=tH_s2obVRt2_yB6x4OxH1J3eMkU" \
     --data "client_id=myClient" \
     --data "client_secret=forgerock" \
     --data "redirect_uri=https://www.example.com:443/callback" \
     "https://openam.example.com:8443/openam/oauth2/realms/root/realms/alpha/access_token"
   {
     "access_token": "sbQZuveFumUDV5R1vVBl6QAGNB8",
     "scope": "access",
     "token_type": "Bearer",
     "expires_in": 3599
   }

2. Record the value of the access_token property.

   This is the access token, the properties of which have been modified by the access token modification script. Follow the steps in the next procedure to introspect the token to verify the properties have been modified.

• Create a POST request to the /oauth2/introspect endpoint, including the access token obtained in the previous procedure, and the credentials of the OAuth 2.0 client earlier.

  For example:

  $ curl \
    --request POST \
    --data "client_id=myClient" \
    --data "client_secret=forgerock" \
    --data "token=sbQZuveFumUDV5R1vVBl6QAGNB8" \
    "https://openam.example.com:8443/openam/oauth2/realms/root/realms/alpha/introspect"
  {
    "active": true,
    "scope": "access",
    "client_id": "myClient",
    "user_id": "demo",
    "token_type": "Bearer",
    "exp": 1556289970,
    "sub": "(usr!demo)",
    "subname": "demo",
    "iss": "https://openam.example.com:8443/openam/oauth2",
    "auth_level": 0,
    "auditTrackingId": "c6e22be7-6166-402b-9d72-a03134f08c22-8605",
    "hello": "world",
    "mail": [
      "demo.user@example.com"
    ],
    "phone": [
      "+44 117 496 0228"
    ]
  }

  Notice that the output includes a hello:world key-value pair, as well as mail and phone properties, containing values taken from the user's profile data.