Own AWS? Customize your docs with AI search, analytics, and more.

GET

/user/federate/{InstanceId}

http://connect.{region}.amazonaws.com/user/federate/{InstanceId}

Retrieves a token for federation. <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: <code>Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect</code> </note>

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://connect.{region}.amazonaws.com/user/federate/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/user/federate/{InstanceId}

http://connect.{region}.amazonaws.com/user/federate/{InstanceId}

Retrieves a token for federation. <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: <code>Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect</code> </note>

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://connect.{region}.amazonaws.com/user/federate/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/user/federate/{InstanceId}

http://connect.{region}.amazonaws.com/user/federate/{InstanceId}

Retrieves a token for federation. <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: <code>Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect</code> </note>

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://connect.{region}.amazonaws.com/user/federate/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/user/federate/{InstanceId}

http://connect.{region}.amazonaws.com/user/federate/{InstanceId}

Retrieves a token for federation. <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: <code>Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect</code> </note>

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://connect.{region}.amazonaws.com/user/federate/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}