Interface ApiKeyCreateParams

Export

ApiKeyCreateParams

Hierarchy

  • ApiKeyCreateParams

Properties

name? scopes? type

Properties

Optional name

name?: string

A brief name or description of the API that will help you remember what it is used for.

Memberof

ApiKeyCreateParams

Optional scopes

scopes?: ApiKeyCreateParamsScopes[]

The list of scopes to define the access for this key. You may specify [\'*\'] (default) to enable all scopes, except those that require explicit selection. Scopes are ignored for keys of type publishable.

Memberof

ApiKeyCreateParams

type

type: ApiKeyCreateParamsType

secret Must be kept secret at all times. publishable A publishable key is only used for creating payment tokens on your public facing website or integration.

Memberof

ApiKeyCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc