---
title: "Retrieve Token User Info"
method: GET
path: "/userinfo"
tags: ["Resources"]
---

# Retrieve Token User Info

`GET /userinfo`

## Request

- Base URL: `https://ironcladapp.com/oauth`
- URL: `https://ironcladapp.com/oauth/userinfo`
- Auth: none declared

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. The `x-as-user-email` / `x-as-user-id` headers do not redirect this endpoint for a token from the Authorization Code grant: it always describes the user the token was issued for, because a relying party would otherwise sign in whoever the header named. Client Credentials and legacy bearer tokens have no user of their own, so for those it describes the user named by the header.

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Response `200`

200

- object
  - `sub` string, required: Subject identifier as defined by the OIDC specification. Equal to the user's Ironclad ID.
  - `id` string, required
  - `email` string, required
  - `username` string, required
  - `firstName` string, required
  - `lastName` string, required
  - `displayName` string, required
  - `title` string, required
  - `companyId` string, required
  - `companyName` string, required
  - `scopes` string[], required

## Other responses

- `401`: 401
- `404`: 404

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-oauth-2-0-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-oauth-2-0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-oauth-2-0-api/revisions/d038abd5a616?raw)