AppFabric / Client / connect_app_authorization

connect_app_authorization#

AppFabric.Client.connect_app_authorization(**kwargs)#

Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.

See also: AWS API Documentation

Request Syntax

response = client.connect_app_authorization(
    appBundleIdentifier='string',
    appAuthorizationIdentifier='string',
    authRequest={
        'redirectUri': 'string',
        'code': 'string'
    }
)
Parameters:

  • appBundleIdentifier (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization 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.

  • authRequest (dict) –

    Contains OAuth2 authorization information.

    This is required if the app authorization for the request is configured with an OAuth2 ( oauth2) authorization type.

    • redirectUri (string) – [REQUIRED]

      The redirect URL that is specified in the AuthURL and the application client.

    • code (string) – [REQUIRED]

      The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL).

Return type:

dict

Returns:

Response Syntax

{
    'appAuthorizationSummary': {
        'appAuthorizationArn': 'string',
        'appBundleArn': 'string',
        'app': 'string',
        'tenant': {
            'tenantIdentifier': 'string',
            'tenantDisplayName': 'string'
        },
        'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed',
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • appAuthorizationSummary (dict) –

      Contains a summary of the 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.

      • 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.

      • updatedAt (datetime) –

        Timestamp for when the app authorization was last updated.

Exceptions