Skip to content

AppAuthorization

Source code in docs_src/capo_appfabric/types/app_authorization.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class AppAuthorization(TypedDict, closed=True):
    app_authorization_arn: "capo_appfabric.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the app authorization.</p>"""
    app_bundle_arn: "capo_appfabric.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the app bundle for the app authorization.</p>"""
    app: "capo_appfabric.types.string255.String255"
    """<p>The name of the application.</p>"""
    tenant: "capo_appfabric.types.tenant.Tenant"
    """<p>Contains information about an application tenant, such as the application display name and identifier.</p>"""
    auth_type: "capo_appfabric.types.auth_type.AuthType"
    """<p>The authorization type.</p>"""
    status: "capo_appfabric.types.app_authorization_status.AppAuthorizationStatus"
    """<p>The state of the app authorization.</p> <p>The following states are possible:</p> <ul> <li> <p> <code>PendingConnect</code>: The initial state of the app authorization. The app authorization is created but not yet connected.</p> </li> <li> <p> <code>Connected</code>: The app authorization is connected to the application, and is ready to be used.</p> </li> <li> <p> <code>ConnectionValidationFailed</code>: 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.</p> </li> <li> <p> <code>TokenAutoRotationFailed</code>: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.</p> </li> </ul>"""
    created_at: "capo_appfabric.types.date_time.DateTime"
    """<p>The timestamp of when the app authorization was created.</p>"""
    updated_at: "capo_appfabric.types.date_time.DateTime"
    """<p>The timestamp of when the app authorization was last updated.</p>"""
    persona: NotRequired["capo_appfabric.types.persona.Persona"]
    """<p>The user persona of the app authorization.</p> <p>This field should always be <code>admin</code>.</p>"""
    auth_url: NotRequired["str"]
    """<p>The application URL for the OAuth flow.</p>"""

app instance-attribute 

app: String255

The name of the application.

app_authorization_arn instance-attribute 

app_authorization_arn: Arn

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

app_bundle_arn instance-attribute 

app_bundle_arn: Arn

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

auth_type instance-attribute 

auth_type: AuthType

The authorization type.

auth_url instance-attribute 

auth_url: NotRequired[str]

The application URL for the OAuth flow.

created_at instance-attribute 

created_at: DateTime

The timestamp of when the app authorization was created.

persona instance-attribute 

persona: NotRequired[Persona]

The user persona of the app authorization.

This field should always be admin.

status instance-attribute 

status: AppAuthorizationStatus

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.

tenant instance-attribute 

tenant: Tenant

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

updated_at instance-attribute 

updated_at: DateTime

The timestamp of when the app authorization was last updated.