Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / operations/mrt / resetApiKey

Function: resetApiKey()

resetApiKey(options, auth): Promise<ApiKeyResult>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/user.ts:128

Generates or resets the API key for the authenticated user.

Warning: This will invalidate your current API key.

Parameters

options

UserOperationOptions

Operation options

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<ApiKeyResult>

The new API key

Throws

Error if request fails

Example

typescript
import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
import { resetApiKey } from '@salesforce/b2c-tooling-sdk/operations/mrt';

const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');

const result = await resetApiKey({}, auth);
console.log(`New API key: ${result.api_key}`);
// Important: Update your stored API key!

Released under the Apache-2.0 License.