Skip to content
DocsReference
DocsReferenceGitHub

Search Ridu documentation

tab controls

Loading search…

Search will be ready in a moment.

No matching results

Try a different term or search every section.

Loading search.

Preparing index…View all results →↑↓ move↵ openesc close
Get started
Modules/@riducms/sdk
MRiduClient.createAPIKey

Go packages

riducorefieldqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

graphqlmcprichtextseoformbuilder@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder

TypeScript packages

@riducms/sdk@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/admin@riducms/translations@riducms/cli/run

Tooling

ridu CLI
All@riducms/sdkriducorefieldqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 137GlobalSelectForRiduClient.requestVerificationRiduClient.verifyEmailRiduClient.changePasswordRiduClient.createAPIKeyRiduClient.apiKeysRiduClient.revokeAPIKeyRiduClient.forceUnlock

method

RiduClient.createAPIKey

RiduClient.createAPIKey( input: CreateAPIKeyInput, options?: RequestOptions, ): Promise<APIKey>

Create an API key; its secret is returned only once.

Source packages/sdk/src/types.ts:726

@param input
The input value.
@param options
The options value.
@returns
The declared result.

CreateAPIKeyInput is the SDK’s internal name for the inline input shape; it is not a separately importable export.

Related types

  • RequestOptions

    Options shared by every request.

  • APIKey

    A newly created API key including its one-time secret.