Class: Aws::VerifiedPermissions::Types::CognitoUserPoolConfigurationItem
- Inherits:
-
Struct
- Object
- Struct
- Aws::VerifiedPermissions::Types::CognitoUserPoolConfigurationItem
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-verifiedpermissions/types.rb
Overview
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of the
- ConfigurationItem][1
-
structure that is part of the response to
Example:‘“CognitoUserPoolConfiguration”:[“a1b2c3d4e5f6g7h8i9j0kalbmc”],“groupConfiguration”: {“groupEntityType”: “MyCorp::Group”}`
[1]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html [2]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
Constant Summary collapse
- SENSITIVE =
[:client_ids]
Instance Attribute Summary collapse
-
#client_ids ⇒ Array<String>
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
-
#group_configuration ⇒ Types::CognitoGroupConfigurationItem
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
-
#issuer ⇒ String
The OpenID Connect (OIDC) ‘issuer` ID of the Amazon Cognito user pool that contains the identities to be authorized.
-
#user_pool_arn ⇒ String
The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be authorized.
Instance Attribute Details
#client_ids ⇒ Array<String>
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: ‘“clientIds”: [“&ExampleCogClientId;”]`
815 816 817 818 819 820 821 822 |
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 815 class CognitoUserPoolConfigurationItem < Struct.new( :user_pool_arn, :client_ids, :issuer, :group_configuration) SENSITIVE = [:client_ids] include Aws::Structure end |
#group_configuration ⇒ Types::CognitoGroupConfigurationItem
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
815 816 817 818 819 820 821 822 |
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 815 class CognitoUserPoolConfigurationItem < Struct.new( :user_pool_arn, :client_ids, :issuer, :group_configuration) SENSITIVE = [:client_ids] include Aws::Structure end |
#issuer ⇒ String
The OpenID Connect (OIDC) ‘issuer` ID of the Amazon Cognito user pool that contains the identities to be authorized.
Example: ‘“issuer”: “cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5”`
815 816 817 818 819 820 821 822 |
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 815 class CognitoUserPoolConfigurationItem < Struct.new( :user_pool_arn, :client_ids, :issuer, :group_configuration) SENSITIVE = [:client_ids] include Aws::Structure end |
#user_pool_arn ⇒ String
The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be authorized.
Example: ‘“userPoolArn”: “arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5”`
[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
815 816 817 818 819 820 821 822 |
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 815 class CognitoUserPoolConfigurationItem < Struct.new( :user_pool_arn, :client_ids, :issuer, :group_configuration) SENSITIVE = [:client_ids] include Aws::Structure end |