CreateIdentitySource
Creates a reference to an Amazon Cognito user pool as an external 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 operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies.
Important
If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
Note
To reference a user from this identity source in your Cedar policies, use the following syntax.
IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId>
Where IdentityType
is the string that you provide to the
PrincipalEntityType
parameter for this operation. The
CognitoUserPoolId
and CognitoClientId
are defined by
the Amazon Cognito user pool.
Note
Verified Permissions is
eventually consistent
Request Syntax
{
"clientToken": "string
",
"configuration": { ... },
"policyStoreId": "string
",
"principalEntityType": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- configuration
-
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, aClientId
.Type: Configuration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- policyStoreId
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-]*
Required: Yes
- clientToken
-
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 AWS generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anConflictException
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 ofClientToken
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]*
Required: No
- principalEntityType
-
Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
.*
Required: No
Response Syntax
{
"createdDate": "string",
"identitySourceId": "string",
"lastUpdatedDate": "string",
"policyStoreId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- createdDate
-
The date and time the identity source was originally created.
Type: Timestamp
- identitySourceId
-
The unique ID of the new identity source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-]*
- lastUpdatedDate
-
The date and time the identity source was most recently updated.
Type: Timestamp
- policyStoreId
-
The ID of the policy store that contains the identity source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action.
HTTP Status Code: 400
- ConflictException
-
The request failed because another request to modify a resource occurred at the same.
HTTP Status Code: 400
- InternalServerException
-
The request failed because of an internal error. Try your request again later
HTTP Status Code: 500
- ResourceNotFoundException
-
The request failed because it references a resource that doesn't exist.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
The request failed because it would cause a service quota to be exceeded.
HTTP Status Code: 400
- ThrottlingException
-
The request failed because it exceeded a throttling quota.
HTTP Status Code: 400
- ValidationException
-
The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.
The possible reasons include the following:
-
UnrecognizedEntityType
The policy includes an entity type that isn't found in the schema.
-
UnrecognizedActionId
The policy includes an action id that isn't found in the schema.
-
InvalidActionApplication
The policy includes an action that, according to the schema, doesn't support the specified principal and resource.
-
UnexpectedType
The policy included an operand that isn't a valid type for the specified operation.
-
IncompatibleTypes
The types of elements included in a
set
, or the types of expressions used in anif...then...else
clause aren't compatible in this context. -
MissingAttribute
The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator
in the Cedar Policy Language Guide. -
UnsafeOptionalAttributeAccess
The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator
in the Cedar Policy Language Guide. -
ImpossiblePolicy
Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.
-
WrongNumberArguments
The policy references an extension type with the wrong number of arguments.
-
FunctionArgumentValidationError
Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.
HTTP Status Code: 400
-
Examples
Example
The following example request creates an identity source that Verified Permissions can use to retrieve authenticated identities to use in evaluations. The specified identity provider (IdP) is a Amazon Cognito user pool.
Sample Request
POST HTTP/1.1
Host: verifiedpermissions.us-east-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: identity
X-Amz-Target: VerifiedPermissions.CreateIdentitySource
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"configuration": {
"cognitoUserPoolConfiguration": {
"userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5",
"clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],
"groupConfiguration": {
"groupEntityType": "MyCorp::Group"
}
}
},
"policyStoreId": "PSEXAMPLEabcdefg111111",
"principalEntityType": "MyCorp::User",
"clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111"
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
vary: origin
vary: access-control-request-method
vary: access-control-request-headers
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
"createdDate":"2023-05-19T20:30:28.214829Z",
"identitySourceId":"ISEXAMPLEabcdefg111111",
"lastUpdatedDate":"2023-05-19T20:30:28.214829Z",
"policyStoreId":"PSEXAMPLEabcdefg111111"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: