UserApiKey

A class containing the fields returned by the Stitch client API in an authentication request.

Hierarchy

UserApiKey

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserApiKey(id: string, key: string | undefined, name: string, disabled: boolean): UserApiKey

- Defined in core/sdk/src/auth/providers/userapikey/models/UserApiKey.ts:68
Parameters
- id: string
- key: string | undefined
- name: string
- disabled: boolean
Returns UserApiKey

Properties

disabled

disabled: boolean

Whether or not the key is disabled.

id

id: BSON.ObjectID

The id of the key.

Optional key

key: undefined | string

The actual key. Will only be included in the response when an API key is first created.

name

name: string

The name of the key.

Methods

toJSON

toJSON(): object

- Defined in core/sdk/src/auth/providers/userapikey/models/UserApiKey.ts:82
Returns object

Static readFromApi

readFromApi(json: string | object): UserApiKey

- Defined in core/sdk/src/auth/providers/userapikey/models/UserApiKey.ts:36
Decodes a response from the Stitch client API into a User API key.

Parameters
- json: string | object
Returns UserApiKey

Generated using TypeDoc