| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Finspace::FederationParameters; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationCallBackURL => (is => 'ro', isa => 'Str', request_name => 'applicationCallBackURL', traits => ['NameInRequest']); | ||
| 5 | has AttributeMap => (is => 'ro', isa => 'Paws::Finspace::AttributeMap', request_name => 'attributeMap', traits => ['NameInRequest']); | ||
| 6 | has FederationProviderName => (is => 'ro', isa => 'Str', request_name => 'federationProviderName', traits => ['NameInRequest']); | ||
| 7 | has FederationURN => (is => 'ro', isa => 'Str', request_name => 'federationURN', traits => ['NameInRequest']); | ||
| 8 | has SamlMetadataDocument => (is => 'ro', isa => 'Str', request_name => 'samlMetadataDocument', traits => ['NameInRequest']); | ||
| 9 | has SamlMetadataURL => (is => 'ro', isa => 'Str', request_name => 'samlMetadataURL', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Finspace::FederationParameters | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Finspace::FederationParameters object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ApplicationCallBackURL => $value, ..., SamlMetadataURL => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Finspace::FederationParameters object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ApplicationCallBackURL | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Configuration information when authentication mode is FEDERATED. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ApplicationCallBackURL => Str | ||
| 47 | |||
| 48 | The redirect or sign-in URL that should be entered into the SAML 2.0 | ||
| 49 | compliant identity provider configuration (IdP). | ||
| 50 | |||
| 51 | |||
| 52 | =head2 AttributeMap => L<Paws::Finspace::AttributeMap> | ||
| 53 | |||
| 54 | SAML attribute name and value. The name must always be C<Email> and the | ||
| 55 | value should be set to the attribute definition in which user email is | ||
| 56 | set. For example, name would be C<Email> and value | ||
| 57 | C<http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress>. | ||
| 58 | Please check your SAML 2.0 compliant identity provider (IdP) | ||
| 59 | documentation for details. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 FederationProviderName => Str | ||
| 63 | |||
| 64 | Name of the identity provider (IdP). | ||
| 65 | |||
| 66 | |||
| 67 | =head2 FederationURN => Str | ||
| 68 | |||
| 69 | The Uniform Resource Name (URN). Also referred as Service Provider URN | ||
| 70 | or Audience URI or Service Provider Entity ID. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 SamlMetadataDocument => Str | ||
| 74 | |||
| 75 | SAML 2.0 Metadata document from identity provider (IdP). | ||
| 76 | |||
| 77 | |||
| 78 | =head2 SamlMetadataURL => Str | ||
| 79 | |||
| 80 | Provide the metadata URL from your SAML 2.0 compliant identity provider | ||
| 81 | (IdP). | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, describing an object used in L<Paws::Finspace> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |