PingOne Advanced Identity Cloud

Customize dynamic client registration

You can configure Advanced Identity Cloud to run a script after it has processed a dynamic client registration request. This scripted extension point lets you perform custom actions to modify the client profile, for example, by updating client attributes or manipulating user profile data to create client relationships.

Advanced Identity Cloud calls the script after the following dynamic client registration operations:

Create a script

Advanced Identity Cloud includes a sample script that updates client attributes with values from the request.

You can use this as a template to create your own custom script.

  1. Create a script with the Script Type set to OAuth2 Dynamic Client Registration.

  2. Write your own or copy the sample script into the Script field.

    A dynamic client registration script is a next-generation script. You have access to all common next-generation bindings such as openidm, httpClient, and utils, to help you modify the client profile.

    Learn about the bindings you can use in the Dynamic client registration scripting API.

  3. Save your changes.

Configure OAuth 2.0 provider to use the script

After creating your script, you must configure Advanced Identity Cloud to use it.

  1. Under Native Consoles > Access Management, go to Realms > Realm Name > Services > OAuth2 Provider > Client Dynamic Registration to configure a specific OAuth 2.0 provider.

  2. Set Dynamic Client Registration Script to the name of the script you want to use.

  3. Save your changes.

Test your changes

  1. Perform a request to dynamically register, update, or delete a client profile.

  2. The provider runs the script after the operation completes successfully.

    The script isn’t invoked if the operation fails.

  3. Verify that the script makes the changes as expected.

    For the sample script, check for the following modifications depending on the type of request:

    CREATE operation

    The script sets the client attribute com.forgerock.openam.oauth2provider.grantTypes to authorization_code and the grant type for the request.

    UPDATE operation

    The script adds the software statement’s redirect_uris property to the client attribute com.forgerock.openam.oauth2provider.redirectionURIs.

    DELETE operation

    The script makes no changes.

    The property names used to update client attributes such as com.forgerock.openam.oauth2provider.grantTypes, don’t map to the property names found by querying the /realm-config/agents/OAuth2Client endpoint.