Resource: ServiceAccount
An IAM service account.
A service account is an account for an application or a virtual machine (VM) instance, not a person. You can use a service account to call Google APIs. To learn more, read the overview of service accounts.
When you create a service account, you specify the project ID that owns the service account, as well as a name that must be unique within the project. IAM uses these values to create an email address that identifies the service account. //
JSON representation |
---|
{ "name": string, "projectId": string, "uniqueId": string, "email": string, "displayName": string, "etag": string, "description": string, "oauth2ClientId": string, "disabled": boolean } |
Fields | |
---|---|
name |
The resource name of the service account. Use one of the following formats:
As an alternative, you can use the
When possible, avoid using the |
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. |
Methods |
|
---|---|
|
Creates a ServiceAccount . |
|
Deletes a ServiceAccount . |
|
Disables a ServiceAccount immediately. |
|
Enables a ServiceAccount that was disabled by DisableServiceAccount . |
|
Gets a ServiceAccount . |
|
Gets the IAM policy that is attached to a ServiceAccount . |
|
Lists every ServiceAccount that belongs to a specific project. |
|
Patches a ServiceAccount . |
|
Sets the IAM policy that is attached to a ServiceAccount . |
(deprecated) |
Note: This method is deprecated. |
(deprecated) |
Note: This method is deprecated. |
|
Tests whether the caller has the specified permissions on a ServiceAccount . |
|
Restores a deleted ServiceAccount . |
|
Note: We are in the process of deprecating this method. |