GetFederationToken - Amazon Connect


Retrieves a token for federation.


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.


The identifier of the Amazon Connect instance. You can find the instanceId in the 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.


The credentials to use for federation.

Type: Credentials object


The URL to sign into the user's instance.

Type: String


The Amazon Resource Name (ARN) of the user.

Type: String


The identifier for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.


For information about the errors that are common to all actions, see Common Errors.


A resource with the specified name already exists.

HTTP Status Code: 409


Request processing failed because of an error or failure with the service.

HTTP Status Code: 500


One or more of the specified parameters are not valid.

HTTP Status Code: 400


The request is not valid.

HTTP Status Code: 400


The specified resource was not found.

HTTP Status Code: 404


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: