Token inline hook

This guide provides a working example of an Okta token inline hook. It uses the website Glitch.com (opens new window) to act as an external service to receive and respond to token inline hook calls.

---

Learning outcomes

• Understand the Okta token inline hook calls and responses.
• Implement a simple working example of a token inline hook with a Glitch.com external service.
• Test the token inline hook.

What you need

• Okta Developer Edition organization (opens new window)
• Glitch.com (opens new window) project or account
• A Node.js Express framework sample application. This guide works with the sample application in the Sample code section below.

Sample code

• Okta Token Inline Hook Example (opens new window)
• Express Sample Applications for Okta (opens new window)

---

About token inline hook implementation

The token inline hook can be used to customize the Authorization Code flow that occurs between an application and the Okta org used for authentication.

This guide provides example code for an external service to respond to calls from a token inline hook, and provides an end-to-end scenario using a local application, an Okta org, and the external service.

The Scenario

In the following token inline hook scenario, the external service code parses a request from Okta, evaluates the user name against a simple patient data store, and, if the user is a patient, responds to Okta with a command to add a patient ID claim to the token. If the user is not part of the data store, no action is taken. The token is returned to the local application for authentication.

At a high-level, the following workflow occurs:

• A user logs into an Okta-Hosted Login sample application.
• The Okta org authenticates the user and mints an authentication token.
• The Okta token inline hook triggers and sends a request to an external service.
• The external service evaluates the request, and if the user is a patient, adds a patient ID claim to the token.
• The authentication token is directed back to the Okta-Hosted Login application where the user is signed in.

Tip: For another in-depth look at a token inline hook implementation, see the following Developer Experience blog example by Micah Silverman, Use Okta Token Hooks to Supercharge OpenID Connect (opens new window).

Set up the sample Express application

The sample Node.js Express application is designed to demonstrate the Authorization Code flow, and includes an Okta-Hosted Login sample used in this token inline hook guide. Access the code from the following Github repository:

• Express Sample Applications for Okta (opens new window)

Follow the README.md (opens new window) instructions to install and run the Okta-Hosted Login sample application with your Okta org. Make sure to have this application running before proceeding with the token inline hook setup.

Parse the token inline hook request

The external service in this scenario requires code to handle the token inline hook request from the Okta org. Use the Okta Token Inline Hook (opens new window) Glitch example to either build or copy the code (re-mix on Glitch) that parses the token inline hook call.

Note: Make sure to have the required default code and packages in your project. See Common Hook Set-up Steps.

From the token inline hook request, the following code retrieves the value of the user name from the data.identity object.

The following code parses the Okta request body for the user name and stores it in the variable patientName.

app.post("/tokenHook", (request, response) => {
  console.log(" ");
  console.log(request.body.data.identity.claims["preferred_username"]);
  var patientName = request.body.data.identity.claims["preferred_username"];

  ...

}
)

Note: The method definition started in this code snippet is incomplete and is completed by the Send a response to Okta section.

Check against the data store

In this scenario, a pre-populated static array of patient names and patient IDs (patients) is used to simulate a real-world data store. The user name included with the Okta request is checked against this array. If the user name in the request matches a value in the patients array, the associated patient ID is stored as a variable, patientID.

Note: Modify this data store to make sure it contains one or more user names that are assigned to your application in your Okta org.

// Example Patients Data Store

const patients = [
  {
    username: 'michelle.test@example.com',
    ExternalServicePatientID: '1235',
  },
  {
    username: 'raj.gupta@example.com',
     ExternalServicePatientID: '6789',
  },
    {
    username: 'mark.christie2777@example.com',
     ExternalServicePatientID: '4235',
  },

  ]

app.post("/tokenHook", (request, response) => {

  console.log(" ");
  console.log(request.body.data.identity.claims["preferred_username"]);
  var patientName = request.body.data.identity.claims["preferred_username"];

  if (patients.some(user => user.username == patientName)){
    const arrayPosition = patients.findIndex(user => user.username == patientName);
    const patientID = patients[arrayPosition].ExternalServicePatientID;

    ...

  }
)

Note: The method definition started in this code snippet is incomplete and is completed by the Send a response to Okta section.

Send a response to Okta

The variable, patientID, can now be returned to Okta as an additional token claim using the commands object. For further information on the token commands object, see the token inline hook reference documentation.

//Token Inline Hook POST from Okta (endpoint: tokenHook)

app.post("/tokenHook", (request, response) => {
  console.log(" ");
  console.log(request.body.data.identity.claims["preferred_username"]);
  var patientName = request.body.data.identity.claims["preferred_username"];
  if (patients.some(user => user.username == patientName)){
    const arrayPosition = patients.findIndex(user => user.username == patientName);
    const patientID = patients[arrayPosition].ExternalServicePatientID;
    var returnValue = { "commands":[
                          { "type":"com.okta.identity.patch",
                            "value": [
                                {
                                  "op": "add",
                                  "path": "/claims/extPatientId",
                                  "value": patientID
                                }
                                ]

                          }
                                  ],
                    }
  console.log("Added claim to ID Token, with a value of: " + returnValue.commands[0].value[0]["value"]);
  response.send(JSON.stringify(returnValue));
  }
  else {
  console.log("Not part of patient data store");
  response.status(204).send();
  }
}
);

Activate and enable the token inline hook

The token inline hook must be activated and enabled within your Okta Admin Console.

• Activating the token inline hook registers the hook with the Okta org and associates it with your external service.
• Enabling the token inline hook associates the hook with your Okta custom authorization server, which authenticates the Okta-Hosted Login sample application.

Note: Okta's Developer Edition makes most key developer features available by default for testing purposes. Okta's API Access Management product — a requirement to use Custom Authorization Servers — is an optional add-on in production environments.

Activate the token inline hook

1. Navigate to the Workflow > Inline Hooks page.

2. Click Add Inline Hook and select Token from the drop-down menu.

3. Add a name for the hook (in this example, "Patient Token Hook").

4. Add your external service URL, including the endpoint. For example, use your Glitch project name with the endpoint: https://your-glitch-projectname.glitch.me/tokenHook.

5. Include Authentication field and Authentication secret values. In this example:

   • Authentication field = authorization
   • Authentication secret = Basic YWRtaW46c3VwZXJzZWNyZXQ=

6. Click Save.

The token inline hook is now set up with a status of active.

Enable the token inline hook

1. Navigate to Security > API > Authorization Servers.

2. Select a custom authorization server from the list (usually default).

3. Select the Access Policies tab. Navigate to the Rule table and click the Edit icon next to the policy rule that will use the Inline hook. In most cases, edit the Default Policy Rule of the Default Policy.

4. From the Use this inline hook drop-down menu, select the token inline hook you activated ("Patient Token Hook").

5. Click Update Rule.

The token inline hook is now ready for triggering when the default policy rule is invoked from an authentication request.

Extend the sample Express application

The following code extends the local sample Node.js Express application to display the results of the token inline hook claim addition. This step is optional. The token inline hook is functional and the results of the implementation are shown in the external service logs, as well as in the system logs on your Okta org. But this extension is nice to have!

To extend the local sample Node.js Express application, you need to update the sample-web-server.js file.

Update the web server page

1. Navigate to your project folder samples-nodejs-express-4 and continue to the common folder (samples-nodejs-express-4/common).
2. In an editor, open the sample-web-server.js page.
3. Locate the routing function app.get('/profile' and modify the function as in the code below. The Inline Token Hook code extension appears after the const declarations and before the res.render function.

This extension renders the ID token, and if it contains the claim added by the token inline hook, adds this claim to the attributes array. This array displays claims on the user's My Profile page.

    app.get('/profile', oidc.ensureAuthenticated(), (req, res) => {
    // Convert the userinfo object into an attribute array, for rendering with mustache
    const userinfo = req.userContext && req.userContext.userinfo;
    const attributes = Object.entries(userinfo);

    /*
    * Inline Token Hook Extension: If the ID Token contains the patient ID claim addition,
    * the patient ID is added to the attributes array and displayed on the user's profile page.
    */

    // Render the ID token payload from the request into an accessible JSON object
    // For more information on the ID token, see:
    // https://developer.okta.com/docs/reference/api/oidc/#id-token

    let payload = (req.userContext.tokens.id_token).split("."); //split payload segment from ID Token
    let bufferObj = Buffer.from(payload[1], "base64"); //decode payload from base64
    let decodedStringObj = JSON.parse(bufferObj.toString("utf8")); //return string to JSON object

    // If the additional claim is part of the payload, then add it to the attributes array
    if ('extPatientId' in decodedStringObj){
      patientId = decodedStringObj["extPatientId"]
      attributes.push(['extPatientId', patientId])
    }

    /*
    * End of the Inline Token Hook code extension.
    */

    res.render('profile', {
      isLoggedIn: !!userinfo,
      userinfo: userinfo,
      attributes
    });
  });

Preview and test the token inline hook

The token inline hook is ready for preview and testing. You now have the following applications configured:

• The Okta-Hosted-Login sample application (samples-nodejs-express-4) is ready to authenticate users from your Okta org.
• The external service (Glitch.com project) is ready with code to receive and respond to an Okta token inline hook call.
• The Okta org is set up to call the external service when a token inline hook is triggered by a user sign-in from the Okta-Hosted-Login sample application, and ready to receive a response.

Note: Make sure you have users assigned to your application and at least one user is part of the Patients data store in your Glitch application.

Preview the token inline hook

1. In the Admin Console, go to Workflow > Inline Hooks.

2. Click the token inline hook name (in this example, "Patient Token Hook").

3. Click Preview.

4. From the Configure Inline Hook request block, complete the following fields:

   • Select a user: A user in your org associated with your application
   • Select an application: Your OIDC sample application name
   • Select an authorization server: Your authorization server name. In this example, use default.
   • Select a grant type: Your application's grant type. In this example, use Authorization Code.
   • Select scopes: The granted scopes

   Note: Based on your grant type selection, preview fields may vary.

5. From the Preview example Inline Hook request block, click Generate Request. You should see the user's request information in JSON format that is sent to the external service.

   Note: You can also click Edit to modify this call for development or testing purposes.

6. From the View service's response block, click View Response. A response appears from your external service in JSON format, which either adds a claim to the token or doesn't based on your external service's logic.

Test your hook

1. Navigate to your sample application project folder (samples-nodejs-express-4).

2. Start your Okta-Hosted-Login server (npm run okta-hosted-login-server).

3. Navigate to your sample application (http://localhost:8080).

4. Navigate to your Glitch.com project and open the Console Logs window (Tools > Logs).

5. Return to your sample application and sign in with an Okta user who is NOT in the Patients' data store.

   • The user should sign in as normal; only the user name should appear in the Glitch log window.
   • If you extended the sample application, click My Profile in the left-hand navigation pane. Only the user info claims are included in the table.

6. Sign out of the sample application, and now sign in with an Okta user who is in the Patients' data store.

   • The user should sign in as normal; however, this user should have a patient ID displayed in the Glitch console output, as well as a successful implementation record of the token inline hook, available for review in your Okta org System Log (Reports > System Log).
   • If you extended the sample application, click My Profile in the left-hand navigation pane. The patient ID is added as part of the Claims table.

Note: Review the Token inline hooks troubleshooting content or the Troubleshooting hook implementations section for information on any difficulties.

Next steps

Review the following guides to implement other inline or event hook examples:

• Event hook
• Registration inline hook
• Password import inline hook

See also

For further reference data on the token inline hook, see the token inline hook reference.