Skip to main content
PATCH
Partially update a user

Authorizations

Authorization
string
header
required

Plerion organization API key (plerion_oak_…), created by an organization admin in the Plerion console. Write operations require a key with readWrite access level; GET and .search work with read access level.

Path Parameters

userId
string<uuid>
required

The Plerion-assigned user id (SCIM id).

Body

RFC 7644 PatchOp. op values are matched case-insensitively.

schemas
string[]
required
Allowed value: "urn:ietf:params:scim:api:messages:2.0:PatchOp"
Operations
object[]
required
Minimum array length: 1

Response

The updated user.

SCIM core User as supported by Plerion. Other standard SCIM attributes are accepted and returned unchanged but do not affect Plerion behavior. The user's Plerion sign-in email is derived from the payload with no configuration: userName when that value is an email address, otherwise the primary email, otherwise the work email.

schemas
string[]
required
Example:
userName
string
required

Required. Unique within the organization, case-insensitive.

id
string<uuid>
read-only

Plerion-assigned identifier. Use it for all subsequent requests.

externalId
string

The identity provider's identifier for the user. Filterable.

name
object
displayName
string

The Plerion display name is taken from name.formatted, falling back to displayName, then "givenName familyName".

emails
object[]
active
boolean
default:true

false deactivates the user. Sign-in is blocked, sessions end within seconds, and the user's API keys are revoked. The record is retained.

groups
object[]
read-only
meta
object
read-only