シングルサインオンのAPIエンドポイント
シングルサインオン(SSO)を実装し、その設定を行う際には、以下のAPIエンドポイントが役立ちます。
Authentication API(認証API)エンドポイント
POST /login/callback
IDプロバイダー(IdP)によって開始されたSSOフローでは、POST /login/callbackエンドポイントが、IDプロバイダーからのSAMLサインオン要求を受け入れることができます。
Management API
Management APIには、SSOを管理するために設計された複数のエンドポイントがあります。
Management APIエンドポイントを呼び出すには、アクセストークンを取得する必要があります。
クライアント
すべてのクライアントアプリケーション/SSO統合には、SSOの実装に関連する情報が含まれています。この情報は、クライアントのエンドポイントのいずれかを呼び出すことで取得または変更できます。
各クライアントに対象となるパラメーターは以下のとおりです。
sso
:SSO統合を通じて作成されたクライアントにのみ適用されるフラグ。true
の場合はAuth0がSSOを処理し、false
の場合はIdPがSSOを処理します。sso_disabled
:SSOを有効/無効にするために使用されるフラグ。true
の場合、SSOは無効になり、false
の場合、SSOは有効になります。このオプションは、Management APIを使用することでのみ設定できます。app_type
:アプリケーションタイプ。Auth0に組み込まれたSSO統合を使用してクライアントが作成された場合、SSO統合の名前が一覧表示されます(例:native
やspa
ではなく、box
またはconcur
)。
すべてのクライアントを取得する
GET /api/v2/clientsエンドポイントを使用して、テナントに構成したクライアントアプリケーションに関する情報を返すことができます。
クライアントを作成する
POST /api/v2/clientsエンドポイントを使用して、新しいクライアントアプリケーションを作成することができます。
クライアントを取得する
GET /api/v2/clientsエンドポイントを使用して、テナントに構成した特定のクライアントに関する情報を返すことができます。
クライアントの更新
PATCH /api/v2/clientsエンドポイントを使用して、SSO関連パラメーターを含む特定のクライアントを更新することができます。
テナント
Auth0を使用すると、SSOの実装に影響を与える可能性のある以下のテナントレベルのパラメーターを制御することができます。
session_lifetime
:ユーザーのAuth0セッションの有効期間。idle_session_lifetime
:非アクティブ状態のため、ユーザーが再度サインインする必要が生じるまでの経過時間。
テナント設定を取得する
GET /api/v2/tenants/settingsエンドポイントは、テナントの設定を取得します。
テナント設定を更新する
POST /api/v2/connectionsエンドポイントを使うと、テナント設定を更新できます。