Update User

PATCH

/iam/v1/users/{id}

curl --request PATCH \
  --url https://example.com/iam/v1/users/example \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "name": "example", "surname": "example", "avatar": "example" }'

Updates an existing user

Parameters

Path Parameters

id

required

string

The unique identifier of the user to update

Query Parameters

update_mask

string format: field-mask

The set of fields to update. If omitted, all mutable fields are overwritten. See AIP-134 for field mask semantics.

Request Body ^required

Media type application/json

User resource — an authenticated human identity in the platform (a Person).

object

id

The unique identifier of the user

stringOutput only

email

required

The email address of the user

string

name

required

The given name of the user

string

surname

required

The family name of the user

string

avatar

Reference to the user’s avatar image in object storage; empty when unset.

string

status

The lifecycle status of the user.

string format: enum Output only

Allowed values: PRINCIPAL_STATUS_UNSPECIFIED PRINCIPAL_STATUS_INVITED PRINCIPAL_STATUS_ACTIVE PRINCIPAL_STATUS_DEACTIVATED

type

The discriminated principal kind (always USER for this resource).

string format: enum Output only

Allowed values: PRINCIPAL_TYPE_UNSPECIFIED PRINCIPAL_TYPE_USER PRINCIPAL_TYPE_SERVICE_ACCOUNT

last_seen

Best-effort last-authentication instant; absent until first authentication.

string format: date-time Output only

created

Created Timestamp

The timestamp when the user was created

string format: date-time Output only

updated

Updated Timestamp

Timestamp when the User was last updated

string format: date-time Output only

Responses

200

OK

Media type application/json

IAM Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object

id

Operation ID

Unique identifier for this operation.

stringOutput only

resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only

resource_type

Resource Type

The type of resource (e.g., “User”, “Role”, “IamBinding”).

stringOutput only

operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only

Allowed values: IAM_OPERATION_TYPE_UNSPECIFIED IAM_OPERATION_TYPE_CREATE IAM_OPERATION_TYPE_UPDATE IAM_OPERATION_TYPE_DELETE IAM_OPERATION_TYPE_AUTHENTICATE IAM_OPERATION_TYPE_CHANGE_PASSWORD IAM_OPERATION_TYPE_REVOKE IAM_OPERATION_TYPE_GRANT IAM_OPERATION_TYPE_INVITE IAM_OPERATION_TYPE_DEACTIVATE IAM_OPERATION_TYPE_REACTIVATE IAM_OPERATION_TYPE_ACTIVATE IAM_OPERATION_TYPE_UPLOAD_AVATAR IAM_OPERATION_TYPE_CLEAR_AVATAR

status

Status

Current lifecycle state of the operation.

string format: enum Output only

Allowed values: IAM_OPERATION_STATUS_UNSPECIFIED IAM_OPERATION_STATUS_PENDING IAM_OPERATION_STATUS_RUNNING IAM_OPERATION_STATUS_DONE IAM_OPERATION_STATUS_ERROR

insert_time

Insert Time

When the operation was first created.

string format: date-time Output only

start_time

Start Time

When the operation started executing.

string format: date-time Output only

end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only

errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object

code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the error.

stringOutput only

warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object

code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the warning.

stringOutput only

progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only

cause

Revocation Cause

Discriminator for REVOKE operations only (UNSPECIFIED for every other operation_type). See RevocationCause for the four flavours.

string format: enum Output only

Allowed values: REVOCATION_CAUSE_UNSPECIFIED REVOCATION_CAUSE_SELF REVOCATION_CAUSE_TARGETED REVOCATION_CAUSE_ADMIN_TARGETED REVOCATION_CAUSE_SESSION_CAP_EXCEEDED

Example

{
  "operation_type": "IAM_OPERATION_TYPE_UNSPECIFIED",
  "status": "IAM_OPERATION_STATUS_UNSPECIFIED",
  "cause": "REVOCATION_CAUSE_UNSPECIFIED"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}