/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SSOOidc::CreateToken

NAME

Paws::SSOOidc::CreateToken - Arguments for method CreateToken on Paws::SSOOidc

DESCRIPTION

This class represents the parameters used for calling the method CreateToken on the AWS SSO OIDC service. Use the attributes of this class as arguments to method CreateToken.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateToken.

SYNOPSIS

my $oidc = Paws->service('SSOOidc');
my $CreateTokenResponse = $oidc->CreateToken(
  ClientId     => 'MyClientId',
  ClientSecret => 'MyClientSecret',
  DeviceCode   => 'MyDeviceCode',
  GrantType    => 'MyGrantType',
  Code         => 'MyAuthCode',          # OPTIONAL
  RedirectUri  => 'MyURI',               # OPTIONAL
  RefreshToken => 'MyRefreshToken',      # OPTIONAL
  Scope        => [ 'MyScope', ... ],    # OPTIONAL
);

# Results:
my $AccessToken  = $CreateTokenResponse->AccessToken;
my $ExpiresIn    = $CreateTokenResponse->ExpiresIn;
my $IdToken      = $CreateTokenResponse->IdToken;
my $RefreshToken = $CreateTokenResponse->RefreshToken;
my $TokenType    = $CreateTokenResponse->TokenType;

# Returns a L<Paws::SSOOidc::CreateTokenResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/oidc/CreateToken

ATTRIBUTES

REQUIRED ClientId => Str

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

REQUIRED ClientSecret => Str

A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

Code => Str

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

REQUIRED DeviceCode => Str

Used only when calling this API for the device code grant type. This short-term code is used to identify this authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.

REQUIRED GrantType => Str

Supports grant types for authorization code, refresh token, and device code request.

RedirectUri => Str

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

RefreshToken => Str

The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

Scope => ArrayRef[Str|Undef]

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateToken in Paws::SSOOidc

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues