Get Identity Center Auth Token

redshift_get_identity_center_auth_token

R Documentation

Generates an encrypted authentication token that propagates the caller's Amazon Web Services IAM Identity Center identity to Amazon Redshift clusters

Description

Generates an encrypted authentication token that propagates the caller's Amazon Web Services IAM Identity Center identity to Amazon Redshift clusters. This API extracts the Amazon Web Services IAM Identity Center identity from enhanced credentials and creates a secure token that Amazon Redshift drivers can use for authentication.

The token is encrypted using Key Management Service (KMS) and can only be decrypted by the specified Amazon Redshift clusters. The token contains the caller's Amazon Web Services IAM Identity Center identity information and is valid for a limited time period.

This API is exclusively for use with Amazon Web Services IAM Identity Center enhanced credentials. If the caller is not using enhanced credentials with embedded Amazon Web Services IAM Identity Center identity, the API will return an error.

Usage

redshift_get_identity_center_auth_token(ClusterIds)

Arguments

ClusterIds

[required] A list of cluster identifiers that the generated token can be used with. The token will be scoped to only allow authentication to the specified clusters. Constraints: ClusterIds must contain at least 1 cluster identifier. ClusterIds can hold a maximum of 20 cluster identifiers. Cluster identifiers must be 1 to 63 characters in length. The characters accepted for cluster identifiers are the following: Alphanumeric characters Hyphens Cluster identifiers must start with a letter. Cluster identifiers can't end with a hyphen or contain two consecutive hyphens.

Value

A list with the following syntax:

list(
  Token = "string",
  ExpirationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_identity_center_auth_token(
  ClusterIds = list(
    "string"
  )
)