Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
scimUserManagement

Update SCIM User

Updates an existing user's attributes in the SCIM system

put/v1/scim/Users/{id}

Path parameters

idstring required

Unique identifier of the SCIM user

Request body

totalResultsinteger

Total number of users that match the filter criteria

startIndexinteger

The index of the first returned result

itemsPerPageinteger

The number of results returned in this page

Example request

{
  "totalResults": 100,
  "itemsPerPage": 10,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "jdoe@example.com",
      "name": {
        "givenName": "John",
        "familyName": "Doe"
      },
      "emails": [
        {
          "value": "jdoe@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "roles": [
        [
          "role1",
          "role2"
        ],
        [
          {
            "value": "role1",
            "primary": true
          },
          {
            "value": "role2",
            "primary": true
          }
        ]
      ],
      "id": "000000000FE20FE2",
      "active": true,
      "meta": {
        "resourceType": "User",
        "created": "2024-01-01T12:00:00Z",
        "lastModified": "2024-01-01T12:00:00Z"
      }
    }
  ]
}

Response

The user has been updated successfully

schemasstring[] required

Defines the SCIM schemas for the user

userNamestring required

Unique identifier for the user (email)

idstring required

Unique SCIM identifier for the user

activeboolean

True if the user is active

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "jdoe@example.com",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "emails": [
    {
      "value": "jdoe@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "roles": [
    [
      "role1",
      "role2"
    ],
    [
      {
        "value": "role1",
        "primary": true
      },
      {
        "value": "role2",
        "primary": true
      }
    ]
  ],
  "id": "000000000FE20FE2",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2024-01-01T12:00:00Z",
    "lastModified": "2024-01-01T12:00:00Z"
  }
}