Class: Aws::AppIntegrationsService::Types::AuthConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appintegrationsservice/lib/aws-sdk-appintegrationsservice/types.rb

Overview

Contains the authentication settings that Connect Customer uses to call an external application endpoint.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audience_override ⇒ String

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.

Returns:

  • (String) 


163
164
165
166
167
168
169
 
# File 'gems/aws-sdk-appintegrationsservice/lib/aws-sdk-appintegrationsservice/types.rb', line 163

class AuthConfig < Struct.new(
  :auth_type,
  :credential_provider_identifier,
  :audience_override)
  SENSITIVE = []
  include Aws::Structure
end

#auth_type ⇒ String

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.

Returns:

  • (String) 


163
164
165
166
167
168
169
 
# File 'gems/aws-sdk-appintegrationsservice/lib/aws-sdk-appintegrationsservice/types.rb', line 163

class AuthConfig < Struct.new(
  :auth_type,
  :credential_provider_identifier,
  :audience_override)
  SENSITIVE = []
  include Aws::Structure
end

#credential_provider_identifier ⇒ String

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.

Returns:

  • (String) 


163
164
165
166
167
168
169
 
# File 'gems/aws-sdk-appintegrationsservice/lib/aws-sdk-appintegrationsservice/types.rb', line 163

class AuthConfig < Struct.new(
  :auth_type,
  :credential_provider_identifier,
  :audience_override)
  SENSITIVE = []
  include Aws::Structure
end