Container for the parameters to the GetFederationToken operation. Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
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
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Connect.AmazonConnectRequest
Amazon.Connect.Model.GetFederationTokenRequest
Namespace: Amazon.Connect.Model
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z
Syntax
public class GetFederationTokenRequest : AmazonConnectRequest IAmazonWebServiceRequest
The GetFederationTokenRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetFederationTokenRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
InstanceId | System.String |
Gets and sets the property InstanceId. The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5