Retrieve a claim mapping

  • Updated on Jun 30, 2025
  • Published on Aug 17, 2023
  • 1 minute(s) read
Prev Next
Get
/v1alpha/sso/claim_mappings/{id}

Returns the details of an existing claim mapping by ID.

Security
HTTP
Type bearer
Path parameters
id
string (uuid) Required

ID

The ID of the claim mapping to retrieve.

Responses
200

A successful response.

object
id
string (uuid)

The unique identifier of the claim mapping.

Exampleb7a6c3f0-5d6a-4b3b-8f9a-103c4d5e6f7a
claim_name
string

The name of the claim.

Exampleemail
claim_value
string

The value of the claim.

Exampleuser@company.io
role_id
string (uuid)

The ID of the role in Torq the claim is mapped to.

Exampleb7a6c3f0-5d6a-4b3b-8f9a-103c4d5e6f7a
rank
integer (int64)

The rank of a claim mapping determines its position in the ordered list of mappings, ranging from 1 to n. For instance, given the claim mappings list [a, b, c, d, e], updating the rank of claim c to 2 would result in the updated list: [a, c, b, d, e]. Claims are applied in order. A user is assigned a role according to the first match found and subsequent mappings are ignored.

Example2
401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object