Skip to main content
PATCH
Update User

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

id
string<uuid>
必須

User identifier (UUID).

ボディ

application/json
first_name
string

The user's first name. Not accepted for scim_managed: true users; name fields are owned by the IdP.

last_name
string | null

The user's last name. null for users with a single name. Not accepted for scim_managed: true users.

status
enum<string>

Lifecycle state. Deactivating immediately revokes all PATs.

利用可能なオプション:
active,
deactivated

レスポンス

Returns the full user object.

id
string<uuid>

User identifier.

email
string<email>

The email address of the user.

first_name
string

The user's first name.

last_name
string | null

The user's last name.

status
enum<string>

Current lifecycle state of the user.

利用可能なオプション:
active,
invited,
deactivated
scim_managed
boolean

false for API-created users. true for SCIM-provisioned users.

external_id
string | null

Idempotency key supplied by the calling system.

created_at
string<date-time>

ISO 8601 UTC.

created_by
string<uuid> | null

User ID of the creator. null for SCIM-provisioned users.