Overview

Adaptive provides a SCIM (System for Cross-domain Identity Management) API to automate the provisioning of user accounts.

This documentation is a developer reference for the Adaptive SCIM API, especially for organizations that might not use common identity providers such as Microsoft Entra ID (formerly known as Azure AD) and Okta. For guides on configuring user provisioning with common identity providers, see the Employee Sync articles.

Adaptive's SCIM API is available at https://api.adaptivesecurity.com/v1/ and implements the SCIM v2 specification.

Note: All parameters and values in the Adaptive SCIM API are case-sensitive, unless specified otherwise.

Authentication

Adaptive's SCIM API requires a SCIM specific API key. You can reach out to your Custom Success contact or [email protected] to request this.

CREATE (POST)

POST /v1/Users HTTP/1.1
Authorization: Bearer <SCIM token>
Content-Type: application/scim+json

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "[email protected]",
  "name": {
    "givenName": "Jane",
    "familyName": "Doe"
  },
  "active": true
}

Core SCIM user attributes we accept

The Users API advertises a fixed set of top-level user fields from the SCIM core user schema. Payloads can include the following names: schemas, externalId, userName (which should be an email address), name, locale, title, phoneNumbers, preferredLanguage, and timezone,

Details for complex core attributes

name accepts the sub-properties familyName, givenName
phoneNumbers entries support value, type (mobile, work, or home)

Enterprise extension attributes

If the request includes the enterprise extension schema (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User), we understand the following field names: employeeNumber, costCenter, organization, division, department, manager, managerEmail, and startDate.

Update (PUT)

PUT /v1/Users/4b1af4f9-0c86-4c7a-8d6f-e672f5c8c7f0 HTTP/1.1
Host: api.adaptive.example
Authorization: Bearer <SCIM token>
Content-Type: application/scim+json

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "id": "4b1af4f9-0c86-4c7a-8d6f-e672f5c8c7f0",
  "userName": "[email protected]",
  "name": {
    "givenName": "Janet",
    "familyName": "Morris"
  },
  "title": "Director of Security",
  "active": true,
  "phoneNumbers": [
    {
      "value": "+1 415-555-0134",
      "type": "mobile"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "department": "Security",
    "division": "Operations",
    "managerEmail": "[email protected]",
    "startDate": "2024-01-08"
  }
}

Deactivate (DELETE)

DELETE /v1/Users/4b1af4f9-0c86-4c7a-8d6f-e672f5c8c7f0 HTTP/1.1
Host: api.adaptive.example
Authorization: Bearer <SCIM token>
Content-Type: application/scim+json