Skip to content

Join the configured AD domain

POST
/directory-services/active-directory/join
curl --request POST \
--url https://sylve.lan:8181/api/directory-services/active-directory/join \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "password": "example", "username": "example" }'

Uses supplied temporary credentials, the configured keytab, or the encrypted saved enrollment credentials. Temporary overrides are not saved.

Optional temporary overrides (empty for configured keytab or saved credentials)

Media typeapplication/json
object
password
string
username
string
Examplegenerated
{
"password": "example",
"username": "example"
}

OK

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Bad Gateway

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}