Auth モジュール
認証モジュールの作成
post /api/http/auth-modules
新しい認証モジュールを作成します。設定は、作成される認証モジュールのタイプに固有です。
必須アクセス権: Manage authentication modules
すべての認証モジュールを取得する
get /api/http/auth-modules
すべての認証モジュールを取得する
|
リクエスト引数 |
|---|
withDisabled : boolean (クエリ) (オプション、デフォルトは false) |
|
認証モジュールの並べ替え
post /api/http/auth-modules/reorder
認証モジュールの順序を定義します。これは、サインインページのフェデレーション認証モジュールボタンの順序に影響します。
必須アクセス権: Manage authentication modules
post /api/http/auth-modules/{id}/saml-metadata
|
リクエスト引数 |
|---|
id : string (パス) (必須) | フィールドを持つオブジェクト : idpUrl : string (必須) idpEntityId : string (必須) idpCertificateSHA256 : string (必須) spEntityId : string (必須) sslKeystore : SSLKeystore ( Nullable および Optional、デフォルトは null) contactProfileId : string ( Nullable および Optional、デフォルトは null)
|
|
oidc を発見する
get /api/http/auth-modules/discover-oidc
検出ドキュメントを介して OpenID Connect プロバイダーのエンドポイントを自動的に検出します
必須アクセス権: Manage authentication modules
|
リクエスト引数 |
|---|
discoveryEndpoint : string (クエリ) (必須) |
|
キーによる認証モジュールの取得
get /api/http/auth-modules/key:{key}
既存の認証モジュールを取得する
|
リクエスト引数 |
|---|
key : string (パス) (必須) |
|
認証モジュールを更新する
patch /api/http/auth-modules/{id}
既存の認証モジュールを更新します。オプションのパラメーターは、指定されていない場合は無視され、指定されていない場合は更新されます。
必須アクセス権: Manage authentication modules
|
リクエスト引数 |
|---|
id : string (パス) (必須) | フィールドを持つオブジェクト : key : string ( Nullable および Optional、デフォルトは null) name : string ( Nullable および Optional、デフォルトは null) enabled : boolean ( Nullable および Optional、デフォルトは null) iconDataURI : string ( Null 可能かつオプション) settings : ES_AuthModuleSettings ( Nullable および Optional、デフォルトは null)
|
|
認証モジュールの削除
delete /api/http/auth-modules/{id}
既存の認証モジュールを削除する
必須アクセス権: Manage authentication modules
|
リクエスト引数 |
|---|
id : string (パス) (必須) |
|
構成を取得する
get /api/http/auth-modules/config
認証構成を取得する
必須アクセス権: Manage authentication modules
設定を入れる
put /api/http/auth-modules/config
認証構成を設定する
必須アクセス権: Manage authentication modules
|
リクエスト引数 |
|---|
フィールドを持つオブジェクト : dontRememberMeTtl : integer (フォーマット: int32) ( Nullable および Optional、デフォルトは null) adminRememberMeTtl : integer (フォーマット: int32) ( Nullable および Optional、デフォルトは null) userRememberMeTtl : integer (フォーマット: int32) ( Nullable および Optional、デフォルトは null)
|
|
構成の削除
delete /api/http/auth-modules/config
認証構成をデフォルトにリセットする
必須アクセス権: Manage authentication modules
組み込み設定をテストする
post /api/http/auth-modules/test/built-in
ユーザー名とパスワードの組み合わせについては、更新された設定で組み込み認証をテストします
LDAP 設定をテストする
post /api/http/auth-modules/test/ldap
ユーザー名とパスワードの組み合わせについては、更新された設定で LDAP 認証をテストします
制限されたログインを取得する
get /api/http/auth-modules/throttled-logins
Space へのログイン時に現在レート制限の対象となっているログインを返します
|
リクエスト引数 |
|---|
$skip : string (クエリ) ( Nullable および Optional、デフォルトは null) | $top : integer (フォーマット: int32) (クエリ) ( Nullable および Optional、デフォルトは 100) | login : string (クエリ) ( Nullable および Optional、デフォルトは null) |
|
スロットリングステータスをリセットする
delete /api/http/auth-modules/throttled-logins
指定されたログインによるアカウントの失敗したログイン試行を追跡するカウンタをリセットします。これらのアカウントを使用するメンバーは、Space へのログイン試行をブロックされなくなりました。
|
リクエスト引数 |
|---|
logins : string の配列 (クエリ) (必須) |
|
組織のスロットリングステータスを取得する
get /api/http/auth-modules/throttled-logins/org-status
組織がスロットルされるまでの日時を返します
組織のスロットリングをリセットする
delete /api/http/auth-modules/throttled-logins/org-status
組織がスロットルされるまでの日時をリセットします
すべての使用状況を取得する
get /api/http/auth-modules/usages
認証モジュールの使用回数の一覧を取得する
必須アクセス権: Manage authentication modules
パスワードの変更
post /api/http/auth-modules/{id}/logins/{identifier}/change
指定された認証モジュール ( id ) とプロファイルのパスワードを変更します (識別子)
|
リクエスト引数 |
|---|
id : string (パス) (必須) | identifier : string (パス) (必須) | フィールドを持つオブジェクト : |
|
パスワードを再設定する
post /api/http/auth-modules/{id}/logins/{identifier}/reset
指定された認証モジュール ( id ) とプロファイルのパスワードリセットをリクエストします (識別子)
|
リクエスト引数 |
|---|
id : string (パス) (必須) | identifier : string (パス) (必須) |
|
ログインを削除する
delete /api/http/auth-modules/{id}/logins/{identifier}
認証モジュールからプロファイルログインを切り離します。id パラメーターは認証モジュールを参照し、identifier パラメーターはログインを参照します。
|
リクエスト引数 |
|---|
identifier : string (パス) (必須) | id : string (パス) (必須) |
|
