Citrix

Produktdokumentation



Ganzes Dokument herunterladen

delegate_users

Oct. 21, 2015

Delegate Users and domain name

Properties

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

Delegated user name

Valid char set = ^[-!#$%().^_~0-9a-zA-Z]+$

domainname
<String>
No

Domain Name of user

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

delegateuserpassword
<String>
No

Password

Minimum length = 7

userstatus
<String>
Yes

User status in domain

Operations

Note:

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

ADD

Use this operation to add a user to the list of delegate users

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"delegate_users":{
"delegateusername": <string_value>,
"domainname": <string_value>,
"delegateuserpassword": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"delegate_users":{
"delegateusername": <string_value>,
"domainname": <string_value>,
"delegateuserpassword": <string_value>,
"userstatus": <string_value>
}}

DELETE

Use this operation to delete a user from list of delegate users

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/delegate_users/delegateusername=<STRING>,domainname=<STRING>

Request Headers:

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

Response Payload: EMPTY

GET (ALL)

Use this operation to get list of delegate users

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"delegate_users": [{
"delegateusername": <string_value>,
"domainname": <string_value>,
"delegateuserpassword": <string_value>,
"userstatus": <string_value>
}, ...]}

GET

Use this operation to get list of delegate users

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/delegate_users/delegateusername=<STRING>,domainname=<STRING>

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"delegate_users":{
"delegateusername": <string_value>,
"domainname": <string_value>,
"delegateuserpassword": <string_value>,
"userstatus": <string_value>
}}

MODIFY

Use this operation to update a user from list of delegate users

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/delegate_users/<delegateusername>

Request Headers:

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

Request Payload: JSON

{"delegate_users":{
"delegateusername": <string_value>,
"domainname": <string_value>,
"delegateuserpassword": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"delegate_users":{
"delegateusername": <string_value>,
"domainname": <string_value>,
"delegateuserpassword": <string_value>,
"userstatus": <string_value>
}}
Back to Top