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
MRiduAuth.createAPIKey

Go packages

riducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

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

TypeScript packages

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

Tooling

ridu CLI
All@riducms/sdkriducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/sveltekit@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/plugin-graphql@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 195memoryTokenStoreRiduAuth.requestVerificationRiduAuth.verifyEmailRiduAuth.changePasswordRiduAuth.createAPIKeyRiduAuth.apiKeysRiduAuth.revokeAPIKeyRiduAuth.forceUnlock

method

RiduAuth.createAPIKey

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

ArgumentsReturnsHow it worksFull signature

Arguments

ArgumentTypeDescription
inputCreateAPIKeyInputThe input value.
optionsRequestOptions | undefinedThe options value.

Returns

The declared result.

Promise<APIKey>

How it works

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

Full signature

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

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

Related types

  • RequestOptions

    Options shared by every request.

  • APIKey

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