Amazon Connect Service
API Reference (API Version 2017-08-08)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Retrieves a token for federation.

Request Syntax

GET /user/federate/InstanceId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.


The identifier of the Amazon Connect instance.

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

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 } }

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


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 due to 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: