Skip to main content

rotateSecretKey()

Rotates the secret key for the given machine.

Returns the new secret key.

function rotateSecretKey(params: RotateMachineSecretKeyParams): Promise<MachineSecretKey>

RotateMachineSecretKeyParams

  • Name
    machineId
    Type
    string
    Description

    The ID of the machine to rotate the secret key for.

  • Name
    previousTokenTtl
    Type
    number
    Description

    The time in seconds that the previous secret key will remain valid after rotation. This ensures a graceful transition period for updating applications with the new secret key. Set to 0 to immediately expire the previous key. Maximum value is 28800 seconds (8 hours).

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const machineId = 'mch_123'

const response = await clerkClient.machines.rotateSecretKey({
  machineId,
  previousTokenTtl: 3600,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/machines/{machine_id}/secret_key/rotate. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub