Home >
API >
2 >
API Authorization >
List Access Token Claims

List Access Token Claims

List all of the custom claims that get returned in Access Tokens generated by the Authorization Server.

Resource URL

https://<subdomain>/api/2/api_authorizations/:id/claims

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Resource Parameters

required

integer

The id of the authorization server.

Sample Responses

200 OK
401 Unauthorized
404 Not Found

[
  {
      "attributes_transformations": null,
      "skip_if_blank": null,
      "user_attribute_mappings": "email",
      "provisioned_entitlements": null,
      "default_values": null,
      "safe_entitlements_enabled": null,
      "label": "email_address",
      "name": "email_address",
      "user_attribute_macros": null,
      "values": null,
      "id": 320780
  }
  ...
]

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

Invalid API Authorization Server ID

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

Response Elements

`id`	The unique ID of the claim.	Integer
`label`	The UI label for the claims.	String
`user_attribute_mappings`	A user attribute to map values from.	String
`user_attribute_macros`	When `user_attribute_mappings` is set to `_macro_` this macro will be used to assign the claims value.	String
`attributes_transformations`	The type of transformation to perform on multi valued attributes.	String
`skip_if_blank`	Not used.	Boolean
`values`	Relates to Rules/Entitlements. Not supported yet.	Array
`default_values`	Relates to Rules/Entitlements. Not supported yet.	String
`provisioned_entitlements`	Relates to Rules/Entitlements. Not supported yet.	Boolean

Postman Collection

Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

List Access Token Claims

curl 'https://<subdomain>/api/2/api_authorizations/:id/claims' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.