Skip to main content
PATCH
Patch User

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId
string
required

Target user id

Body

application/json
firstName
string
Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$
lastName
string
Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$
email
string<email>
status
enum<string>
Available options:
pending,
validated,
deactivated
meta
object
platformRole
string
groups
string[]
groupAcls
object

Response

Success Response

firstName
string
required

Name

email
string
Example:

"foo@prisme.ai"

status
enum<string>
Available options:
pending,
validated,
deactivated
language
string
authData
object
mfa
enum<string>

Current MFA method (super admin only).

Available options:
totp,
none,
*
meta
object
orgSlugs
string[]
platformRole
string
groupAcls
object
createdAt
string
updatedAt
string
updatedBy
string
lastName
string

Name

emailMasked
string

Partially masked email (e.g. "j***@acme.com"), returned to non-elevated callers in place of the clear-text email to disambiguate homonyms without exposing the full address.

photo
string

Profile picture URL

groups
string[]
identities
string[]

Denormalized ":" tuples (super admin only).

membership
object

Organization membership info (only returned when includeOrgMembership is set)

id
string

Unique id