Apiキー認証

インターフェース ApiKeyAuth

ユーザーが管理下で API キーを管理する機能を公開します。

プロパティ

このインスタンスが関連付けられているアプリ。

抽象価値 user: user

このインスタンスが関連付けられているユーザー。

抽象 paused fun create(name : string): apiKey

ユーザーとして認証するために使用できるユーザー API キーを作成します。この時点が表示される唯一の時間であるため、キーの値を永続化する必要があります。キーは作成時に有効になっています。無効メソッドを呼び出すことで無効にできます。

抽象 paused fun 削除(id: BsonObjectId)

ユーザーによって作成された特定の API キーを削除します。キーが削除されていない場合は、メッセージが表示されずに返します。

抽象 paused fun 無効にする(id: BsonObjectId)

ユーザーによって作成された特定の API キーを削除します。指定されたキーが存在しない場合、関数は正常に完了します。

抽象 paused fun 有効にする(id: BsonObjectId)

ユーザーが作成した特定の API キーを有効にします。

抽象 paused fun fetch(id: BsonObjectId): apiKey?

ユーザーに関連付けられた特定のユーザー API キーを取得します。

抽象 paused fun fetchAll(): リスト<apiKey>

ユーザーに関連付けられているすべての API キーを取得します。キーが見つからない場合は、空のリストを返します。