directoryservices.leave

Leave an Active Directory or IPA domain. Calling this endpoint when the directory services status is HEALTHY will cause TrueNAS to remove its account from the domain and then reset the local directory services configuration on TrueNAS.

This method is a job.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: credential

credential

Type: object

DirectoryServicesLeaveArgs parameters.

 No Additional Properties

CredKRBUser

Type: object

Kerberos user credentials with administrative privileges to leave the domain.

 No Additional Properties

Credential Type

Type: const

Credential type identifier for Kerberos user authentication.

Specific value: "KERBEROS_USER"

Username

Type: string

Username of the account to use to create a kerberos ticket for authentication to directory services. This account must exist on the domain controller.

Must be at least 1 characters long

Password

Type: string

The password for the user account that will obtain the kerberos ticket.

Must be at least 1 characters long

Result

Type: null


Required roles: DIRECTORY_SERVICE_WRITE