Skip to content

AuthConfig

Used by
Source code in docs_src/capo_appintegrations/types/auth_config.py 
13
14
15
16
17
18
19
class AuthConfig(TypedDict, closed=True):
    auth_type: NotRequired["capo_appintegrations.types.auth_type.AuthType"]
    """<p>The type of authentication that Connect Customer uses to call the external application endpoint. You must specify an authentication type for <code>A2A_SERVER</code> applications. Valid values:</p> <ul> <li> <p> <code>API_KEY</code>: Connect Customer sends an API key that is stored in the Secrets Manager secret that you specify in <code>CredentialProviderIdentifier</code>.</p> </li> <li> <p> <code>CONNECT_JWT</code>: Connect Customer issues a short-lived, signed JSON Web Token (JWT). This authentication type doesn't require a stored credential.</p> </li> </ul>"""
    credential_provider_identifier: NotRequired["capo_appintegrations.types.arn.Arn"]
    """<p>The ARN of the Secrets Manager secret that stores the credentials. The secret must be accessible to Connect Customer.</p> <p>You must specify this ARN when <code>AuthType</code> is <code>API_KEY</code>. Don't specify it when <code>AuthType</code> is <code>CONNECT_JWT</code>.</p>"""
    audience_override: NotRequired["capo_appintegrations.types.identifier.Identifier"]
    """<p>The value that Connect Customer uses as the audience (<code>aud</code>) claim of the JSON Web Token (JWT) that it issues. You can specify this parameter only when <code>AuthType</code> is <code>CONNECT_JWT</code>. If you don't specify it, the audience is the <code>AccessUrl</code> of the application. The value can't contain <code>connect.amazonaws.com</code>.</p>"""

audience_override instance-attribute 

audience_override: NotRequired[Identifier]

The value that Connect Customer uses as the audience (aud) claim of the JSON Web Token (JWT) that it issues. You can specify this parameter only when AuthType is CONNECT_JWT. If you don't specify it, the audience is the AccessUrl of the application. The value can't contain connect.amazonaws.com.

auth_type instance-attribute 

auth_type: NotRequired[AuthType]

The type of authentication that Connect Customer uses to call the external application endpoint. You must specify an authentication type for A2A_SERVER applications. Valid values:

  • API_KEY: Connect Customer sends an API key that is stored in the Secrets Manager secret that you specify in CredentialProviderIdentifier.

  • CONNECT_JWT: Connect Customer issues a short-lived, signed JSON Web Token (JWT). This authentication type doesn't require a stored credential.

credential_provider_identifier instance-attribute 

credential_provider_identifier: NotRequired[Arn]

The ARN of the Secrets Manager secret that stores the credentials. The secret must be accessible to Connect Customer.

You must specify this ARN when AuthType is API_KEY. Don't specify it when AuthType is CONNECT_JWT.