| 1 | package Paws::SSOOidc; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'oidc' } | ||
| 4 | sub signing_name { 'awsssooidc' } | ||
| 5 | sub version { '2019-06-10' } | ||
| 6 | sub flattened_arrays { 0 } | ||
| 7 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 8 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 9 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 10 | }); | ||
| 11 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 12 | ] }); | ||
| 13 | |||
| 14 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller'; | ||
| 15 | |||
| 16 | |||
| 17 | sub CreateToken { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::SSOOidc::CreateToken', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub RegisterClient { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::SSOOidc::RegisterClient', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub StartDeviceAuthorization { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::SSOOidc::StartDeviceAuthorization', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | |||
| 33 | |||
| 34 | |||
| 35 | sub operations { qw/CreateToken RegisterClient StartDeviceAuthorization / } | ||
| 36 | |||
| 37 | 1; | ||
| 38 | |||
| 39 | ### main pod documentation begin ### | ||
| 40 | |||
| 41 | =head1 NAME | ||
| 42 | |||
| 43 | Paws::SSOOidc - Perl Interface to AWS AWS SSO OIDC | ||
| 44 | |||
| 45 | =head1 SYNOPSIS | ||
| 46 | |||
| 47 | use Paws; | ||
| 48 | |||
| 49 | my $obj = Paws->service('SSOOidc'); | ||
| 50 | my $res = $obj->Method( | ||
| 51 | Arg1 => $val1, | ||
| 52 | Arg2 => [ 'V1', 'V2' ], | ||
| 53 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 54 | # of the arguments type | ||
| 55 | Arg3 => { Att1 => 'Val1' }, | ||
| 56 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 57 | # the constructor of the arguments type | ||
| 58 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 59 | ); | ||
| 60 | |||
| 61 | =head1 DESCRIPTION | ||
| 62 | |||
| 63 | AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that | ||
| 64 | enables a client (such as AWS CLI or a native application) to register | ||
| 65 | with AWS SSO. The service also enables the client to fetch the | ||
| 66 | userE<rsquo>s access token upon successful authentication and | ||
| 67 | authorization with AWS SSO. This service conforms with the OAuth 2.0 | ||
| 68 | based implementation of the device authorization grant standard | ||
| 69 | (https://tools.ietf.org/html/rfc8628 | ||
| 70 | (https://tools.ietf.org/html/rfc8628)). | ||
| 71 | |||
| 72 | For general information about AWS SSO, see What is AWS Single Sign-On? | ||
| 73 | (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) | ||
| 74 | in the I<AWS SSO User Guide>. | ||
| 75 | |||
| 76 | This API reference guide describes the AWS SSO OIDC operations that you | ||
| 77 | can call programatically and includes detailed information on data | ||
| 78 | types and errors. | ||
| 79 | |||
| 80 | AWS provides SDKs that consist of libraries and sample code for various | ||
| 81 | programming languages and platforms such as Java, Ruby, .Net, iOS, and | ||
| 82 | Android. The SDKs provide a convenient way to create programmatic | ||
| 83 | access to AWS SSO and other AWS services. For more information about | ||
| 84 | the AWS SDKs, including how to download and install them, see Tools for | ||
| 85 | Amazon Web Services (http://aws.amazon.com/tools/). | ||
| 86 | |||
| 87 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/oidc-2019-06-10> | ||
| 88 | |||
| 89 | |||
| 90 | =head1 METHODS | ||
| 91 | |||
| 92 | =head2 CreateToken | ||
| 93 | |||
| 94 | =over | ||
| 95 | |||
| 96 | =item ClientId => Str | ||
| 97 | |||
| 98 | =item ClientSecret => Str | ||
| 99 | |||
| 100 | =item DeviceCode => Str | ||
| 101 | |||
| 102 | =item GrantType => Str | ||
| 103 | |||
| 104 | =item [Code => Str] | ||
| 105 | |||
| 106 | =item [RedirectUri => Str] | ||
| 107 | |||
| 108 | =item [RefreshToken => Str] | ||
| 109 | |||
| 110 | =item [Scope => ArrayRef[Str|Undef]] | ||
| 111 | |||
| 112 | |||
| 113 | =back | ||
| 114 | |||
| 115 | Each argument is described in detail in: L<Paws::SSOOidc::CreateToken> | ||
| 116 | |||
| 117 | Returns: a L<Paws::SSOOidc::CreateTokenResponse> instance | ||
| 118 | |||
| 119 | Creates and returns an access token for the authorized client. The | ||
| 120 | access token issued will be used to fetch short-term credentials for | ||
| 121 | the assigned roles in the AWS account. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 RegisterClient | ||
| 125 | |||
| 126 | =over | ||
| 127 | |||
| 128 | =item ClientName => Str | ||
| 129 | |||
| 130 | =item ClientType => Str | ||
| 131 | |||
| 132 | =item [Scopes => ArrayRef[Str|Undef]] | ||
| 133 | |||
| 134 | |||
| 135 | =back | ||
| 136 | |||
| 137 | Each argument is described in detail in: L<Paws::SSOOidc::RegisterClient> | ||
| 138 | |||
| 139 | Returns: a L<Paws::SSOOidc::RegisterClientResponse> instance | ||
| 140 | |||
| 141 | Registers a client with AWS SSO. This allows clients to initiate device | ||
| 142 | authorization. The output should be persisted for reuse through many | ||
| 143 | authentication requests. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 StartDeviceAuthorization | ||
| 147 | |||
| 148 | =over | ||
| 149 | |||
| 150 | =item ClientId => Str | ||
| 151 | |||
| 152 | =item ClientSecret => Str | ||
| 153 | |||
| 154 | =item StartUrl => Str | ||
| 155 | |||
| 156 | |||
| 157 | =back | ||
| 158 | |||
| 159 | Each argument is described in detail in: L<Paws::SSOOidc::StartDeviceAuthorization> | ||
| 160 | |||
| 161 | Returns: a L<Paws::SSOOidc::StartDeviceAuthorizationResponse> instance | ||
| 162 | |||
| 163 | Initiates device authorization by requesting a pair of verification | ||
| 164 | codes from the authorization service. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head1 PAGINATORS | ||
| 170 | |||
| 171 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head1 SEE ALSO | ||
| 177 | |||
| 178 | This service class forms part of L<Paws> | ||
| 179 | |||
| 180 | =head1 BUGS and CONTRIBUTIONS | ||
| 181 | |||
| 182 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 183 | |||
| 184 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 185 | |||
| 186 | =cut | ||
| 187 |