v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Resources

Retrieve Token User Info

After a client application has obtained an access token, it can make a request to the /userinfo endpoint to get user-related information. The data returned include the user's ID, email, username, and other profile details along with the scopes granted to the token.

get/userinfo

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200

substring required

Subject identifier as defined by the OIDC specification. Equal to the user's Ironclad ID.

idstring required

emailstring required

usernamestring required

firstNamestring required

lastNamestring required

displayNamestring required

titlestring required

companyIdstring required

companyNamestring required

scopesstring[] required

Example response

{
  "sub": "63d415e0dd0d828c3a878548",
  "id": "63d415e0dd0d828c3a878548",
  "email": "user@example.com",
  "username": "username",
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "John Doe",
  "title": "Software Engineer",
  "companyId": "6013609108b8f070cee94fc1",
  "companyName": "Example Company",
  "scopes": [
    "public.records.readRecords",
    "public.records.createRecords"
  ]
}