« blib/lib/Paws/SSOOidc/CreateTokenResponse.pm
↑ Summary
blib/lib/Paws/SSOOidc/RegisterClientResponse.pm »
| 1 | |||
| 2 | package Paws::SSOOidc::RegisterClient; | ||
| 3 | use Moose; | ||
| 4 | has ClientName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientName', required => 1); | ||
| 5 | has ClientType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientType', required => 1); | ||
| 6 | has Scopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'scopes'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterClient'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/client/register'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSOOidc::RegisterClientResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::SSOOidc::RegisterClient - Arguments for method RegisterClient on L<Paws::SSOOidc> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method RegisterClient on the | ||
| 25 | L<AWS SSO OIDC|Paws::SSOOidc> service. Use the attributes of this class | ||
| 26 | as arguments to method RegisterClient. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterClient. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $oidc = Paws->service('SSOOidc'); | ||
| 33 | my $RegisterClientResponse = $oidc->RegisterClient( | ||
| 34 | ClientName => 'MyClientName', | ||
| 35 | ClientType => 'MyClientType', | ||
| 36 | Scopes => [ 'MyScope', ... ], # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $AuthorizationEndpoint = $RegisterClientResponse->AuthorizationEndpoint; | ||
| 41 | my $ClientId = $RegisterClientResponse->ClientId; | ||
| 42 | my $ClientIdIssuedAt = $RegisterClientResponse->ClientIdIssuedAt; | ||
| 43 | my $ClientSecret = $RegisterClientResponse->ClientSecret; | ||
| 44 | my $ClientSecretExpiresAt = $RegisterClientResponse->ClientSecretExpiresAt; | ||
| 45 | my $TokenEndpoint = $RegisterClientResponse->TokenEndpoint; | ||
| 46 | |||
| 47 | # Returns a L<Paws::SSOOidc::RegisterClientResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/oidc/RegisterClient> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> ClientName => Str | ||
| 56 | |||
| 57 | The friendly name of the client. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> ClientType => Str | ||
| 62 | |||
| 63 | The type of client. The service supports only C<public> as a client | ||
| 64 | type. Anything other than public will be rejected by the service. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Scopes => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | The list of scopes that are defined by the client. Upon authorization, | ||
| 71 | this list is used to restrict permissions when granting an access | ||
| 72 | token. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method RegisterClient in L<Paws::SSOOidc> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |