Overview

Adds a new user to one or more CleverTap accounts. If the user already exists in any of the accounts specified in the POST request, the request fails with an error message indicating that the user already exists. Only add users to accounts where they are not already present.

HTTP Method

POST

Endpoint

/nx/v2/scim/v2/Users

Base URL

The following is an example base URL for a CleverTap account in the United States region:

https://<clevertap_domain>/nx/v2/scim/v2/Users

Example: https://us1.dashboard.clevertap.com/nx/v2/scim/v2/Users

🚧

Region-Specific

The CleverTap domain is environment- and region-specific. Do not copy the example URL directly. Always replace <clevertap_domain> with the domain for your region. Refer Region for more details.

Headers

The following headers are required for every request.

Replace <SCIM_TOKEN> with a valid SCIM Bearer token generated from the CleverTap dashboard. Refer to Generate SCIM Token for API-Based Provisioning.

Example Request

The following is the sample request:

curl -X POST https://<clevertap_domain>/nx/v2/scim/v2/Users
-H "Authorization: Bearer <SCIM_TOKEN>"
-H "Content-Type: application/scim+json"
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "[email protected]",
  "name": {
    "givenName": "Jane",
    "familyName": "Smith"
  },
  "active": true,
  "invitedBy": "[email protected]",
  "accounts": [
    {
      "accountId": "CLEVERTAP_ACCOUNT_ID",
      "roles": "Editor",
      "teams": "Marketing",
      "status": "Active"
    }
  ]
}

Request Parameters

The following table lists the request body parameters.

Notes

• You must use valid team names and roles.
• At least one account entry must include a status set to Active.
• The user specified in invitedBy must have admin permissions.
• Multiple accounts may be included only when they belong to the same parent-child structure.
• Validation is strictly applied for email, account information, roles, and teams.

Example Response

The following is the sample response:

{
  "id": "user-unique-id",
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "[email protected]",
  "name": {
    "givenName": "Jane",
    "familyName": "Smith"
  },
  "active": true,
  "accounts": [
    {
      "accountId": "CLEVERTAP_ACCOUNT_ID",
      "roles": "Editor",
      "teams": "Marketing",
      "status": "Active"
    }
  ],
  "invitedBy": "[email protected]"
}

Response Parameters

The following table lists the response parameters.

Error Codes

The following table lists possible error responses.