---
title: "GET /user/federate/{InstanceId}"
method: GET
path: "/user/federate/{InstanceId}"
---

# GET /user/federate/{InstanceId}

`GET /user/federate/{InstanceId}`

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`

## Path parameters

- `InstanceId` string, required

## Response `200`

Success

- GetFederationTokenResponse
  - `Credentials` object — The credentials to use for federation.
    - `AccessToken` string, password — An access token generated for a federated user to access Amazon Connect.
    - `AccessTokenExpiration` string, date-time — A token generated with an expiration time for the session a user is logged in to Amazon Connect.
    - `RefreshToken` string, password — Renews a token generated for a user to access the Amazon Connect instance.
    - `RefreshTokenExpiration` string, date-time — Renews the expiration timer for a generated token.
  - `SignInUrl` string — The URL to sign into the user's instance.
  - `UserArn` string — The Amazon Resource Name (ARN) of the user.
  - `UserId` string — The identifier for the user.

## Other responses

- `480` — InvalidRequestException
- `481` — InvalidParameterException
- `482` — ResourceNotFoundException
- `483` — UserNotFoundException
- `484` — InternalServiceException
- `485` — DuplicateResourceException

---

[API](https://skmtc.net/aws/apis/connect.md) · [All operations](https://skmtc.net/aws/apis/connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/connect/versions/fbcf0a4faed2/schema)