Class ApiKeyAuth

ユーザーが API キーを使用して識別する認証プロバイダ。

コンストラクター

コンストラクター

メソッド

create 削除 無効にする 有効にする fetch fetch すべて

コンストラクター

コンストラクター

メソッド

create

  • create(keyName): Promise<SecretApiKey>

  • 現在のユーザーとして認証するために使用できる API キーを作成します。

    パラメーター

    • keyName : string

      作成する API キーの名前。

    Promise < SecretApiKey >を返します

削除

  • 削除(keyId): Promise<void>

  • 現在のユーザーに関連付けられている API キーを削除します。

    パラメーター

    • keyId : string

      削除する API キーの ID

    Returns Promise<void>

無効にする

  • 無効にする(keyId): Promise<void>

  • 現在のユーザーに関連付けられている API キーを無効にします。

    パラメーター

    • keyId : string

      無効にする API キーの ID

    Returns Promise<void>

有効にする

  • 有効にする(keyId): Promise<void>

  • 現在のユーザーに関連付けられている API キーを有効にします。

    パラメーター

    • keyId : string

      有効にする API キーの ID

    Returns Promise<void>

fetch

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

  • 現在のユーザーに関連付けられている API キーを取得します。

    パラメーター

    • keyId : string

      取得する API キーの ID。

    Promise < Realmを返します。 ApiKey >

fetch すべて

  • fetch すべて(): Promise<Realm.apiKey[]>

  • 現在のユーザーに関連付けられている API キーを取得します。

    Promise < Realmを返します。 ApiKey [] >

設定

ノードの可視性

テーマ

項目一覧

TypeDocを使用して生成