v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

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

get/user/federate/{InstanceId}

Path parameters

InstanceIdstring required

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

Response

Success

SignInUrlstring

The URL to sign into the user's instance.

UserArnstring

The Amazon Resource Name (ARN) of the user.

UserIdstring

The identifier for the user.