コンテンツへスキップ

サイト内検索

ページを検索

Docs

API

Identities API

View as .md

ディレクトリ内のエージェントアイデンティティを作成、参照、スポンサー設定、失効させる。

アイデンティティの作成

POST /v1/identities に、名前、スポンサーのメールアドレス、そしてそのアイデンティティが要求しうるスコープの上限を送る。レスポンスは、アイデンティティid、そのステータス、解決されたスポンサーを返す。

名前は人間のためのものであり、一意である必要はない。idはあらゆる場所で使われる安定した正典参照だ。

取得と一覧

GET /v1/identities/{id} は、スポンサー、スコープ上限、ステータスを伴う単一のアイデンティティを返す。GET /v1/identities は、カーソルページネーションと、スポンサーおよびステータスによるフィルターとともに一覧を返す。

一覧取得は読み取り専用でポーリングしても安全だ。失効やスポンサー変更を即座に反映する。

スポンサーの更新

PATCH /v1/identities/{id} はスポンサーを変更するか、スコープ上限を調整する。以前の値は監査ログに保持されるため、記録はいつの時点でも誰が責任を負い、何が許可されていたかを常に示す。

失効

POST /v1/identities/{id}/revoke は、接続されたすべてのシステムにわたって、そのアイデンティティのすべての認証情報とスコープを同期的に無効化する。この呼び出しは封じ込めが完了した時点で返り、イベントは監査ログに書き込まれる。