Working with Active Directory
You can use Connector Appliance to connect a resource location to forests which do not contain Citrix Virtual Apps and Desktops resources. For example, in the case of Citrix Secure Private Access customers or Citrix Virtual Apps and Desktops customers with some forests only used for user authentication.
For more information about the requirements for using Connector Appliance with Active Directory, see the product documentation.
List currently joined Active Directory domains
Use this call to list the domains that this Connector Appliance is joined to.
Request
GET /domains HTTP/1.1
Accept: */*
Host: <connector-appliance-ip-address>
Authorization: Bearer <token>
<!--NeedCopy-->
Response
HTTP/1.1 200 OK
...
{
"items": [
{
"domain_name": "<ad-domain-name>",
"forest": "<ad-forest-name>",
"machine_account": "<connector-appliance-machine-account-name>"
}
]
}
<!--NeedCopy-->
Join an Active Directory domain
Use this call to join the Connector Appliance to an Active Directory domain.
The values that you use in this call must meet the following requirements:
- The credentials (
user_nameandpassword) given must have the right to create a machine account on the domain. - The value of the
machine_accountfield must be a maximum of 15 characters long and not clash with any existing machine account on the domain controller.
Request
POST /domains HTTP/1.1
Accept: */*
Authorization: Bearer <token>
Host: <connector-appliance-ip-address>
Content-Type: application/json
...
{"domain_name": "<ad-domain-name>", "user_name": "<ad-user>", "password": "<password>", "machine_account": "<connector-appliance-machine-account-name>"}
<!--NeedCopy-->
Response
HTTP/1.1 200 OK
<!--NeedCopy-->
Leave an Active Directory domain
Use this call to remove the Connector Appliance from an Active Directory domain.
Request
DELETE /domains/<ad-domain-name>
Host: <connector-appliance-ip-address>
Authorization: Bearer <token>
<!--NeedCopy-->
Responses
Success
HTTP/1.1 204 No Content
<!--NeedCopy-->
Domain not found
HTTP/1.1 404 Not Found
...
{
"type": "https://errors-api.cloud.com/common/notFound",
"detail": "Not found",
"parameters": [
{
"name": "entityType",
"value": "https://identifiers-api.cloud.com/connapp/domain"
},
{
"name": "id",
"value": ""
}
]
}
<!--NeedCopy-->
The domain was not found on the Connector Appliance. As a result, the Connector Appliance cannot leave the domain. Check that the domain name in the request is correct.