Get Federation Token

connect_get_federation_token

R Documentation

Description¶

Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action.

For more information about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect Customer 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 Connect Customer⁠

Usage¶

connect_get_federation_token(InstanceId)

Arguments¶

InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Value¶

A list with the following syntax:

list(
  Credentials = list(
    AccessToken = "string",
    AccessTokenExpiration = as.POSIXct(
      "2015-01-01"
    ),
    RefreshToken = "string",
    RefreshTokenExpiration = as.POSIXct(
      "2015-01-01"
    )
  ),
  SignInUrl = "string",
  UserArn = "string",
  UserId = "string"
)

Request syntax¶

svc$get_federation_token(
  InstanceId = "string"
)