SSOAdmin / Client / list_application_authentication_methods

list_application_authentication_methods#

SSOAdmin.Client.list_application_authentication_methods(**kwargs)#

Lists all of the authentication methods supported by the specified application.

See also: AWS API Documentation

Request Syntax

response = client.list_application_authentication_methods(
    ApplicationArn='string',
    NextToken='string'
)
Parameters:

  • ApplicationArn (string) –

    [REQUIRED]

    Specifies the ARN of the application with the authentication methods you want to list.

  • NextToken (string) – Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s NextToken response to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationMethods': [
        {
            'AuthenticationMethod': {
                'Iam': {
                    'ActorPolicy': {...}|[...]|123|123.4|'string'|True|None
                }
            },
            'AuthenticationMethodType': 'IAM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AuthenticationMethods (list) –

      An array list of authentication methods for the specified application.

      • (dict) –

        A structure that describes an authentication method and its type.

        • AuthenticationMethod (dict) –

          A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: Iam. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • Iam (dict) –

            A structure that describes details for IAM authentication.

            • ActorPolicy (document) –

              An IAM policy document in JSON.

        • AuthenticationMethodType (string) –

          The type of authentication that is used by this method.

    • NextToken (string) –

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException