Interface ApiKey

Export

ApiKey

Hierarchy

  • ApiKey

Properties

account_id created_at id last_used? name scopes type updated_at value

Properties

account_id

account_id: string

The id of the associated account.

Memberof

ApiKey

created_at

created_at: string

Time at which the object was created.

Memberof

ApiKey

id

id: string

Unique identifier for the object.

Memberof

ApiKey

Optional last_used

last_used?: string

Time at which the key was last used to authenticate with the API.

Memberof

ApiKey

name

name: string

The string that you assign to describe the resource. It defaults to 'type Key' (e.g. 'Secret Key' and 'Publishable Key')

Memberof

ApiKey

scopes

scopes: ApiKeyScopes[]

The list of scopes to define the access for this key. You may specify [\'*\'] to enable all scopes.

Memberof

ApiKey

type

type: ApiKeyType

The type of API key. secret can be used to authenticate all endpoints. publishable is used in your frontend application and can only access a handful of endpoints (e.g. confirm a Payment Intent).

Memberof

ApiKey

updated_at

updated_at: string

Time at which the object was last updated.

Memberof

ApiKey

value

value: string

The actual value of the API key to be included in the tilled-api-key header for authentication. secret keys will have a redacted value except when initially created.

Memberof

ApiKey

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc