Skip to main content
PATCH
Update a user

Authorizations

Authorization
string
header
required

OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as Authorization: Bearer <token>.

Path Parameters

userId
string<uuid>
required

The user's SCIM resource ID.

Body

application/scim+json
schemas
string[]
Operations
object[] | null
externalId
string | null

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

Response

OK

schemas
string[]
userName
string | null

Unique identifier for the user, typically their email address. Required; must belong to a domain verified for your organization. Immutable once set.

name
object | null

The components of the user's name.

displayName
string | null
read-only

The user's display name (derived from their name on output). Server-controlled.

title
string | null

The user's job title, e.g. "Vice President".

preferredLanguage
string | null
read-only

The user's preferred language; mirrors locale on output. Set locale instead.

locale
string | null

The user's default locale, e.g. "en-US", used for localizing currency, dates and numbers.

timezone
string | null

The user's time zone in IANA ("Olson") format, e.g. "America/Los_Angeles".

active
boolean

Whether the user is active. false suspends the user's SaaS Manager access.

emails
object[] | null

Email addresses for the user.

phoneNumbers
object[] | null

Phone numbers for the user. Only the first value is stored.

roles
object[] | null

The SaaS Manager roles assigned to the user. Each role's value must match an existing role name.

id
string | null
read-only

The service-provider-assigned SCIM resource ID. Server-controlled; ignored on requests.

externalId
string | null

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

meta
object | null

Resource metadata (created/last-modified timestamps, resource type, location). Server-controlled; ignored on requests.