This product is not supported for your selected Datadog site. ().
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_verifiedpermissions_identity_source

account_id

Type: STRING

configuration

Type: STRUCT
Provider name: configuration
Description: Contains configuration information about an identity source.

  • cognito_user_pool_configuration
    Type: STRUCT
    Provider name: cognitoUserPoolConfiguration
    Description: Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs. Example: “configuration”:{“cognitoUserPoolConfiguration”:{“userPoolArn”:“arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5”,“clientIds”: [“a1b2c3d4e5f6g7h8i9j0kalbmc”],“groupConfiguration”: {“groupEntityType”: “MyCorp::Group”}}}
    • client_ids
      Type: UNORDERED_LIST_STRING
      Provider name: clientIds
      Description: The unique application client IDs that are associated with the specified Amazon Cognito user pool. Example: “clientIds”: ["&ExampleCogClientId;"]
    • group_configuration
      Type: STRUCT
      Provider name: groupConfiguration
      Description: The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
      • group_entity_type
        Type: STRING
        Provider name: groupEntityType
        Description: The name of the schema entity type that’s mapped to the user pool group. Defaults to AWS::CognitoGroup.
    • issuer
      Type: STRING
      Provider name: issuer
      Description: The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized. Example: “issuer”: “https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"
    • user_pool_arn
      Type: STRING
      Provider name: userPoolArn
      Description: 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”
  • open_id_connect_configuration
    Type: STRUCT
    Provider name: openIdConnectConfiguration
    Description: Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. Example:“configuration”:{“openIdConnectConfiguration”:{“issuer”:“https://auth.example.com”,“tokenSelection”:{“accessTokenOnly”:{“audiences”:[“https://myapp.example.com”,“https://myapp2.example.com”],“principalIdClaim”:“sub”}},“entityIdPrefix”:“MyOIDCProvider”,“groupConfiguration”:{“groupClaim”:“groups”,“groupEntityType”:“MyCorp::UserGroup”}}}
    • entity_id_prefix
      Type: STRING
      Provider name: entityIdPrefix
      Description: A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.
    • group_configuration
      Type: STRUCT
      Provider name: groupConfiguration
      Description: The claim in OIDC identity provider tokens that indicates a user’s group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
      • group_claim
        Type: STRING
        Provider name: groupClaim
        Description: The token claim that you want Verified Permissions to interpret as group membership. For example, groups.
      • group_entity_type
        Type: STRING
        Provider name: groupEntityType
        Description: The policy store entity type that you want to map your users’ group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.
    • issuer
      Type: STRING
      Provider name: issuer
      Description: The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.
    • token_selection
      Type: STRUCT
      Provider name: tokenSelection
      Description: The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
      • access_token_only
        Type: STRUCT
        Provider name: accessTokenOnly
        Description: The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.
        • audiences
          Type: UNORDERED_LIST_STRING
          Provider name: audiences
          Description: The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.
        • principal_id_claim
          Type: STRING
          Provider name: principalIdClaim
          Description: The claim that determines the principal in OIDC access tokens. For example, sub.
      • identity_token_only
        Type: STRUCT
        Provider name: identityTokenOnly
        Description: The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.
        • client_ids
          Type: UNORDERED_LIST_STRING
          Provider name: clientIds
          Description: The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.
        • principal_id_claim
          Type: STRING
          Provider name: principalIdClaim
          Description: The claim that determines the principal in OIDC access tokens. For example, sub.

created_date

Type: TIMESTAMP
Provider name: createdDate
Description: The date and time the identity source was originally created.

details

Type: STRUCT
Provider name: details
Description: A structure that contains the details of the associated identity provider (IdP).

  • client_ids
    Type: UNORDERED_LIST_STRING
    Provider name: clientIds
    Description: The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.
  • discovery_url
    Type: STRING
    Provider name: discoveryUrl
    Description: 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. https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration
  • open_id_issuer
    Type: STRING
    Provider name: openIdIssuer
    Description: A string that identifies the type of OIDC service represented by this identity source. At this time, the only valid value is cognito.
  • user_pool_arn
    Type: STRING
    Provider name: userPoolArn
    Description: The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

identity_source_id

Type: STRING
Provider name: identitySourceId
Description: The unique identifier of the identity source.

last_updated_date

Type: TIMESTAMP
Provider name: lastUpdatedDate
Description: The date and time the identity source was most recently updated.

policy_store_id

Type: STRING
Provider name: policyStoreId
Description: The identifier of the policy store that contains the identity source.

principal_entity_type

Type: STRING
Provider name: principalEntityType
Description: The Cedar entity type of the principals returned from the IdP associated with this identity source.

tags

Type: UNORDERED_LIST_STRING