Use the GET /oauth/tokenExchange/generator/groups/{{groupId}} endpoint to retrieve an OAuth 2.0 Token Exchange Generator group with the specified ID. A 404 status code is returned for nonexistent IDs.

Path parameters

Parameter Value Description
groupId string(required) ID of the OAuth 2.0 Token Exchange Generator group to fetch.

Status codes

Code Reason
200 Success.
403 PingFederate does not have the IdP, SP and OAuth roles enabled. Operation not available.
404 Resource not found.

TokenExchangeGeneratorGroup - The set of attributes used to configure a OAuth 2.0 Token Exchange Generator group.

Property Type Description
generatorMappings * array[TokenExchangeGeneratorMapping] A list of Token Generator mapping into an OAuth 2.0 Token Exchange requested token type.
id * string The Token Exchange Generator group ID. ID is unique.
name * string The Token Exchange Generator group name. Name is unique.
resourceUris array[string] The list of resource URI’s which map to this Token Exchange Generator group.

TokenExchangeGeneratorMapping - A Token Generator mapping into an OAuth 2.0 Token Exchange requested token type.

Property Type Description
defaultMapping boolean Whether this is the default Token Generator Mapping. Defaults to false if not specified.
requestedTokenType * string The Requested token type
tokenGenerator * ResourceLink The Token Generator used to generate the requested token

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.