Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API endpoints

/healthはpublicです。通常のproject APIはKeycloak access tokenを必要とし、/v1/projectsはissuerからprojectを解決します。Platform provisioningはplatform issuerのadmin roleで保護します。Browser passkey handoffの3 endpointだけはBearer tokenを受け取りません。代わりにoptions callから発行された短期・単回使用challenge IDをcapabilityとして検証します。RouteとmiddlewareはGF-10002で登録されます。Swagger列は該当operationを直接開きます。

MethodEndpointPurposeSwagger
GET/healthLiveness (GF-10002)Open
GET/v1/projectsToken issuerに対応するProject一覧 (GF-10003)Open
POST/v1/passkeys/browser/optionsCapabilityでbrowser ceremony optionsを取得 (GF-10020)Open
POST/v1/passkeys/browser/registration/verifyBrowser registration responseを検証 (GF-10021)Open
POST/v1/passkeys/browser/authentication/verifyBrowser assertionを検証 (GF-10022)Open
GET/v1/projects/{projectId}Project取得Open
POST/v1/platform/provisioning/planPlatform admin向けprovisioning plan (GF-10023)Open
POST/v1/platform/provisioning/applyPlatform admin向けprovisioning適用 (GF-10024)Open
GET/v1/projects/{projectId}/permissionsEffective permission取得 (GF-10007)Open
GET/v1/projects/{projectId}/groupsGroup一覧Open
POST/v1/projects/{projectId}/groupsGroup作成Open
GET/v1/projects/{projectId}/groups/{groupId}Group取得Open
PATCH/v1/projects/{projectId}/groups/{groupId}Group更新Open
DELETE/v1/projects/{projectId}/groups/{groupId}Group削除Open
GET/v1/projects/{projectId}/devicesDevice一覧Open
GET/v1/projects/{projectId}/devices/{deviceId}Device取得Open
DELETE/v1/projects/{projectId}/devices/{deviceId}Device失効Open
POST/v1/projects/{projectId}/devices/registration/challenge登録Challenge発行 (passkey AMR required, GF-10008)Open
POST/v1/projects/{projectId}/devices/registration/verifyAttestation検証と登録 (passkey AMR required, GF-10008)Open
POST/v1/projects/{projectId}/devices/passkeys/registration/optionsGorape RP用WebAuthn registration options (GF-10016)Open
POST/v1/projects/{projectId}/devices/passkeys/registration/verifyWebAuthn credential/attestation検証と登録 (GF-10017)Open
POST/v1/projects/{projectId}/devices/{deviceId}/challenge鍵保有証明Challenge発行 (passkey AMR required, GF-10008)Open
POST/v1/projects/{projectId}/devices/{deviceId}/verify鍵保有証明検証 (passkey AMR required, GF-10008)Open
POST/v1/projects/{projectId}/devices/{deviceId}/passkeys/authentication/optionsWebAuthn assertion options (GF-10018)Open
POST/v1/projects/{projectId}/devices/{deviceId}/passkeys/authentication/verifyWebAuthn assertion検証 (GF-10019)Open
POST/v1/projects/{projectId}/proof-requests外部サービス向け操作結合WebAuthn Challenge発行 (GF-10035)Open
POST/v1/projects/{projectId}/proof-requests/{proofId}/verify外部サービス向け操作結合WebAuthn Assertion検証 (GF-10036)Open
GET/v1/projects/{projectId}/groups/{groupId}/devicesGroup Device一覧Open
POST/v1/projects/{projectId}/groups/{groupId}/devicesDeviceをGroupへ割当Open
DELETE/v1/projects/{projectId}/groups/{groupId}/devices/{deviceId}Group割当解除Open
GET/v1/projects/{projectId}/rolesProject Role binding一覧Open
POST/v1/projects/{projectId}/rolesProject Role binding設定Open
DELETE/v1/projects/{projectId}/roles/{bindingId}Project Role binding削除Open
GET/v1/projects/{projectId}/groups/{groupId}/rolesGroup Role binding一覧Open
POST/v1/projects/{projectId}/groups/{groupId}/rolesGroup Role binding設定Open
GET/v1/projects/{projectId}/role-definitionsRole定義一覧Open
PUT/v1/projects/{projectId}/role-definitions/{key}Role定義作成・更新Open
DELETE/v1/projects/{projectId}/role-definitions/{key}Role定義削除Open
GET/v1/projects/{projectId}/attestation/capabilitiesLegacy native-key verifier対応状況Open
GET/v1/projects/{projectId}/devices/{deviceId}/attestationAttestation履歴Open