Represents a project-scoped, machine-to-machine API credential. Its permissions come from access control group memberships and direct permission statements, the same as a user. It is available only in projects with fine-grained access control enabled.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the service account was created, in RFC3339 format.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
name
string
Yes
Display name of the service account.
projectId
integer
Yes
read-only (server-generated)
Project that this service account belongs to.
suspended
boolean
Yes
When true, the service account is suspended and all of its tokens are rejected.
updatedAt
string
Yes
read-only (server-generated)
Time the service account was last updated, in RFC3339 format.
getServiceAccounts — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccounts — 403 response
Request failed because of denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccounts — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccounts — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccounts — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccount — request
Request body for Create a service account.
Property
Type
Required
Constraints
Description
name
string
Yes
The display name of the service account.
projectId
integer
Yes
The project the service account belongs to.
createServiceAccount — 201 response
Successfully created a new service account and its first token. The raw token secret is returned exactly once.
Property
Type
Required
Constraints
Description
serviceAccount
object
Yes
Represents a project-scoped, machine-to-machine API credential. Its permissions come from access control group memberships and direct permission statements, the same as a user. It is available only in projects with fine-grained access control enabled.
Properties of serviceAccount
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the service account was created, in RFC3339 format.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
name
string
Yes
Display name of the service account.
projectId
integer
Yes
read-only (server-generated)
Project that this service account belongs to.
suspended
boolean
Yes
When true, the service account is suspended and all of its tokens are rejected.
updatedAt
string
Yes
read-only (server-generated)
Time the service account was last updated, in RFC3339 format.
token
string
Yes
read-only (server-generated)
Raw secret of the first token. Returned exactly once at creation and never again. Send it in the Authorization header. It is rejected if presented in a query string.
tokenMetadata
object
Yes
Stored metadata for a single service account token. The raw token secret is never persisted or returned in this record. Only a short display suffix is kept.
Properties of tokenMetadata
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the token was created, in RFC3339 format.
expiresAt
string
No
read-only (server-generated)
Time the token expires, in RFC3339 format. Absent if the token does not expire.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
projectId
integer
Yes
read-only (server-generated)
Project that this token belongs to.
serviceAccountId
integer
Yes
read-only (server-generated)
Service account that this token belongs to.
status
string
Yes
read-only (server-generated); one of: active, suspended
Lifecycle state of the token.
suffix
string
Yes
read-only (server-generated)
Trailing characters of the raw token, kept for display only.
createServiceAccount — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccount — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccount — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccount — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccount — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteServiceAccount — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteServiceAccount — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteServiceAccount — 404 response
The required serviceAccount does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteServiceAccount — 409 response
The serviceAccount cannot be deleted because it is being used by another part of the system.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteServiceAccount — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteServiceAccount — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteServiceAccount — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccount — 200 response
Successfully retrieved service account with specified ID.
Property
Type
Required
Constraints
Description
serviceAccount
object
Yes
Represents a project-scoped, machine-to-machine API credential. Its permissions come from access control group memberships and direct permission statements, the same as a user. It is available only in projects with fine-grained access control enabled.
Properties of serviceAccount
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the service account was created, in RFC3339 format.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
name
string
Yes
Display name of the service account.
projectId
integer
Yes
read-only (server-generated)
Project that this service account belongs to.
suspended
boolean
Yes
When true, the service account is suspended and all of its tokens are rejected.
updatedAt
string
Yes
read-only (server-generated)
Time the service account was last updated, in RFC3339 format.
tokens
array<object>
Yes
Stored metadata for the account's tokens. Empty if the account has no tokens.
Properties of tokens
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the token was created, in RFC3339 format.
expiresAt
string
No
read-only (server-generated)
Time the token expires, in RFC3339 format. Absent if the token does not expire.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
projectId
integer
Yes
read-only (server-generated)
Project that this token belongs to.
serviceAccountId
integer
Yes
read-only (server-generated)
Service account that this token belongs to.
status
string
Yes
read-only (server-generated); one of: active, suspended
Lifecycle state of the token.
suffix
string
Yes
read-only (server-generated)
Trailing characters of the raw token, kept for display only.
getServiceAccount — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccount — 403 response
Request failed because of denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccount — 404 response
The requested serviceAccount does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccount — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccount — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccount — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateServiceAccount — request
Request body for Update a service account.
Property
Type
Required
Constraints
Description
name
string
No
The new display name.
suspended
boolean
No
Whether the service account is suspended.
updateServiceAccount — 200 response
Successfully updated service account with specified ID.
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the service account was created, in RFC3339 format.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
name
string
Yes
Display name of the service account.
projectId
integer
Yes
read-only (server-generated)
Project that this service account belongs to.
suspended
boolean
Yes
When true, the service account is suspended and all of its tokens are rejected.
updatedAt
string
Yes
read-only (server-generated)
Time the service account was last updated, in RFC3339 format.
updateServiceAccount — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateServiceAccount — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateServiceAccount — 404 response
The requested serviceAccount does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateServiceAccount — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateServiceAccount — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateServiceAccount — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccountTokens — 200 response
Successful retrieval of list of token metadata.
Stored metadata for a single service account token. The raw token secret is never persisted or returned in this record. Only a short display suffix is kept.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the token was created, in RFC3339 format.
expiresAt
string
No
read-only (server-generated)
Time the token expires, in RFC3339 format. Absent if the token does not expire.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
projectId
integer
Yes
read-only (server-generated)
Project that this token belongs to.
serviceAccountId
integer
Yes
read-only (server-generated)
Service account that this token belongs to.
status
string
Yes
read-only (server-generated); one of: active, suspended
Lifecycle state of the token.
suffix
string
Yes
read-only (server-generated)
Trailing characters of the raw token, kept for display only.
getServiceAccountTokens — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccountTokens — 403 response
Request failed because of denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccountTokens — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccountTokens — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getServiceAccountTokens — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccountToken — request
Request body for Create a service account token.
Property
Type
Required
Constraints
Description
expiresAt
string
No
Optional time the token expires, in RFC3339 format. Must be in the future. If omitted, the token does not expire.
createServiceAccountToken — 201 response
Successfully created a new token. The raw token secret is returned exactly once.
Property
Type
Required
Constraints
Description
metadata
object
Yes
Stored metadata for a single service account token. The raw token secret is never persisted or returned in this record. Only a short display suffix is kept.
Properties of metadata
Property
Type
Required
Constraints
Description
createdAt
string
Yes
read-only (server-generated)
Time the token was created, in RFC3339 format.
expiresAt
string
No
read-only (server-generated)
Time the token expires, in RFC3339 format. Absent if the token does not expire.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
projectId
integer
Yes
read-only (server-generated)
Project that this token belongs to.
serviceAccountId
integer
Yes
read-only (server-generated)
Service account that this token belongs to.
status
string
Yes
read-only (server-generated); one of: active, suspended
Lifecycle state of the token.
suffix
string
Yes
read-only (server-generated)
Trailing characters of the raw token, kept for display only.
token
string
Yes
read-only (server-generated)
Raw token secret. Returned exactly once at creation and never again. Send it in the Authorization header. It is rejected if presented in a query string.
createServiceAccountToken — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccountToken — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccountToken — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccountToken — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createServiceAccountToken — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
revokeServiceAccountToken — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
revokeServiceAccountToken — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
revokeServiceAccountToken — 404 response
The required token does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
revokeServiceAccountToken — 409 response
The token cannot be deleted because it is being used by another part of the system.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
revokeServiceAccountToken — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
revokeServiceAccountToken — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
revokeServiceAccountToken — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
suspendReactivateServiceAccountToken — request
Request body for Suspend or reactivate a service account token.
Property
Type
Required
Constraints
Description
status
string
Yes
The new token status, either "active" or "suspended".