SCIM

Create User

post/scim/v2/{workspaceId}/Users

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/scim/v2/{workspaceId}/Users
  • Auth: none declared

Path parameters

workspaceIdstring required

Request body

schemasstring[] required

Schema Definition for the Resource

userNamestring required

Identifier for the user at Okta

externalIdstring

External Unique Identifier for the user at Client Side

activeboolean required

Information about if user is active or not

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "jane-doe@test.com",
  "name": {
    "givenName": "Jane",
    "familyName": "Doe",
    "formatted": "Jane Doe"
  },
  "emails": [
    {
      "primary": true,
      "value": "jane-doe@test.com"
    }
  ],
  "externalId": "00ub5me9eooGKzSp05d7",
  "photos": [
    {
      "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
      "type": "photo"
    }
  ]
}

Response

schemasstring[] required

Schema Definition for the Resource

idstring required

Unique Identifier for the user at PhononX

externalIdstring

External Unique Identifier for the user at Client Side

activeboolean required

Information about if user is active or not

userNamestring required

Identifier for the user at Okta

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "cj0iFquUILzBTSKd",
  "externalId": "00ub5me9eooGKzSp05d7",
  "userName": "jane-doe@test.com",
  "name": {
    "givenName": "Jane",
    "familyName": "Doe",
    "formatted": "Jane Doe"
  },
  "meta": {
    "resourceType": "User",
    "location": "https://api.carbonvoice.app/scim/v2/:workspaceId/Users/cj0iFquUILzBTSKd"
  },
  "emails": [
    {
      "primary": true,
      "value": "jane-doe@test.com"
    }
  ]
}

Changes

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