ListAuthSessionsByUsername
You can use the ListAuthSessionsByUsername
method to list all auth sessions for the specified user. A caller not in AccessGroup ClusterAdmins / Administrator privileges may only list their own sessions. A caller with ClusterAdmins / Administrator privileges may list sessions belonging to any user.
Parameters
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
authMethod |
Authentication method of the user sessions to be listed. Only a caller in the ClusterAdmins/Administrator AccessGroup can provide this parameter. Possible values are:
|
authMethod |
None |
Yes |
username |
Unique identifier for the user. |
string |
None |
Yes |
Return values
This method has the following return value:
Name |
Description |
Type |
sessions |
List of session information for the auth sessions. |
Request example
Requests for this method are similar to the following example:
{ "method": "ListAuthSessionsByUsername", "authMethod": "Cluster", "username": "admin" }
Response example
This method returns a response similar to the following example:
{ "sessions": [ { "accessGroupList": [ "administrator" ], "authMethod": "Cluster", "clusterAdminIDs": [ 1 ], "finalTimeout": "2020-03-14T19:21:24Z", "idpConfigVersion": 0, "lastAccessTimeout": "2020-03-11T19:51:24Z", "sessionCreationTime": "2020-03-11T19:21:24Z", "sessionID": "b12bfc64-f233-44df-8b9f-6fb6c011abf7", "username": "admin" } ] }
New since version
12.0