リソースオーナー用API (1.0.0)
Download OpenAPI specification:Download
リソースオーナー(ユーザー)本人による操作に関するAPI群。
主に以下のような操作を提供します:
- 自身のアカウント削除
- 多要素認証(MFA)の登録要求(FIDO-UAF など)
アクセストークンを用いて、ユーザー本人による安全な自己操作を実現します。
MFAの登録要求
FIDO-UAFなどの登録要求の依頼を行う。
path Parameters
| tenant-id required | string |
| mfa-operation-type required | string Example: fido-uaf-registration |
Request Body schema: application/jsonoptional
MFAの仕様に応じたパラメータをBodyに設定する。
| app_name | string アプリ名(例:◯◯アプリ)。 |
| platform | string デバイスのプラットフォーム名(例:"Android", "iOS" など)。 |
| os | string オペレーティングシステムのバージョン情報(例:"Android15")。 |
| model | string デバイスモデル名(例:"galaxy z fold 6")。 |
| locale | string 言語設定。(例:ja, en) |
| notification_channel | string Enum: "fcm" "apns" 通知チャネル("fcm", "apns")。Firebase Cloud Messaging(Android)またはApple Push Notification Service(iOS)を指定。 |
| notification_token | string 通知を送信するためのトークン(例:FCMトークン)。 |
| priority | integer >= 1 このデバイスの通知の優先順位(例: 1, 50, 100)。 数値が大きいほど優先度が高く、100が最も高い。 省略された場合は、認証デバイスの登録数の連番となる。 |
Responses
Request samples
- Payload
{- "app_name": "string",
- "platform": "string",
- "os": "string",
- "model": "string",
- "locale": "string",
- "notification_channel": "fcm",
- "notification_token": "string",
- "priority": 1
}Response samples
- 200
- 400
- 401
- 500
{- "id": "string"
}認証デバイス部分更新API
認証デバイスの属性情報の部分更新の依頼を行う。
path Parameters
| tenant-id required | string |
| device-id required | string Example: 0048607e-9b89-4ad9-a203-976b7f72f5f2 |
Request Body schema: application/jsonoptional
| app_name | string アプリ名(例:◯◯アプリ)。 |
| platform | string デバイスのプラットフォーム名(例:"Android", "iOS" など)。 |
| os | string オペレーティングシステムのバージョン情報(例:"Android15")。 |
| model | string デバイスモデル名(例:"galaxy z fold 6")。 |
| locale | string 言語設定。(例:ja, en) |
| notification_channel | string Enum: "fcm" "apns" 通知チャネル("fcm", "apns")。Firebase Cloud Messaging(Android)またはApple Push Notification Service(iOS)を指定。 |
| notification_token | string 通知を送信するためのトークン(例:FCMトークン)。 |
| priority | integer >= 1 このデバイスの通知の優先順位(例: 1, 50, 100)。 数値が大きいほど優先度が高く、100が最も高い。 省略された場合は、認証デバイスの登録数の連番となる。 |
Responses
Request samples
- Payload
{- "app_name": "string",
- "platform": "string",
- "os": "string",
- "model": "string",
- "locale": "string",
- "notification_channel": "fcm",
- "notification_token": "string",
- "priority": 1
}Response samples
- 400
- 401
- 404
- 500
{- "error": "invalid_request",
- "error_description": "The identity verification request is invalid. Please review your input for missing or incorrect fields.",
- "error_messages": [
- "last_name is missing",
- "first_name is missing",
- "birthdate is missing"
]
}パスワード変更
認証済みユーザーのパスワードを変更します。
このAPIは以下の手順でパスワード変更を行います:
- 現在のパスワードの検証
- 新しいパスワードのポリシー検証(テナント設定に基づく)
- パスワードの更新
- セキュリティイベントの発行(password_change_success/password_change_failure)
パスワードポリシー
テナントごとに以下のポリシーを設定可能(identity_policy_config.password_policy):
min_length: 最小文字数(デフォルト: 8)require_uppercase: 大文字必須(デフォルト: false)require_lowercase: 小文字必須(デフォルト: false)require_digit: 数字必須(デフォルト: false)require_special_char: 記号必須(デフォルト: false)
デフォルトポリシーはNIST SP 800-63Bの推奨に従い、最小8文字のみを要求します。
セキュリティイベント
パスワード変更の成功・失敗時に以下のセキュリティイベントが発行されます:
password_change_success: パスワード変更成功時password_change_failure: パスワード変更失敗時(検証エラー等)
参考実装
Authorizations:
path Parameters
| tenant-id required | string |
Request Body schema: application/jsonrequired
| current_password required | string 現在のパスワード。 このパスワードが正しいかどうかを検証してから新しいパスワードへの変更を行います。 |
| new_password required | string 新しいパスワード。 テナントに設定されたパスワードポリシー( デフォルトポリシー:
設定可能なポリシー:
|