PingFederate Server

Defining the token endpoint management contract

On the Token Endpoint Attribute Contract tab, PingFederate allows you to define which attributes it returns in the Token Endpoint response, based on the scopes that are included in the request.

Steps

  1. Go to Applications > OAuth > Access Token Management and select your instance or click Create New Instance.

  2. On the Token Endpoint Attribute Contract tab:

    1. In the Extend the Contract field, enter an attribute name.

    2. Click Add to add the attribute to the contract.

  3. (Optional) For each added attribute, select Multi-Valued if you always want to return the attribute as an array.

  4. (Optional) For each added attribute, click the link under Mapped Scopes to select scopes that will trigger this attribute to appear in the Token Endpoint response.

    If you don’t select a scope, this attribute is always returned in the response.

    1. In the Scopes Selection modal, add scopes from the Available Scopes column to the Selected Scopes column by dragging the scopes or clicking the Add icon.

    2. Click Done.

  5. After you add all attributes, click Save.

Next steps

For attributes to return properly in a Token Endpoint response, they must be mapped. Learn more in Configuring access token mapping.