Help & Support
Follow

User Provisioning API: Update a User (PUT)

Update a user

PUT /Users/:id

Updates a user overwriting all values except for the password even if they are empty or not provided. It is recommended that you get the users information first, apply the necessary updates to that result and use it as the body of the PUT request to perform the update.

Parameters

  • id - the id of the user

Example request body:

{
    "id": "12345678",
    "externalId": "ABC234",
    "userName": "demo@user.com",
    "name": {
        "familyName": "Demo",
        "givenName": "User"
    },
    "timezone": "America/Chicago",
    "active": true,
    "urn:scim:schemas:extension:leankit:user:1.0": {
        "licenseType": "full",
        "administrator": false,
        "boardCreator": false,
        "dateFormat": "mm/dd/yyyy"
    }
}

Change a user's password

If a password is specified in the body the user's password will be changed. If it is not specified the password WILL NOT change.

Example request body with password:

{
    "id": "12345678",
    "externalId": "ABC234",
    "userName": "demo@user.com",
    "name": {
        "familyName": "Demo",
        "givenName": "User"
    },
    "timezone": "America/Chicago",
    "active": true,
    "password": "thispasswordisdifferent123",
    "urn:scim:schemas:extension:leankit:user:1.0": {
        "licenseType": "full",
        "administrator": false,
        "boardCreator": false,
        "dateFormat": "mm/dd/yyyy"
    }
}

Returns

  • 200 OK with the updated user data as the body
  • 404 Not Found
  • 409 Conflict if the username is already in use by another user
Have more questions? Submit a request