Struct google_sts1::api::GoogleIdentityStsV1ExchangeTokenRequest

pub struct GoogleIdentityStsV1ExchangeTokenRequest {
    pub audience: Option<String>,
    pub grant_type: Option<String>,
    pub options: Option<String>,
    pub requested_token_type: Option<String>,
    pub scope: Option<String>,
    pub subject_token: Option<String>,
    pub subject_token_type: Option<String>,
}

Request message for ExchangeToken.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• token (request)

Fields

audience: Option<String>

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.

grant_type: Option<String>

Required. The grant type. Must be urn:ietf:params:oauth:grant-type:token-exchange, which indicates a token exchange.

options: Option<String>

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.

requested_token_type: Option<String>

Required. An identifier for the type of requested security token. Must be urn:ietf:params:oauth:token-type:access_token.

scope: Option<String>

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.

subject_token: Option<String>

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. - 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 after iat. 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" } } If subject_token is for AWS, it must be a serialized GetCallerIdentity token. This token contains the same information as a request to the AWS GetCallerIdentity() method, as well as the AWS signature for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the subject_token_type parameter to urn:ietf:params:aws:token-type:aws4_request. The following parameters are required: - url: The URL of the AWS STS endpoint for GetCallerIdentity(), such as https://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 string. This value is typically set to the current time and is used to help prevent replay attacks. - host: The hostname of the url field; for example, sts.amazonaws.com. - x-goog-cloud-target-resource: The full, canonical resource name of the workload identity pool provider, with or without an https: prefix. To help ensure data integrity, we recommend including this header in the SignedHeaders field 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 header x-amz-security-token, with the value set to the session token. The following example shows a GetCallerIdentity token: { "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, set subject_token_type to urn:ietf:params:oauth:token-type:access_token. If an access token already contains security attributes, you cannot apply additional security attributes.

subject_token_type: Option<String>

Required. An identifier that indicates the type of the security token in the subject_token parameter. Supported values are urn:ietf:params:oauth:token-type:jwt, urn:ietf:params:aws:token-type:aws4_request, and urn:ietf:params:oauth:token-type:access_token.

Trait Implementations

impl Clone for GoogleIdentityStsV1ExchangeTokenRequest

fn clone(&self) -> GoogleIdentityStsV1ExchangeTokenRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GoogleIdentityStsV1ExchangeTokenRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GoogleIdentityStsV1ExchangeTokenRequest

fn default() -> GoogleIdentityStsV1ExchangeTokenRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleIdentityStsV1ExchangeTokenRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl RequestValue for GoogleIdentityStsV1ExchangeTokenRequest

impl Serialize for GoogleIdentityStsV1ExchangeTokenRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.