Class ApiKeyAuth

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

Index

メソッド

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

メソッド

create

create(keyName): Promise<SecretApiKey>
現在のユーザーとして認証するために使用できる API キーを作成します。
パラメーター
- keyName : string
  作成する API キーの名前。
Promise < SecretApiKey >を返します
- パッケージ/realm/src/app-services/ApiKeyAuth.ts で定義:70

削除

削除(keyId): Promise<void>
現在のユーザーに関連付けられている API キーを削除します。
パラメーター
- keyId : string
  削除する API キーの ID
Returns Promise<void>
- パッケージ/realm/src/app-services/ApiKeyAuth.ts:97で定義されます。

無効にする

無効にする(keyId): Promise<void>
現在のユーザーに関連付けられている API キーを無効にします。
パラメーター
- keyId : string
  無効にする API キーの ID
Returns Promise<void>
- パッケージ/realm/src/app-services/ApiKeyAuth.ts で定義:113

有効にする

有効にする(keyId): Promise<void>
現在のユーザーに関連付けられている API キーを有効にします。
パラメーター
- keyId : string
  有効にする API キーの ID
Returns Promise<void>
- パッケージ/realm/src/app-services/ApiKeyAuth.ts で定義されている場合:105

fetch

fetch(keyId): Promise<apiKey>
現在のユーザーに関連付けられている API キーを取得します。
パラメーター
- keyId : string
  取得する API キーの ID。
Promise < ApiKey >を返します
- パッケージ/realm/src/app-services/ApiKeyAuth.ts で定義:80

fetch すべて

fetch すべて(): Promise<apiKey[]>
現在のユーザーに関連付けられている API キーを取得します。

Promise < ApiKey [] >を返します
- パッケージ/realm/src/app-services/ApiKeyAuth.ts で定義されます:88

TypeDocを使用して生成