SCIM

Get user by ID via SCIM v2.0

Retrieves a single user for the authenticated company by user ID

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

get/v1/scim/v2/Users/{id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/scim/v2/Users/{id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token
- or HTTP bearer

Path parameters

idstring required

User ID (slug)

Response

Success

activeboolean required

Whether the user is active

displayNamestring

The name to display for the user

idstring required

Unique identifier for the user

nickNamestring

The casual/preferred name for the user

schemasstring[] required

SCIM schema identifiers

userNamestring required

Username for the user

Example response

{
  "active": true,
  "displayName": "Johnny Doe",
  "emails": [
    {
      "primary": true,
      "type": "work",
      "value": "john.doe@example.com"
    }
  ],
  "id": "123456",
  "meta": {
    "created": "2023-01-01T00:00:00Z",
    "lastModified": "2023-01-01T00:00:00Z",
    "resourceType": "User"
  },
  "name": {
    "familyName": "Doe",
    "formatted": "John Doe",
    "givenName": "John",
    "honorificPrefix": "Mr"
  },
  "nickName": "Johnny",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "department": "Engineering",
    "employeeNumber": "EMP001",
    "manager": {
      "displayName": "Jane Manager",
      "value": "789012"
    }
  },
  "userName": "john.doe@example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.