Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
Note
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with
Amazon Connect
Request Syntax
GET /user/federate/InstanceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Credentials": {
"AccessToken": "string",
"AccessTokenExpiration": number,
"RefreshToken": "string",
"RefreshTokenExpiration": number
},
"SignInUrl": "string",
"UserArn": "string",
"UserId": "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.
- Credentials
-
The credentials to use for federation.
Type: Credentials object
- SignInUrl
-
The URL to sign into the user's instance.
Type: String
- UserArn
-
The Amazon Resource Name (ARN) of the user.
Type: String
- UserId
-
The identifier for the user. This can be the ID or the ARN of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- DuplicateResourceException
-
A resource with the specified name already exists.
HTTP Status Code: 409
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- UserNotFoundException
-
No user with the specified credentials was found in the Amazon Connect instance.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
