2024/06/07 - Amazon Verified Permissions - 4 updated api methods
Changes This release adds OpenIdConnect (OIDC) configuration support for IdentitySources, allowing for external IDPs to be used in authorization requests.
{'configuration': {'openIdConnectConfiguration': {'entityIdPrefix': 'string',
'groupConfiguration': {'groupClaim': 'string',
'groupEntityType': 'string'},
'issuer': 'string',
'tokenSelection': {'accessTokenOnly': {'audiences': ['string'],
'principalIdClaim': 'string'},
'identityTokenOnly': {'clientIds': ['string'],
'principalIdClaim': 'string'}}}}}
Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action context to your policies, and ID tokens provide principal Attributes .
Warning
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
Note
To reference a user from this identity source in your Cedar policies, refer to the following syntax examples.
Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user principal attribute] , for example MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 .
OpenID Connect (OIDC) provider: Namespace::[Entity type]::[principalIdClaim]|[user principal attribute] , for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 .
Note
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
See also: AWS API Documentation
Request Syntax
client.create_identity_source(
clientToken='string',
policyStoreId='string',
configuration={
'cognitoUserPoolConfiguration': {
'userPoolArn': 'string',
'clientIds': [
'string',
],
'groupConfiguration': {
'groupEntityType': 'string'
}
},
'openIdConnectConfiguration': {
'issuer': 'string',
'entityIdPrefix': 'string',
'groupConfiguration': {
'groupClaim': 'string',
'groupEntityType': 'string'
},
'tokenSelection': {
'accessTokenOnly': {
'principalIdClaim': 'string',
'audiences': [
'string',
]
},
'identityTokenOnly': {
'principalIdClaim': 'string',
'clientIds': [
'string',
]
}
}
}
},
principalEntityType='string'
)
string
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken , but with different parameters, the retry fails with an ConflictException error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken .
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.
dict
[REQUIRED]
Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: cognitoUserPoolConfiguration, openIdConnectConfiguration.
cognitoUserPoolConfiguration (dict) --
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 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"}}}
userPoolArn (string) -- [REQUIRED]
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"
clientIds (list) --
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "ClientIds": ["&ExampleCogClientId;"]
(string) --
groupConfiguration (dict) --
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
groupEntityType (string) -- [REQUIRED]
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup .
openIdConnectConfiguration (dict) --
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"}}}
issuer (string) -- [REQUIRED]
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration .
entityIdPrefix (string) --
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 .
groupConfiguration (dict) --
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 .
groupClaim (string) -- [REQUIRED]
The token claim that you want Verified Permissions to interpret as group membership. For example, groups .
groupEntityType (string) -- [REQUIRED]
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.
tokenSelection (dict) -- [REQUIRED]
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: accessTokenOnly, identityTokenOnly.
accessTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
audiences (list) --
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 .
(string) --
identityTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
clientIds (list) --
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 .
(string) --
string
Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.
dict
Response Syntax
{
'createdDate': datetime(2015, 1, 1),
'identitySourceId': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'policyStoreId': 'string'
}
Response Structure
(dict) --
createdDate (datetime) --
The date and time the identity source was originally created.
identitySourceId (string) --
The unique ID of the new identity source.
lastUpdatedDate (datetime) --
The date and time the identity source was most recently updated.
policyStoreId (string) --
The ID of the policy store that contains the identity source.
{'configuration': {'openIdConnectConfiguration': {'entityIdPrefix': 'string',
'groupConfiguration': {'groupClaim': 'string',
'groupEntityType': 'string'},
'issuer': 'string',
'tokenSelection': {'accessTokenOnly': {'audiences': ['string'],
'principalIdClaim': 'string'},
'identityTokenOnly': {'clientIds': ['string'],
'principalIdClaim': 'string'}}}}}
Retrieves the details about the specified identity source.
See also: AWS API Documentation
Request Syntax
client.get_identity_source(
policyStoreId='string',
identitySourceId='string'
)
string
[REQUIRED]
Specifies the ID of the policy store that contains the identity source you want information about.
string
[REQUIRED]
Specifies the ID of the identity source you want information about.
dict
Response Syntax
{
'createdDate': datetime(2015, 1, 1),
'details': {
'clientIds': [
'string',
],
'userPoolArn': 'string',
'discoveryUrl': 'string',
'openIdIssuer': 'COGNITO'
},
'identitySourceId': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'policyStoreId': 'string',
'principalEntityType': 'string',
'configuration': {
'cognitoUserPoolConfiguration': {
'userPoolArn': 'string',
'clientIds': [
'string',
],
'issuer': 'string',
'groupConfiguration': {
'groupEntityType': 'string'
}
},
'openIdConnectConfiguration': {
'issuer': 'string',
'entityIdPrefix': 'string',
'groupConfiguration': {
'groupClaim': 'string',
'groupEntityType': 'string'
},
'tokenSelection': {
'accessTokenOnly': {
'principalIdClaim': 'string',
'audiences': [
'string',
]
},
'identityTokenOnly': {
'principalIdClaim': 'string',
'clientIds': [
'string',
]
}
}
}
}
}
Response Structure
(dict) --
createdDate (datetime) --
The date and time that the identity source was originally created.
details (dict) --
A structure that describes the configuration of the identity source.
clientIds (list) --
The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.
(string) --
userPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.
discoveryUrl (string) --
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
openIdIssuer (string) --
A string that identifies the type of OIDC service represented by this identity source.
At this time, the only valid value is cognito .
identitySourceId (string) --
The ID of the identity source.
lastUpdatedDate (datetime) --
The date and time that the identity source was most recently updated.
policyStoreId (string) --
The ID of the policy store that contains the identity source.
principalEntityType (string) --
The data type of principals generated for identities authenticated by this identity source.
configuration (dict) --
Contains configuration information about an identity source.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: cognitoUserPoolConfiguration, openIdConnectConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
cognitoUserPoolConfiguration (dict) --
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"}}}
userPoolArn (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"
clientIds (list) --
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "clientIds": ["&ExampleCogClientId;"]
(string) --
issuer (string) --
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"
groupConfiguration (dict) --
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
groupEntityType (string) --
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup .
openIdConnectConfiguration (dict) --
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"}}}
issuer (string) --
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration .
entityIdPrefix (string) --
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 .
groupConfiguration (dict) --
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 .
groupClaim (string) --
The token claim that you want Verified Permissions to interpret as group membership. For example, groups .
groupEntityType (string) --
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.
tokenSelection (dict) --
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: accessTokenOnly, identityTokenOnly. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
accessTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
audiences (list) --
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 .
(string) --
identityTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
clientIds (list) --
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 .
(string) --
{'identitySources': {'configuration': {'openIdConnectConfiguration': {'entityIdPrefix': 'string',
'groupConfiguration': {'groupClaim': 'string',
'groupEntityType': 'string'},
'issuer': 'string',
'tokenSelection': {'accessTokenOnly': {'audiences': ['string'],
'principalIdClaim': 'string'},
'identityTokenOnly': {'clientIds': ['string'],
'principalIdClaim': 'string'}}}}}}
Returns a paginated list of all of the identity sources defined in the specified policy store.
See also: AWS API Documentation
Request Syntax
client.list_identity_sources(
policyStoreId='string',
nextToken='string',
maxResults=123,
filters=[
{
'principalEntityType': 'string'
},
]
)
string
[REQUIRED]
Specifies the ID of the policy store that contains the identity sources that you want to list.
string
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
integer
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 50 identity sources per response.
list
Specifies characteristics of an identity source that you can use to limit the output to matching identity sources.
(dict) --
A structure that defines characteristics of an identity source that you can use to filter.
This data type is a request parameter for the ListIdentityStores operation.
principalEntityType (string) --
The Cedar entity type of the principals returned by the identity provider (IdP) associated with this identity source.
dict
Response Syntax
{
'nextToken': 'string',
'identitySources': [
{
'createdDate': datetime(2015, 1, 1),
'details': {
'clientIds': [
'string',
],
'userPoolArn': 'string',
'discoveryUrl': 'string',
'openIdIssuer': 'COGNITO'
},
'identitySourceId': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'policyStoreId': 'string',
'principalEntityType': 'string',
'configuration': {
'cognitoUserPoolConfiguration': {
'userPoolArn': 'string',
'clientIds': [
'string',
],
'issuer': 'string',
'groupConfiguration': {
'groupEntityType': 'string'
}
},
'openIdConnectConfiguration': {
'issuer': 'string',
'entityIdPrefix': 'string',
'groupConfiguration': {
'groupClaim': 'string',
'groupEntityType': 'string'
},
'tokenSelection': {
'accessTokenOnly': {
'principalIdClaim': 'string',
'audiences': [
'string',
]
},
'identityTokenOnly': {
'principalIdClaim': 'string',
'clientIds': [
'string',
]
}
}
}
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null . This indicates that this is the last page of results.
identitySources (list) --
The list of identity sources stored in the specified policy store.
(dict) --
A structure that defines an identity source.
This data type is a response parameter to the ListIdentitySources operation.
createdDate (datetime) --
The date and time the identity source was originally created.
details (dict) --
A structure that contains the details of the associated identity provider (IdP).
clientIds (list) --
The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.
(string) --
userPoolArn (string) --
The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.
discoveryUrl (string) --
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
openIdIssuer (string) --
A string that identifies the type of OIDC service represented by this identity source.
At this time, the only valid value is cognito .
identitySourceId (string) --
The unique identifier of the identity source.
lastUpdatedDate (datetime) --
The date and time the identity source was most recently updated.
policyStoreId (string) --
The identifier of the policy store that contains the identity source.
principalEntityType (string) --
The Cedar entity type of the principals returned from the IdP associated with this identity source.
configuration (dict) --
Contains configuration information about an identity source.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: cognitoUserPoolConfiguration, openIdConnectConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
cognitoUserPoolConfiguration (dict) --
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"}}}
userPoolArn (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"
clientIds (list) --
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: "clientIds": ["&ExampleCogClientId;"]
(string) --
issuer (string) --
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"
groupConfiguration (dict) --
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
groupEntityType (string) --
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup .
openIdConnectConfiguration (dict) --
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"}}}
issuer (string) --
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration .
entityIdPrefix (string) --
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 .
groupConfiguration (dict) --
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 .
groupClaim (string) --
The token claim that you want Verified Permissions to interpret as group membership. For example, groups .
groupEntityType (string) --
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.
tokenSelection (dict) --
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: accessTokenOnly, identityTokenOnly. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
accessTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
audiences (list) --
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 .
(string) --
identityTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
clientIds (list) --
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 .
(string) --
{'updateConfiguration': {'openIdConnectConfiguration': {'entityIdPrefix': 'string',
'groupConfiguration': {'groupClaim': 'string',
'groupEntityType': 'string'},
'issuer': 'string',
'tokenSelection': {'accessTokenOnly': {'audiences': ['string'],
'principalIdClaim': 'string'},
'identityTokenOnly': {'clientIds': ['string'],
'principalIdClaim': 'string'}}}}}
Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.
Note
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
See also: AWS API Documentation
Request Syntax
client.update_identity_source(
policyStoreId='string',
identitySourceId='string',
updateConfiguration={
'cognitoUserPoolConfiguration': {
'userPoolArn': 'string',
'clientIds': [
'string',
],
'groupConfiguration': {
'groupEntityType': 'string'
}
},
'openIdConnectConfiguration': {
'issuer': 'string',
'entityIdPrefix': 'string',
'groupConfiguration': {
'groupClaim': 'string',
'groupEntityType': 'string'
},
'tokenSelection': {
'accessTokenOnly': {
'principalIdClaim': 'string',
'audiences': [
'string',
]
},
'identityTokenOnly': {
'principalIdClaim': 'string',
'clientIds': [
'string',
]
}
}
}
},
principalEntityType='string'
)
string
[REQUIRED]
Specifies the ID of the policy store that contains the identity source that you want to update.
string
[REQUIRED]
Specifies the ID of the identity source that you want to update.
dict
[REQUIRED]
Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
Note
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
You must specify a userPoolArn , and optionally, a ClientId .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: cognitoUserPoolConfiguration, openIdConnectConfiguration.
cognitoUserPoolConfiguration (dict) --
Contains configuration details of a Amazon Cognito user pool.
userPoolArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.
clientIds (list) --
The client ID of an app client that is configured for the specified Amazon Cognito user pool.
(string) --
groupConfiguration (dict) --
The configuration of the user groups from an Amazon Cognito user pool identity source.
groupEntityType (string) -- [REQUIRED]
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup .
openIdConnectConfiguration (dict) --
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.
issuer (string) -- [REQUIRED]
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration .
entityIdPrefix (string) --
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 .
groupConfiguration (dict) --
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 .
groupClaim (string) -- [REQUIRED]
The token claim that you want Verified Permissions to interpret as group membership. For example, groups .
groupEntityType (string) -- [REQUIRED]
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.
tokenSelection (dict) -- [REQUIRED]
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: accessTokenOnly, identityTokenOnly.
accessTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
audiences (list) --
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 .
(string) --
identityTokenOnly (dict) --
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 .
principalIdClaim (string) --
The claim that determines the principal in OIDC access tokens. For example, sub .
clientIds (list) --
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 .
(string) --
string
Specifies the data type of principals generated for identities authenticated by the identity source.
dict
Response Syntax
{
'createdDate': datetime(2015, 1, 1),
'identitySourceId': 'string',
'lastUpdatedDate': datetime(2015, 1, 1),
'policyStoreId': 'string'
}
Response Structure
(dict) --
createdDate (datetime) --
The date and time that the updated identity source was originally created.
identitySourceId (string) --
The ID of the updated identity source.
lastUpdatedDate (datetime) --
The date and time that the identity source was most recently updated.
policyStoreId (string) --
The ID of the policy store that contains the updated identity source.