認証・認可画面用API (1.0.0)

Download OpenAPI specification:Download

認証画面・認可画面からの処理を行うためのAPI群。

認証インタラクションAPI

このAPIを使用することで、以下の認証インタラクションを実行できます：

パスワード認証
SMS認証（チャレンジ・認証）
メール認証（チャレンジ・認証）
FIDO-UAF認証（チャレンジ・認証・登録・登録解除）
WebAuthn認証（チャレンジ・認証・登録・登録解除）
初期ユーザー登録
認証キャンセル
認証デバイス通知

認可画面データAPI

認可画面で表示するためのクライアント情報、スコープ情報などを取得できます。

各インタラクションタイプに応じたリクエストボディとレスポンス形式を提供します。

認証インタラクション

認証画面からの各種認証処理。

認証フローは以下の通りです：

認可エンドポイントから認証トランザクションIDを取得
認証インタラクションAPIで認証処理を実行
認証完了後、認可コードまたはエラーレスポンスを受信

認証インタラクション実行

指定された認証トランザクションIDと認証インタラクションタイプに基づいて認証処理を実行します。

サポートされている認証インタラクションタイプ

パスワード認証

password-authentication - パスワードによる認証

SMS認証

sms-authentication-challenge - SMS認証チャレンジ（認証コード送信）
sms-authentication - SMS認証（認証コード検証）

メール認証

email-authentication-challenge - メール認証チャレンジ（認証コード送信）
email-authentication - メール認証（認証コード検証）

FIDO-UAF認証

fido-uaf-registration-challenge - FIDO-UAF登録チャレンジ
fido-uaf-registration - FIDO-UAF登録
fido-uaf-authentication-challenge - FIDO-UAF認証チャレンジ
fido-uaf-authentication - FIDO-UAF認証
fido-uaf-deregistration - FIDO-UAF登録解除
fido-uaf-cancel - FIDO-UAF処理キャンセル

WebAuthn認証

webauthn-registration-challenge - WebAuthn登録チャレンジ
webauthn-registration - WebAuthn登録
webauthn-authentication-challenge - WebAuthn認証チャレンジ
webauthn-authentication - WebAuthn認証
webauthn-deregistration - WebAuthn登録解除

その他

initial-registration - 初期ユーザー登録
authentication-cancel - 認証キャンセル
authentication-device-notification - 認証デバイス通知
authentication-device-deny - 認証デバイス拒否
authentication-device-binding-message - 認証デバイスバインディングメッセージ検証

バインディングメッセージ検証について

authentication-device-binding-messageは、CIBAフローにおいて消費デバイスと認証デバイス間のトランザクション一致を確認するための検証インタラクションです。

用途:

フィッシング対策: ユーザーが正しいトランザクションを承認しているか確認
トランザクション確認: 金融取引等での取引内容確認
セッション連動: 複数デバイス間でのセッション一致確認

OIDC CIBA仕様: Section 7.1

path Parameters

tenant-id required	string <uuid> Example: 67e7eae6-62b0-4500-9eff-87459f63fc66 テナントID
id required	string Example: auth_txn_12345 認証トランザクションID
interaction-type required	string Enum: "password-authentication" "sms-authentication-challenge" "sms-authentication" "email-authentication-challenge" "email-authentication" "fido-uaf-registration-challenge" "fido-uaf-registration" "fido-uaf-authentication-challenge" "fido-uaf-authentication" "fido-uaf-deregistration" "fido-uaf-cancel" "webauthn-registration-challenge" "webauthn-registration" "webauthn-authentication-challenge" "webauthn-authentication" "webauthn-deregistration" "initial-registration" "authentication-cancel" "authentication-device-notification" "authentication-device-deny" "authentication-device-binding-message" Example: password-authentication 認証インタラクションタイプ

Request Body schema: application/json

認証インタラクションタイプに応じたリクエストボディ。各インタラクションタイプで必要なパラメータが異なります。

One of

username required	string ユーザー名またはメールアドレス
password required	string <password> パスワード

Responses

Request samples

Payload

Content type

application/json

Example

パスワード認証の例

{"username": "user@example.com",
"password": "securePassword123"
}

Response samples

200
400
401
404
500

Content type

application/json

Example

認証成功

{"status": "success",
"redirect_uri": "https://client.example.com/callback?code=xyz123&state=abc"
}

認可画面データ

認可画面で表示するためのデータ取得API。

認可画面データ取得フローは以下の通りです：

認可リクエストから認可リクエストIDを取得
View Data APIでクライアント情報、スコープ情報を取得
認可画面にデータを表示

認可画面データ取得

指定された認可リクエストIDに基づいて、認可画面で表示するためのデータを取得します。

レスポンスデータ

クライアント情報: クライアント名、ロゴURI、利用規約URIなど
スコープ情報: 要求されているスコープの一覧
セッション情報: セッション有効化フラグ
フェデレーション情報: 利用可能な外部IdP連携情報
カスタムパラメータ: クライアント固有のカスタムパラメータ

このAPIは認可画面のレンダリング時に使用され、ユーザーに表示する情報を提供します。

path Parameters

tenant-id required	string <uuid> Example: 67e7eae6-62b0-4500-9eff-87459f63fc66 テナントID
id required	string Example: authz_req_67890 認可リクエストID

Responses

Response samples

200
400
404
500

Content type

application/json

Example

基本的な認可画面データ

{"client_id": "client123",
"client_name": "サンプルアプリケーション",
"client_uri": "https://client.example.com",
"logo_uri": "https://client.example.com/logo.png",
"contacts": "support@client.example.com",
"tos_uri": "https://client.example.com/terms",
"policy_uri": "https://client.example.com/privacy",
"scopes": ["openid",
"profile",
"email"
],
"session_enabled": true,
"custom_params": {"organization_id": "org123",
"organization_name": "テスト組織"
}
}

認可リクエスト

OAuth 2.0/OpenID Connect認可リクエスト関連API。

標準的な認可リクエスト処理
認可承認・拒否処理

認可承認

ユーザーが認証完了後、認可画面で「許可」を選択した際に呼び出すAPI。

認可承認により認可コードが発行され、クライアントのredirect_uriにリダイレクトされます。

path Parameters

tenant-id required	string <uuid> Example: 67e7eae6-62b0-4500-9eff-87459f63fc66 テナントID
id required	string Example: authz_req_67890 認可リクエストID

Responses

Response samples

200
400
500

Content type

application/json

{"status": "success",
"redirect_uri": "https://client.example.com/callback?code=abc123&state=xyz"
}

認可拒否

ユーザーが認可画面で「拒否」を選択した際に呼び出すAPI。

認可拒否によりaccess_deniedエラーがクライアントのredirect_uriに返却されます。

path Parameters

tenant-id required	string <uuid> Example: 67e7eae6-62b0-4500-9eff-87459f63fc66 テナントID
id required	string Example: authz_req_67890 認可リクエストID

Responses

Response samples

200
400
500

Content type

application/json

{"status": "denied",
"redirect_uri": "https://client.example.com/callback?error=access_denied&state=xyz"
}

フェデレーション

外部IdPとの連携認証API。

OIDC、SAMLなどの外部アイデンティティプロバイダーとのフェデレーション認証を行うためのAPI群。

フェデレーション認証開始

外部IdPとのフェデレーション認証を開始します。

指定されたSSOプロバイダーに対してリダイレクト先URLを生成し、外部IdPの認証画面に遷移させます。

サポートされるフェデレーションタイプ

oidc - OpenID Connect
saml - SAML 2.0

一般的なSSOプロバイダー

Google (OIDC)
Azure AD (OIDC/SAML)
Okta (OIDC/SAML)
Auth0 (OIDC)

path Parameters

tenant-id required	string <uuid> Example: 67e7eae6-62b0-4500-9eff-87459f63fc66 テナントID
id required	string Example: authz_req_67890 認可リクエストID
federation-type required	string Enum: "oidc" "saml" Example: oidc フェデレーションタイプ
sso-provider-name required	string Example: google SSOプロバイダー名

Responses

Response samples

200
400
500

Content type

application/json

Example

OIDC フェデレーション

{"status": "redirect",
"redirect_uri": "https://accounts.google.com/oauth2/auth?client_id=...&redirect_uri=..."
}

フェデレーション認証コールバック

外部IdPからのコールバックを処理します。

外部IdPでの認証完了後、認可コードやSAMLレスポンスを受信し、ユーザー情報を取得して認証を完了させます。

処理フロー

外部IdPからのコールバック受信
認可コードまたはSAMLレスポンスの検証
ユーザー情報取得
内部ユーザーとのマッピング
認証完了またはユーザー登録画面へリダイレクト

path Parameters

tenant-id required	string <uuid> Example: 67e7eae6-62b0-4500-9eff-87459f63fc66 テナントID
federation-type required	string Enum: "oidc" "saml" Example: oidc フェデレーションタイプ

Request Body schema: application/x-www-form-urlencoded
required

外部IdPからのコールバックパラメータ。フェデレーションタイプによって形式が異なります。

code	string OIDC認可コード
state	string 状態パラメータ
SAMLResponse	string SAMLレスポンス
RelayState	string SAMLリレー状態
error	string エラーコード
error_description	string エラー詳細

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

Example

OIDC コールバック

code=abc123&state=xyz456

Response samples

200
400
500

Content type

application/json

Example

認証完了

{"status": "success",
"redirect_uri": "https://client.example.com/callback?code=def789&state=original_state"
}

認証・認可画面用API (1.0.0)

認証インタラクションAPI

認可画面データAPI

認証インタラクション

認証インタラクション実行

サポートされている認証インタラクションタイプ

パスワード認証

SMS認証

メール認証

FIDO-UAF認証

WebAuthn認証

その他

バインディングメッセージ検証について

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

認可画面データ

認可画面データ取得

レスポンスデータ

path Parameters

Responses

Response samples

認可リクエスト

認可承認

path Parameters

Responses

Response samples

認可拒否

path Parameters

Responses

Response samples

フェデレーション

フェデレーション認証開始

サポートされるフェデレーションタイプ

一般的なSSOプロバイダー

path Parameters

Responses

Response samples

フェデレーション認証コールバック

処理フロー

path Parameters

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Request Body schema: application/x-www-form-urlencoded
required