Citrix

Produktdokumentation



Ganzes Dokument herunterladen

user_account

Oct. 21, 2015

User Accounts

Properties

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

Enable/Disable session timeout for the user. This parameter is applicable for CloudBridge 400, 800, 1000, 2000, 2000WS, 3000, 4000, and 5000 platforms only. On other platforms this parameter is ignored.

Possible values = [true, false]

username
<String>
No

User Name

Valid char set = ^[-_.@0-9a-zA-Z]+

sessiontimeoutunit
<String>
No

Session timeout unit. This parameter is applicable for CloudBridge 400, 800, 1000, 2000, 2000WS, 3000, 4000, and 5000 platforms only. On other platforms this parameter is ignored.

Possible values = [Hours, Minutes]

privilege
<String>
No

User privilege. This parameter is applicable for CloudBridge SM83, SM85, SM88 and VPX platforms only. On other platforms this parameter is ignored.

Possible values = [admin, viewer]

externalauthentication
<Boolean>
No

Enable/Disable external authentication for the user. This parameter is applicable for CloudBridge 400, 800, 1000, 2000, 2000WS, 3000, 4000, and 5000 platforms only. On other platforms this parameter is ignored.

Possible values = [true, false]

password
<String>
No

Password

Minimum length = 1

groups
<[String,...]>
No

Groups to which user belongs. Session timeout unit. This parameter is applicable for CloudBridge 400, 800, 1000, 2000, 2000WS, 3000, 4000, and 5000 platforms only. On other platforms this parameter is ignored.

sessiontimeout
<String>
No

Session timeout for the user. This parameter is applicable for CloudBridge 400, 800, 1000, 2000, 2000WS, 3000, 4000, and 5000 platforms only. On other platforms this parameter is ignored.

Operations

Note:

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

ADD

Use this operation to add a user account

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"user_account":{
"enablesessiontimeout": <boolean_value>,
"username": <string_value>,
"sessiontimeoutunit": <string_value>,
"privilege": <string_value>,
"externalauthentication": <boolean_value>,
"password": <string_value>,
"groups": <string_value>,
"sessiontimeout": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"user_account":{
"enablesessiontimeout": <boolean_value>,
"username": <string_value>,
"sessiontimeoutunit": <string_value>,
"privilege": <string_value>,
"externalauthentication": <boolean_value>,
"password": <string_value>,
"groups": <string_value>,
"sessiontimeout": <string_value>
}}

DELETE

Use this operation to delete a user account

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/user_account/<username>

Request Headers:

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

Response Payload: EMPTY

GET (ALL)

Use this operation to get user account details

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"user_account": [{
"enablesessiontimeout": <boolean_value>,
"username": <string_value>,
"sessiontimeoutunit": <string_value>,
"privilege": <string_value>,
"externalauthentication": <boolean_value>,
"password": <string_value>,
"groups": <string_value>,
"sessiontimeout": <string_value>
}, ...]}

GET

Use this operation to get user account details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/user_account/<username>

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"user_account":{
"enablesessiontimeout": <boolean_value>,
"username": <string_value>,
"sessiontimeoutunit": <string_value>,
"privilege": <string_value>,
"externalauthentication": <boolean_value>,
"password": <string_value>,
"groups": <string_value>,
"sessiontimeout": <string_value>
}}

MODIFY

Use this operation to modify user account

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/user_account/<username>

Request Headers:

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

Request Payload: JSON

{"user_account":{
"enablesessiontimeout": <boolean_value>,
"username": <string_value>,
"sessiontimeoutunit": <string_value>,
"privilege": <string_value>,
"externalauthentication": <boolean_value>,
"password": <string_value>,
"groups": <string_value>,
"sessiontimeout": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"user_account":{
"enablesessiontimeout": <boolean_value>,
"username": <string_value>,
"sessiontimeoutunit": <string_value>,
"privilege": <string_value>,
"externalauthentication": <boolean_value>,
"password": <string_value>,
"groups": <string_value>,
"sessiontimeout": <string_value>
}}
Back to Top