Class ApiKeyAuth

Authentication provider where users identify using an API-key.

Constructors

constructor

Methods

create delete disable enable fetch fetchAll

Constructors

constructor

Methods

create

  • create(keyName): Promise<SecretApiKey>

  • Creates an API key that can be used to authenticate as the current user.

    Parameters

    • keyName: string

      the name of the API key to be created.

    Returns Promise<SecretApiKey>

delete

  • delete(keyId): Promise<void>

  • Deletes an API key associated with the current user.

    Parameters

    • keyId: string

      the ID of the API key to delete

    Returns Promise<void>

disable

  • disable(keyId): Promise<void>

  • Disable an API key associated with the current user.

    Parameters

    • keyId: string

      the ID of the API key to disable

    Returns Promise<void>

enable

  • enable(keyId): Promise<void>

  • Enables an API key associated with the current user.

    Parameters

    • keyId: string

      the ID of the API key to enable

    Returns Promise<void>

fetch

  • fetch(keyId): Promise<Realm.ApiKey>

  • Fetches an API key associated with the current user.

    Parameters

    • keyId: string

      the id of the API key to fetch.

    Returns Promise<Realm.ApiKey>

fetchAll

  • fetchAll(): Promise<Realm.ApiKey[]>

  • Fetches the API keys associated with the current user.

    Returns Promise<Realm.ApiKey[]>

Settings

Theme

On This Page

Generated using TypeDoc