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

NAME

Paws::SSOOidc - Perl Interface to AWS AWS SSO OIDC

SYNOPSIS

use Paws;

my $obj = Paws->service('SSOOidc');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628 (https://tools.ietf.org/html/rfc8628)).

For general information about AWS SSO, see What is AWS Single Sign-On? (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) in the AWS SSO User Guide.

This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/oidc-2019-06-10

METHODS

CreateToken

ClientId => Str
ClientSecret => Str
DeviceCode => Str
GrantType => Str
[Code => Str]
[RedirectUri => Str]
[RefreshToken => Str]
[Scope => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SSOOidc::CreateToken

Returns: a Paws::SSOOidc::CreateTokenResponse instance

Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.

RegisterClient

ClientName => Str
ClientType => Str
[Scopes => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SSOOidc::RegisterClient

Returns: a Paws::SSOOidc::RegisterClientResponse instance

Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

StartDeviceAuthorization

ClientId => Str
ClientSecret => Str
StartUrl => Str

Each argument is described in detail in: Paws::SSOOidc::StartDeviceAuthorization

Returns: a Paws::SSOOidc::StartDeviceAuthorizationResponse instance

Initiates device authorization by requesting a pair of verification codes from the authorization service.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

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