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
Response codes
Code | Type | Description |
---|---|---|
200 | User | Successful |
Response body objects
The UserSessionsConfig
object
The configuration of user sessions - concurrent sessions policy and automatic logout.
Element | Type | Description |
---|---|---|
concurrentSessionPolicyDto | Concurrent | The configuration of the concurrent sessions policy. Set '0' to disable session limitation. |
automaticLogoutDto | Automatic | Configuration of automatic logout. |
The ConcurrentSessionPolicy
object
The configuration of the concurrent sessions policy. Set '0' to disable session limitation.
Element | Type | Description |
---|---|---|
userLimit | integer | Session limit for regular users (0 = no limit) |
adminLimit | integer | Session limit for admin users (0 = no limit) |
The AutomaticLogoutConfiguration
object
Configuration of automatic logout.
Element | Type | Description |
---|---|---|
logoutInactiveUsersEnabled | boolean | True if automatic logout is enabled |
userInactivityTimeout | integer | User inactivity timeout |
Response body JSON model
{
"concurrentSessionPolicyDto": {
"userLimit": 1,
"adminLimit": 1
},
"automaticLogoutDto": {
"logoutInactiveUsersEnabled": true,
"userInactivityTimeout": 900
}
}
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
curl -X GET "https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions" -H "accept: application/json"
Request URL
https://myManaged.cluster.com/api/cluster/v2/clusterConfig/userSessions
Response body
{
"concurrentSessionPolicyDto": {
"userLimit": 2,
"adminLimit": 5
},
"automaticLogoutDto": {
"logoutInactiveUsersEnabled": true,
"userInactivityTimeout": 900
}
}
Response code
204