GoogleApi.STS.V1.Model.GoogleIdentityStsV1ExchangeTokenRequest (google_api_sts v0.3.1) 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. This token is a either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in RFC 7523, and the subject_token_type must be urn:ietf:params:oauth:token-type:jwt. The following headers are required: - kid: The identifier of the signing key securing the JWT. - alg: The cryptographic algorithm securing the JWT. Must be RS256. The following payload fields are required. For more information, see RFC 7523, Section 3: - iss: The issuer of the token. The issuer must provide a discovery document at the URL /.well-known/openid-configuration, where ` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). -iat: The issue time, in seconds, since the Unix epoch. Must be in the past. -exp: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours afteriat. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. -sub: The identity asserted in the JWT. -aud: Configured by the mapper policy. The default value is the service account's unique ID. Example header: ``` { "alg": "RS256", "kid": "us-east-11" } ``` Example payload: ``` { "iss": "https://accounts.google.com", "iat": 1517963104, "exp": 1517966704, "aud": "113475438248934895348", "sub": "113475438248934895348", "my_claims": { "additional_claim": "value" } } ``` Ifsubject_tokenis for AWS, it must be a serializedGetCallerIdentitytoken. This token contains the same information as a request to the AWS [GetCallerIdentity()](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set thesubject_token_typeparameter tourn:ietf:params:aws:token-type:aws4_request. The following parameters are required: -url: The URL of the AWS STS endpoint forGetCallerIdentity(), such ashttps://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15. Regional endpoints are also supported. -method: The HTTP request method:POST. -headers: The HTTP request headers, which must include: -Authorization: The request signature. -x-amz-date: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. -host: The hostname of theurlfield; for example,sts.amazonaws.com. -x-goog-cloud-target-resource: The full, canonical resource name of the workload identity pool provider, with or without anhttps:prefix. To help ensure data integrity, we recommend including this header in theSignedHeadersfield of the signed request. For example: //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the headerx-amz-security-token, with the value set to the session token. The following example shows aGetCallerIdentitytoken: ``` { "headers": [ {"key": "x-amz-date", "value": "20200815T015049Z"}, {"key": "Authorization", "value": "AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature"}, {"key": "x-goog-cloud-target-resource", "value": "//iam.googleapis.com/projects//locations//workloadIdentityPools//providers/"}, {"key": "host", "value": "sts.amazonaws.com"} . ], "method": "POST", "url": "https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" } ``` You can also 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. In this case, setsubject_token_typetourn:ietf:params:oauth:token-type:access_token. 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 thesubject_tokenparameter. Supported values areurn:ietf:params:oauth:token-type:jwt,urn:ietf:params:aws:token-type:aws4_request, andurn:ietf:params:oauth:token-type:access_token`.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

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

Specs

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

Unwrap a decoded JSON object into its complex fields.