Skip to main content

getSecret()

Gets the secret of the given API key.

function getSecret(apiKeyId: string): Promise<{ secret: string }>

Parameters

  • Name
    apiKeyId
    Type
    string
    Description

    The ID of the API key to get the secret of.

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 response = await clerkClient.apiKeys.getSecret('apikey_123')

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/api_keys/{apiKeyId}/secret. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub