API Reference/Management/Tenants/SCIM
PUT
/scim/v2/Users/{userId}

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Access Key > as bearer

In: header

Request Body

application/jsonRequired
userIdstring
displayNamestring

The following values are manipulated by the marshaler in httpgateway/marshaler.go in case of changing or adding new ones, need to edit the marshaler as well

emailsarray<object>
activeboolean
nameobject
userNamestring
attributesobject

Path Parameters

userIdRequiredstring
curl -X PUT "https://api.descope.com/scim/v2/Users/string" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "string",
    "displayName": "string",
    "emails": [
      {
        "value": "string",
        "primary": true,
        "type": "string"
      }
    ],
    "active": true,
    "name": {
      "givenName": "string",
      "familyName": "string",
      "middleName": "string"
    },
    "userName": "string",
    "attributes": {}
  }'

OK

{
  "user": {
    "schemas": [
      "string"
    ],
    "id": "string",
    "userName": "string",
    "meta": {
      "created": {},
      "location": "string",
      "lastModified": {},
      "resourceType": "string"
    },
    "emails": [
      {
        "value": "string",
        "primary": true,
        "type": "string"
      }
    ],
    "name": {
      "givenName": "string",
      "familyName": "string",
      "middleName": "string"
    },
    "active": true,
    "displayName": "string",
    "detail": "string",
    "attributes": {}
  }
}

Was this helpful?

Load SCIM User GET

### Load an existing SCIM user, using a valid access key. This endpoint allows administrators to load an existing SCIM user. The response includes the user's object, which includes details about the users including their email, phone, username, name, etc. It is important to note the bearer token for SCIM API endpoints. The format is `ProjectId:AccessKey` the access key must be associated with the applicable tenant and associated with the tenant admin role. ### Next Steps Once you have user data, you can utilize [Update SCIM Group](/api/management/tenants/scim/update-scim-group) to add or remove the user on groups. ### See also - See [SCIM Management](/scim) for further details on managing SCIM provisioning. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:AccessKey>`

Delete SCIM User DELETE

### Delete an existing SCIM User, using a valid access key. This API endpoint allows administrators to delete an existing SCIM user from the Descope tenant. It is important to note the bearer token for SCIM API endpoints. The format is `ProjectId:AccessKey` the access key must be associated with the applicable tenant and associated with the tenant admin role. ### See also - See [SCIM Management](/scim) for further details on managing SCIM provisioning. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:AccessKey>`