class Google::Apis::StsV1::CloudSecurityTokenService
Security Token Service API
The Security Token Service exchanges Google
or third-party credentials for a
short-lived access token to Google Cloud resources.
@example
require 'google/apis/sts_v1' Sts = Google::Apis::StsV1 # Alias the module service = Sts::CloudSecurityTokenService.new
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
Public Class Methods
# File lib/google/apis/sts_v1/service.rb, line 46 def initialize super('https://sts.googleapis.com/', '', client_name: 'google-apis-sts_v1', client_version: Google::Apis::StsV1::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Exchanges a credential for a Google
OAuth 2.0 access token. The token asserts an external identity within a workload identity pool, or it applies a Credential Access Boundary to a Google
access token. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail. @param [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenRequest] google_identity_sts_v1_exchange_token_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/sts_v1/service.rb, line 77 def token(google_identity_sts_v1_exchange_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/token', options) command.request_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenRequest::Representation command.request_object = google_identity_sts_v1_exchange_token_request_object command.response_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse::Representation command.response_class = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File lib/google/apis/sts_v1/service.rb, line 90 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end