AppFabric / Client / get_app_authorization

get_app_authorization

AppFabric.Client.get_app_authorization(**kwargs)

Returns information about an app authorization.

See also: AWS API Documentation

Request Syntax

response = client.get_app_authorization(
    appBundleIdentifier='string',
    appAuthorizationIdentifier='string'
)

Parameters:

• appBundleIdentifier (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

• appAuthorizationIdentifier (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

Return type:

dict

Returns:

Response Syntax

{
    'appAuthorization': {
        'appAuthorizationArn': 'string',
        'appBundleArn': 'string',
        'app': 'string',
        'tenant': {
            'tenantIdentifier': 'string',
            'tenantDisplayName': 'string'
        },
        'authType': 'oauth2'|'apiKey',
        'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'persona': 'admin'|'endUser',
        'authUrl': 'string'
    }
}

Response Structure

• (dict) –

  • appAuthorization (dict) –

    Contains information about an app authorization.

    • appAuthorizationArn (string) –

      The Amazon Resource Name (ARN) of the app authorization.

    • appBundleArn (string) –

      The Amazon Resource Name (ARN) of the app bundle for the app authorization.

    • app (string) –

      The name of the application.

    • tenant (dict) –

      Contains information about an application tenant, such as the application display name and identifier.

      • tenantIdentifier (string) –

        The ID of the application tenant.

      • tenantDisplayName (string) –

        The display name of the tenant.

    • authType (string) –

      The authorization type.

    • status (string) –

      The state of the app authorization.

      The following states are possible:

      • PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

      • Connected: The app authorization is connected to the application, and is ready to be used.

      • ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

      • TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

    • createdAt (datetime) –

      The timestamp of when the app authorization was created.

    • updatedAt (datetime) –

      The timestamp of when the app authorization was last updated.

    • persona (string) –

      The user persona of the app authorization.

      This field should always be admin.

    • authUrl (string) –

      The application URL for the OAuth flow.

Exceptions

• AppFabric.Client.exceptions.InternalServerException

• AppFabric.Client.exceptions.ThrottlingException

• AppFabric.Client.exceptions.ValidationException

• AppFabric.Client.exceptions.ResourceNotFoundException

• AppFabric.Client.exceptions.AccessDeniedException