Product Documentation

groups

Oct 21, 2015

Configuration of Groups. This NITRO resource is applicable for CloudBridge 400, 800, 1000, 2000, 2000WS, 3000, 4000, and 5000 platforms only.

Properties

Name Data Type Read-Only? Description
enablesessiontimeout
<String>
No

Enables session timeout for group.

Possible values = [true, false]

users
<[String,...]>
No

Users belong to the group.

sessiontimeoutunit
<String>
No

Session timeout unit for the Group.

Possible values = [Minutes, Hours]

name
<String>
No

Group Name.

permission
<String>
No

Permission for the group (admin/read-only).

Possible values = [admin, readonly]

sessiontimeout
<String>
No

Session timeout for the Group.

Operations

Hinweis

Mandatory parameters are marked in red and placeholder content is marked in <green>.

ADD

Use this operation to add a group

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/groups

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.groups+json

Request Payload: JSON

{"groups":{
"enablesessiontimeout": <string_value>,
"users": <string_value>,
"sessiontimeoutunit": <string_value>,
"name": <string_value>,
"permission": <string_value>,
"sessiontimeout": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.groups+json

Response Payload: JSON

{"groups":{
"enablesessiontimeout": <string_value>,
"users": <string_value>,
"sessiontimeoutunit": <string_value>,
"name": <string_value>,
"permission": <string_value>,
"sessiontimeout": <string_value>
}}

DELETE

Use this operation to delete a group

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/groups/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>

Response Payload: EMPTY

GET (ALL)

Use this operation to get group details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/groups

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.groups_list+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.groups_list+json

Response Payload: JSON

{"groups": [{
"enablesessiontimeout": <string_value>,
"users": <string_value>,
"sessiontimeoutunit": <string_value>,
"name": <string_value>,
"permission": <string_value>,
"sessiontimeout": <string_value>
}, ...]}

GET

Use this operation to get group details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/groups/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.groups+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.groups+json

Response Payload: JSON

{"groups":{
"enablesessiontimeout": <string_value>,
"users": <string_value>,
"sessiontimeoutunit": <string_value>,
"name": <string_value>,
"permission": <string_value>,
"sessiontimeout": <string_value>
}}

MODIFY

Use this operation to modify group

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/groups/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.groups+json

Request Payload: JSON

{"groups":{
"enablesessiontimeout": <string_value>,
"users": <string_value>,
"sessiontimeoutunit": <string_value>,
"name": <string_value>,
"permission": <string_value>,
"sessiontimeout": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.groups+json

Response Payload: JSON

{"groups":{
"enablesessiontimeout": <string_value>,
"users": <string_value>,
"sessiontimeoutunit": <string_value>,
"name": <string_value>,
"permission": <string_value>,
"sessiontimeout": <string_value>
}}