scimUserManagement

Update SCIM User

Updates an existing user's attributes in the SCIM system

put/v1/scim/Users/{id}

Request

  • Base URL
    https://api.au.sumologic.com/api
  • URL
    https://api.au.sumologic.com/api/v1/scim/Users/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Unique identifier of the SCIM user

Request body

schemasstring[] required

Defines the SCIM schemas for the user

activeboolean required

Indicates if the user is active

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "active": true,
  "emails": [
    {
      "value": "jdoe@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "roles": [
    [
      "role1",
      "role2"
    ],
    [
      {
        "value": "role1",
        "primary": true
      },
      {
        "value": "role2",
        "primary": true
      }
    ]
  ]
}

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"
  }
}

Changes

No recorded changes to this operation across all 15 revisions of this API.