Class: Aws::VerifiedPermissions::Types::IdentitySourceDetails

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-verifiedpermissions/types.rb

Overview

A structure that contains configuration of the identity source.

This data type was a response parameter for the [GetIdentitySource] operation. Replaced by [ConfigurationDetail].

[1]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html [2]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html

Constant Summary collapse

SENSITIVE =
[:client_ids]

Instance Attribute Summary collapse

Instance Attribute Details

#client_idsArray<String>

The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

Returns:

  • (Array<String>)


2035
2036
2037
2038
2039
2040
2041
2042
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2035

class IdentitySourceDetails < Struct.new(
  :client_ids,
  :user_pool_arn,
  :discovery_url,
  :open_id_issuer)
  SENSITIVE = [:client_ids]
  include Aws::Structure
end

#discovery_urlString

The well-known URL that points to this user pool’s OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration`

Returns:

  • (String)


2035
2036
2037
2038
2039
2040
2041
2042
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2035

class IdentitySourceDetails < Struct.new(
  :client_ids,
  :user_pool_arn,
  :discovery_url,
  :open_id_issuer)
  SENSITIVE = [:client_ids]
  include Aws::Structure
end

#open_id_issuerString

A string that identifies the type of OIDC service represented by this identity source.

At this time, the only valid value is ‘cognito`.

Returns:

  • (String)


2035
2036
2037
2038
2039
2040
2041
2042
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2035

class IdentitySourceDetails < Struct.new(
  :client_ids,
  :user_pool_arn,
  :discovery_url,
  :open_id_issuer)
  SENSITIVE = [:client_ids]
  include Aws::Structure
end

#user_pool_arnString

The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String)


2035
2036
2037
2038
2039
2040
2041
2042
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2035

class IdentitySourceDetails < Struct.new(
  :client_ids,
  :user_pool_arn,
  :discovery_url,
  :open_id_issuer)
  SENSITIVE = [:client_ids]
  include Aws::Structure
end