Skip to content

Creates a new client secret for an existing confidential user pool app client

Description

Creates a new client secret for an existing confidential user pool app client. Supports up to 2 active secrets per app client for zero-downtime credential rotation workflows.

Usage

cognitoidentityprovider_add_user_pool_client_secret(UserPoolId,
  ClientId, ClientSecret)

Arguments

  • UserPoolId

    [required] The ID of the user pool that contains the app client.

  • ClientId

    [required] The ID of the app client for which you want to create a new secret.

  • ClientSecret

    The client secret value you want to use. If you don't provide this parameter, Amazon Cognito generates a secure secret for you.

Value

A list with the following syntax:

list(
  ClientSecretDescriptor = list(
    ClientSecretId = "string",
    ClientSecretValue = "string",
    ClientSecretCreateDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$add_user_pool_client_secret(
  UserPoolId = "string",
  ClientId = "string",
  ClientSecret = "string"
)