Get Service Account

GET

/iam/v1/service-accounts/{id}

curl --request GET \
  --url https://example.com/iam/v1/service-accounts/example

Returns a single service account by its unique ID.

Parameters

Path Parameters

id

required

string

The unique identifier of the service account to retrieve.

Responses

200

OK

Media type application/json

ServiceAccount: the machine identity a bounded context authenticates as for service-to-service calls. A CTI child of Principal, sharing the principal id.

Distinct from the Principal projection, which carries only the columns every principal kind has: a service account is addressed by its service_email and grouped by the bounded_context it represents, and neither exists on Principal.

Entirely OUTPUT_ONLY. Service accounts are provisioned by migration seed, one per bounded context, and are never created or edited through the API.

object

id

The unique identifier of the service account, shared with its Principal root.

stringOutput only

service_email

The unique address of this machine identity, e.g. compute@iam.serviceaccount.cloud.qibdo.com.

stringOutput only

bounded_context

The bounded context this service account acts on behalf of, e.g. “compute”.

stringOutput only

status

Whether the identity may currently authenticate.

string format: enum Output only

Allowed values: PRINCIPAL_STATUS_UNSPECIFIED PRINCIPAL_STATUS_INVITED PRINCIPAL_STATUS_ACTIVE PRINCIPAL_STATUS_DEACTIVATED

create_time

When the service account was provisioned.

string format: date-time Output only

update_time

When the service account was last modified.

string format: date-time Output only

Example

{
  "status": "PRINCIPAL_STATUS_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"
    }
  ]
}