Product Documentation

windows_domain

Oct 21, 2015

Join Leave or Get status of windows domain

Properties

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

Domain Name of user

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

registereddomain
<String>
Yes

registered windows domain

registeredstatuserrormsg
<String>
Yes

Registered domain status error msg if any error

domainaction
<String>
No

Action based on progress of leave or join request: If Request is new the value of domainaction has to be configure but to poll the progress of previous request the value of domain action should be status

Possible values = [configure, status]

registeredstatus
<String>
Yes

Registered domain status

domainuserpassword
<String>
No

Password

Minimum length = 1

domainuser
<String>
No

Domain user name

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

leaveorjoin
<String>
No

leave domain or join domain

Possible values = [Leave, Join]

Operations

Hinweis

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

GET

Use this operation to get status of registered windows domain

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"windows_domain":{
"domainname": <string_value>,
"registereddomain": <string_value>,
"registeredstatuserrormsg": <string_value>,
"domainaction": <string_value>,
"registeredstatus": <string_value>,
"domainuserpassword": <string_value>,
"domainuser": <string_value>,
"leaveorjoin": <string_value>
}}

MODIFY

Use this operation to trigger leave or join windows domain action

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"windows_domain":{
"domainname": <string_value>,
"domainaction": <string_value>,
"domainuserpassword": <string_value>,
"domainuser": <string_value>,
"leaveorjoin": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"windows_domain":{
"domainname": <string_value>,
"registereddomain": <string_value>,
"registeredstatuserrormsg": <string_value>,
"domainaction": <string_value>,
"registeredstatus": <string_value>,
"domainuserpassword": <string_value>,
"domainuser": <string_value>,
"leaveorjoin": <string_value>
}}