Note:We are in the process of deprecating this method. Use serviceAccounts.patch
instead.
Updates a ServiceAccount
.
You can update only the displayName
field.
HTTP request
PUT https://iam.googleapis.com/v1/{name=projects/*/serviceAccounts/*}
The URL uses gRPC Transcoding syntax.
Path parameters
name
string
The resource name of the service account.
Use one of the following formats:
-
projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS} -
projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}
As an alternative, you can use the -
wildcard character instead of the project ID:
-
projects/-/serviceAccounts/{EMAIL_ADDRESS} -
projects/-/serviceAccounts/{UNIQUE_ID}
When possible, avoid using the -
wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account projects/-/serviceAccounts/fake@example.com
, which does not exist, the response contains an HTTP 403 Forbidden
error instead of a 404 Not
Found
error.
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "projectId" : string , "uniqueId" : string , "email" : string , "displayName" : string , "etag" : string , "description" : string , "oauth2ClientId" : string , "disabled" : boolean } |
| Fields | |
|---|---|
projectId
|
Output only. The ID of the project that owns the service account. |
uniqueId
|
Output only. The unique, stable numeric ID for the service account. Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account. |
email
|
Output only. The email address of the service account. |
displayName
|
Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes. |
etag
|
Deprecated. Do not use. A base64-encoded string. |
description
|
Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes. |
oauth2ClientId
|
Output only. The OAuth 2.0 client ID for the service account. |
disabled
|
Output only. Whether the service account is disabled. |
Response body
If successful, the response body contains an instance of ServiceAccount
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/iam -
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
