DeleteAuthSessionsByUserName

DeleteAuthSessionsByUsernameこの方法を使用して、特定のユーザのすべての認証セッションを削除できます。AccessGroup ClusterAdmins/Administrator に登録されていない発信者は、自分のセッションのみを削除できます。ClusterAdmins/Administrator 権限を持つ発信者は、任意のユーザに属するセッションを削除できます。削除できるセッションのリストを表示するには、同じパラメータを指定して ListAuthSessionsByUserName を使用します。削除可能なセッションのリストを表示するListAuthSessionsByUsernameには、同じパラメータを指定してメソッドを使用します。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
authMethod 削除するユーザセッションの認証方式。このパラメータを指定できるのは、 ClusterAdmins/Administrator アクセスグループの呼び出し元だけです。有効な値は次のとおりです。
  • authMethod=cluster は、 clusteradmin ユーザ名を指定します。
  • authMethod=ldap は、ユーザの LDAP DN を指定します。
  • authMethod=IdP は、ユーザの IdP UUID または NameID を指定します。IdP がどちらのオプションを返すように設定されていない場合は、セッションの作成時に発行されたランダム UUID を指定します。
authMethod なし 無効
username ユーザの一意の ID 。 文字列 なし 無効

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 タイプ
sessions 削除された認証セッションのセッション情報。 AuthSessionInfo

要求例

このメソッドの要求例を次に示します。

{
  「メソッド」:「 DeleteAuthSessionsByUserName 」、
  "params": {
    「 authMethod 」:「 cluster 」、
    "username": "admin"
  }
}

応答例

このメソッドの応答例を次に示します。

{
"sessions": [
      {
        "AccessGroupList" : [
          "administrator"
        ],
        「 authMethod 」:「 cluster 」、
        「 clusteradminids 」: [
          1
        ],
        "FinalTimeout" : "2020-03-14T19:21:24Z" 、
        "idpConfigVersion" : 0 、
        「 LastAccessTimeout 」:「 2020-03-11T19:51:24Z 」、
        「 SessionCreationTime 」:「 202020-03-11T19:21:24Z 」、
        「 SessionID 」:「 B12BFC64-F233-44 DF-8B9F-6FB6c011ABF7 」、
        "username": "admin"
      }
    ]
}

新規導入バージョン

12.0