Users

Modify User

Modify an existing user. To deactivate a user, set the active field to false.

put/Users/{id}

Request

Base URL
https://users.lucid.app/scim/v2
URL
https://users.lucid.app/scim/v2/Users/{id}
Auth
HTTP bearer

Parameters

#/paths/~1Users~1{id}/get/parameters/0 (unresolved $ref)

Request body

schemasstring[] required

URIs identifying the SCIM schemas that describe this resource's attributes.

userNamestring required

The user's username (usually their email).

displayNamestring

The name that is displayed and represents the user (usually their email).

activeboolean

Whether the user can authenticate to Lucid.

externalIdstring

An identifier for the user as defined by the provisioning client.

titlestring

The user's job title.

metaobject

passwordstring

Passwords must be at least 8 characters in length.

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "userName": "john-doe@example.com",
  "name": {
    "formatted": "John Doe",
    "givenName": "John",
    "familyName": "Doe"
  },
  "displayName": "john-doe@example.com",
  "emails": [
    {
      "value": "john-doe@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "externalId": "external-123",
  "title": "Software Engineer",
  "phoneNumbers": [
    {
      "value": "+1-555-123-4567",
      "type": "work"
    }
  ],
  "roles": [
    {
      "value": "DocumentAdmin"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "costCenter": "CC-100",
    "organization": "Engineering",
    "division": "Product Development",
    "department": "Backend Engineering",
    "manager": {
      "value": "lucid-5678"
    }
  },
  "password": "password"
}

Response

OK. Returns the modified User.

schemasstring[]