Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Users

Retrieve a User

Documentation on accessing User info via SCIM.

OAuth Scope required: scim.users.readUsers

get/Users/{userId}

Path parameters

userIdstring required

A user's unique id can be identified using the Retrieve all Users endpoint with a filter parameter

Query parameters

excludedAttributesstring

A comma-separated list of attributes to exclude from the resources in the response.

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 OK

schemasstring[] required
userNamestring

The email address of the user (e.g., jdoe@acme.com).

titlestring

The user's legal title.

idstring required

The user's unique identifier.

activeboolean

Whether this user is currently active. Ironclad users do not have the concept of active vs. inactive, and a SCIM User with active set to false will be removed from the company. On subsequent reads, inactive users would be not found.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "alex.doe@example.com",
  "name": {
    "givenName": "Alex",
    "familyName": "Doe"
  },
  "title": "Vice President",
  "id": "6660d37dec0eac3deffb680e",
  "emails": [
    {
      "value": "alex.doe@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "active": true,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "department": "Legal"
  },
  "urn:ietf:params:scim:schemas:extension:ironclad:2.0:User": {
    "departmentHead": "jane.doe@test.com",
    "provider": "local"
  },
  "meta": {
    "resourceType": "User",
    "created": "2025-03-26T18:33:48.336Z",
    "lastModified": "2025-03-26T18:33:48.336Z",
    "location": "https://na1.ironcladapp.com/scim/v2/Users/67e4488c605caf0d8aa2e5c6"
  }
}