View Source GoogleApi.STS.V1.Model.GoogleIdentityStsV1ExchangeOauthTokenRequest (google_api_sts v0.6.0)
Request message for ExchangeOauthToken
Attributes
-
clientId
(type:String.t
, default:nil
) - Optional. The client identifier for the OAuth 2.0 client that requested the provided token. It is REQUIRED when the [client] (https://www.rfc-editor.org/rfc/rfc6749#section-1.1) is not authenticating with the authorization server, i.e. when authentication method is [client authentication] (https://www.rfc-editor.org/rfc/rfc6749#section-3.2.1). -
code
(type:String.t
, default:nil
) - Optional. The authorization code that was previously from workforce identity federation'sauthorize
endpoint. Required if the flow is authorization code flow, i.e. if grant_type is 'authorization_code' -
codeVerifier
(type:String.t
, default:nil
) - Optional. The code verifier for the PKCE request, Google Cloud CLI originally generates it before the authorization request. PKCE is used to protect authorization code from interception attacks. See https://www.rfc-editor.org/rfc/rfc7636#section-1.1 and https://www.rfc-editor.org/rfc/rfc7636#section-3. It is required when the flow is authorization code flow, i.e. if grant_type is 'authorization_code' -
grantType
(type:String.t
, default:nil
) - Required. The grant types are as follows: - 'authorization_code' : an authorization code flow, i.e. exchange of authorization code for the Oauth access token - 'refresh_token' : a refresh token flow, i.e. obtain a new access token by providing the refresh token. See https://www.rfc-editor.org/rfc/rfc6749#section-6 -
redirectUri
(type:String.t
, default:nil
) - Optional. redirect_url is required when the flow is authorization code flow i.e. if grant_type isauthorization_code
See https://www.rfc-editor.org/rfc/rfc6749#section-4.1.3 -
refreshToken
(type:String.t
, default:nil
) - Optional. The Refresh token is the credential that is used to obtain a new access token when the current access token becomes invalid or expires. Required when using refresh token flow, i.e. ifgrant_type
is 'refresh_token' See https://www.rfc-editor.org/rfc/rfc6749#section-1.5 and https://www.rfc-editor.org/rfc/rfc6749#section-6 -
scope
(type:String.t
, default:nil
) - Optional. An optional list of scopes that are requested for the token to be returned. See https://www.rfc-editor.org/rfc/rfc6749#section-3.3 Must be a list of space-delimited, case-sensitive strings. Note: Currently, the scopes in the request are not supported
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
Functions
Unwrap a decoded JSON object into its complex fields.