Get cluster user sessions configuration

This API call gets a cluster user sessions configuration.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/cluster/v2/clusterConfig/userSessions

Parameters

No parameters are required for this API call.

Response

1{
2  "concurrentSessionPolicyDto": {
3    "userLimit": 1,
4    "adminLimit": 1
5  },
6  "automaticLogoutDto": {
7    "logoutInactiveUsersEnabled": true,
8    "userInactivityTimeout": 900
9  }
10}

Example

In this example, the request queries the cluster for the current user sessions configuration. The cluster then returns information about the current session policy for concurrent sign-ins and user inactivity. The response indicates that the concurrent sign-in limit for users is 2. For cluster admins accounts, the limit is 5. Also, the inactivity sign-out policy is in effect and is set to 900 seconds.

Curl

1curl -X GET "https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions" -H  "accept: application/json"

Request URL

1https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions

Response body

1{
2  "concurrentSessionPolicyDto": {
3    "userLimit": 2,
4    "adminLimit": 5
5  },
6  "automaticLogoutDto": {
7    "logoutInactiveUsersEnabled": true,
8    "userInactivityTimeout": 900
9  }
10}

Response code

204