Description:
Create a new Active Directory configuration.
Precondition:
Right 🔓 change global config of the Provider Customer required.
Postcondition:
New Active Directory configuration created.
Further Information:
None.
643 matches
100 actions
DRACOON
100 actions
Infrastructure/DRACOON
Create a new Active Directory configuration.
Right 🔓 change global config of the Provider Customer required.
New Active Directory configuration created.
None.
{
"type": "object",
"properties": {
"X-Sds-Auth-Token": {
"type": "string"
},
"adExportGroup": {
"type": "string",
"description": "If `userImport` is set to `true`,\n\nthe user must be member of this Active Directory group to receive a newly created DRACOON account."
},
"alias": {
"type": "string",
"description": "Unique name for an Active Directory configuration"
},
"createHomeFolder": {
"type": "boolean",
"description": "DEPRECATED, will be ignored\n\nDetermines whether a room is created for each user that is created by automatic import (like a home folder).\n\nRoom's name will equal the user's login name."
},
"homeFolderParent": {
"type": "integer",
"format": "int64",
"description": "DEPRECATED, will be ignored\n\nID of the room in which the individual rooms for users will be created."
},
"ldapUsersDomain": {
"type": "string",
"description": "Search scope of Active Directory; only users below this node can log on."
},
"sdsImportGroup": {
"type": "integer",
"format": "int64",
"description": "User group that is assigned to users who are created by automatic import.\n\nReset with `0`"
},
"serverAdminName": {
"type": "string",
"description": "Distinguished Name (DN) of Active Directory administrative account"
},
"serverAdminPassword": {
"type": "string",
"description": "Password of Active Directory administrative account"
},
"serverIp": {
"type": "string",
"description": "IPv4 or IPv6 address or host name"
},
"serverPort": {
"type": "integer",
"format": "int32",
"description": "Port"
},
"sslFingerPrint": {
"type": "string",
"description": "SSL finger print of Active Directory server.\n\nMandatory for LDAPS connections.\n\nFormat: `Algorithm/Fingerprint`"
},
"useLdaps": {
"type": "boolean",
"description": "Determines whether LDAPS should be used instead of plain LDAP."
},
"userFilter": {
"type": "string",
"description": "Name of Active Directory attribute that is used as login name."
},
"userImport": {
"type": "boolean",
"description": "Determines if a DRACOON account is automatically created for a new user\n\nwho successfully logs on with his / her AD / IDP account."
}
},
"required": [
"alias",
"ldapUsersDomain",
"serverAdminName",
"serverAdminPassword",
"serverIp",
"serverPort",
"userFilter"
],
"additionalProperties": false
}{
"type": "object",
"description": "Active Directory configuration",
"required": [
"adExportGroup",
"alias",
"id",
"ldapUsersDomain",
"serverAdminName",
"serverIp",
"serverPort",
"useLdaps",
"userFilter",
"userImport"
],
"properties": {
"adExportGroup": {
"type": "string",
"description": "If `userImport` is set to `true`,\n\nthe user must be member of this Active Directory group to receive a newly created DRACOON account."
},
"alias": {
"type": "string",
"description": "Unique name for an Active Directory configuration"
},
"createHomeFolder": {
"type": "boolean",
"description": "🚧 Deprecated since v4.10.0\n\nDEPRECATED, will be ignored\n\nDetermines whether a room is created for each user that is created by automatic import (like a home folder).\n\nRoom's name will equal the user's login name."
},
"homeFolderParent": {
"type": "integer",
"format": "int64",
"description": "🚧 Deprecated since v4.10.0\n\nDEPRECATED, will be ignored\n\nID of the room in which the individual rooms for users will be created."
},
"id": {
"type": "integer",
"format": "int32",
"description": "ID"
},
"ldapUsersDomain": {
"type": "string",
"description": "Search scope of Active Directory; only users below this node can log on."
},
"sdsImportGroup": {
"type": "integer",
"format": "int64",
"description": "User group that is assigned to users who are created by automatic import.\n\nReset with `0`"
},
"serverAdminName": {
"type": "string",
"description": "Distinguished Name (DN) of Active Directory administrative account"
},
"serverIp": {
"type": "string",
"description": "IPv4 or IPv6 address or host name"
},
"serverPort": {
"type": "integer",
"format": "int32",
"description": "Port"
},
"sslFingerPrint": {
"type": "string",
"description": "SSL finger print of Active Directory server.\n\nMandatory for LDAPS connections.\n\nFormat: `Algorithm/Fingerprint`"
},
"useLdaps": {
"type": "boolean",
"description": "Determines whether LDAPS should be used instead of plain LDAP."
},
"userFilter": {
"type": "string",
"description": "Name of Active Directory attribute that is used as login name."
},
"userImport": {
"type": "boolean",
"description": "Determines if a DRACOON account is automatically created for a new user\n\nwho successfully logs on with his / her AD / IDP account."
}
}
}