GoogleApi.STS.V1.Model.GoogleIdentityStsV1ExchangeTokenRequest (google_api_sts v0.3.0) View Source

Request message for ExchangeToken.

Attributes

audience (type: String.t, default: nil) - The full resource name of the identity provider; for example: //iam.googleapis.com/projects//workloadIdentityPools//providers/. Required when exchanging an external credential for a Google access token.
grantType (type: String.t, default: nil) - Required. The grant type. Must be urn:ietf:params:oauth:grant-type:token-exchange, which indicates a token exchange.
options (type: String.t, default: nil) - A set of features that Security Token Service supports, in addition to the standard OAuth 2.0 token exchange, formatted as a serialized JSON object of Options.
requestedTokenType (type: String.t, default: nil) - Required. An identifier for the type of requested security token. Must be urn:ietf:params:oauth:token-type:access_token.
scope (type: String.t, default: nil) - The OAuth 2.0 scopes to include on the resulting access token, formatted as a list of space-delimited, case-sensitive strings. Required when exchanging an external credential for a Google access token.
subjectToken (type: String.t, default: nil) - Required. The input token. You can use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. If an access token already contains security attributes, you cannot apply additional security attributes.
subjectTokenType (type: String.t, default: nil) - Required. An identifier that indicates the type of the security token in the subject_token parameter. Must be urn:ietf:params:oauth:token-type:access_token.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

Specs

t() :: %GoogleApi.STS.V1.Model.GoogleIdentityStsV1ExchangeTokenRequest{
  audience: String.t(),
  grantType: String.t(),
  options: String.t(),
  requestedTokenType: String.t(),
  scope: String.t(),
  subjectToken: String.t(),
  subjectTokenType: String.t()
}

Link to this section Functions

decode(value, options)

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.