package google.iam.credentials.v1

Get desktop application:
View/edit binary Protocol Buffers messages

A service account is a special type of Google account that belongs to your application or a virtual machine (VM), instead of to an individual end user. Your application assumes the identity of the service account to call Google APIs, so that the users aren't directly involved. Service account credentials are used to temporarily assume the identity of the service account. Supported credential types include OAuth 2.0 access tokens, OpenID Connect ID tokens, self-signed JSON Web Tokens (JWTs), and more.

• rpc GenerateAccessToken (GenerateAccessTokenRequest, GenerateAccessTokenResponse)

  iamcredentials.proto:39

  Generates an OAuth 2.0 access token for a service account.

  message GenerateAccessTokenRequest

  common.proto:28

  • string name = 1

    The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.

  • repeated string delegates = 2

    The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`

  • repeated string scope = 4

    Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

  • optional protobuf.Duration lifetime = 7

    The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour.

  message GenerateAccessTokenResponse

  common.proto:58

  • string access_token = 1

    The OAuth 2.0 access token.

  • optional protobuf.Timestamp expire_time = 3

    Token expiration time. The expiration time is always set.

• rpc GenerateIdToken (GenerateIdTokenRequest, GenerateIdTokenResponse)

  iamcredentials.proto:48

  Generates an OpenID Connect ID token for a service account.

  message GenerateIdTokenRequest

  common.proto:125

  • string name = 1

    The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.

  • repeated string delegates = 2

    The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`

  • string audience = 3

    The audience for the token, such as the API or account that this token grants access to.

  • bool include_email = 4

    Include the service account email in the token. If set to `true`, the token will contain `email` and `email_verified` claims.

  message GenerateIdTokenResponse

  common.proto:151

  • string token = 1

    The OpenId Connect ID token.

• rpc SignBlob (SignBlobRequest, SignBlobResponse)

  iamcredentials.proto:57

  Signs a blob using a service account's system-managed private key.

  message SignBlobRequest

  common.proto:67

  • string name = 1

    The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.

  • repeated string delegates = 3

    The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`

  • bytes payload = 5

    The bytes to sign.

  message SignBlobResponse

  common.proto:88

  • string key_id = 1

    The ID of the key used to sign the blob.

  • bytes signed_blob = 4

    The signed blob.

• rpc SignJwt (SignJwtRequest, SignJwtResponse)

  iamcredentials.proto:65

  Signs a JWT using a service account's system-managed private key.

  message SignJwtRequest

  common.proto:96

  • string name = 1

    The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`.

  • repeated string delegates = 3

    The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`

  • string payload = 5

    The JWT payload to sign: a JSON object that contains a JWT Claims Set.

  message SignJwtResponse

  common.proto:117

  • string key_id = 1

    The ID of the key used to sign the JWT.

  • string signed_jwt = 2

    The signed JWT.