[Index]
The model that stores the connection parameters of an LDAP server.
Model ref.: data/Ldap
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"advanced_configuration": {
"properties": {
"custom_pk": {
"type": "string",
"description": "This field allows an administrator to specify the primary key attribute that will be used to retrieve records from the ldap server.",
"title": "Primary Key Attribute"
}
},
"type": "object",
"description": "Advanced configuration settings.",
"title": "Advanced Configuration"
},
"search_filter": {
"required": false,
"type": "string",
"description": "A RFC 2254 conformant string that is used to restrict the results retuned by list operations on the LDAP server.",
"title": "Search Filter"
},
"description": {
"required": false,
"type": "string",
"description": "The description of the LDAP server.",
"title": "Description"
},
"allow_write_back": {
"default": false,
"type": "boolean",
"description": "Enables Add, Modify and Delete operations for users on the the LDAP server.",
"title": "Enable Write Operations"
},
"user_dn": {
"required": true,
"type": "string",
"description": "The User Distinguished Name (DN) on the LDAP server.",
"title": "User DN"
},
"server_type": {
"choices": [
{
"value": "microsoft_active_directory",
"title": "Microsoft Active Directory"
},
{
"value": "open_ldap",
"title": "Open LDAP"
}
],
"required": true,
"type": "string",
"description": "The selected LDAP server type. The type can be Open LDAP or Microsoft Active Directory.",
"title": "Server Type"
},
"authentication": {
"properties": {
"scope": {
"default": "Down",
"choices": [
{
"value": "Local",
"title": "Current hierarchy level only"
},
{
"value": "Down",
"title": "Current hierarchy level and below"
}
],
"type": "string",
"description": "Hierarchical scope this server applies to",
"title": "Authentication Scope"
},
"auth_enabled": {
"default": true,
"type": "boolean",
"description": "Authentication Enabled",
"title": "Authentication Enabled"
},
"user_type": {
"default": "Synced_only",
"choices": [
{
"value": "Synced_only",
"title": "LDAP synced users only"
},
{
"value": "All",
"title": "All users"
}
],
"type": "string",
"description": "Type of users that can authenticate against this server.",
"title": "User Sync Type"
}
},
"type": "object",
"description": "Authentication settings.",
"title": "Authentication settings"
},
"auth_attribute": {
"required": false,
"type": "object",
"properties": {
"model_type": {
"choices": [
{
"value": "device/ldap/inetOrgPerson",
"title": "device/ldap/inetOrgPerson"
},
{
"value": "device/ldap/person",
"title": "device/ldap/person"
},
{
"value": "device/ldap/user",
"title": "device/ldap/user"
}
],
"required": false,
"type": "string",
"description": "The model type to be used for authentication. The defualt choices are device/ldap/inetOrgPerson, device/ldap/person, and device/ldap/user. If the default choices do not fit the deployment scenario, custom values are allowed for this field.",
"title": "Model Type"
},
"name": {
"required": false,
"type": "string",
"description": "The selected attribute of the LDAP user login. When Server Type is Microsoft Active Directory, the following default choices are populated employeeNumber, mail, sAMAccountName, telephoneNumber, userPrincipalName. When Server Type is Open LDAP, the following choices are populated employeeNumber, mail, telephoneNumber, uid. If the default choices do not fit the deployment, custom values are allowed for this field.",
"title": "Login Attribute Name"
}
},
"title": "Authentication Attribute"
},
"host": {
"required": true,
"type": "string",
"description": "The host name of the LDAP server.",
"title": "Host Name"
},
"data_sync_list": {
"items": {
"type": "object",
"properties": {
"model_type": {
"description": "Model type whose attributes should be included (eg device/ldap/user)",
"title": "Model Type",
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"attributes": {
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
}
}
},
"type": "array",
"description": "Attributes to be included for model type.",
"title": "Attributes"
}
}
},
"type": "array",
"description": "LDAP attributes to be included during data sync.",
"title": "Data Sync List"
},
"connection_security": {
"type": "object",
"properties": {
"encryption_method": {
"default": "no_encryption",
"choices": [
{
"value": "no_encryption",
"title": "No Encryption"
},
{
"value": "ssl",
"title": "Use SSL Encryption (ldaps://)"
},
{
"value": "start_tls",
"title": "Use StartTLS Extension"
}
],
"type": "string",
"description": "The encryption mechanism to be used. This can be No Encryption, Use SSL Encryption (ldaps://), or Use StartTLS Extension",
"title": "Encryption Method"
},
"certificate_validation": {
"properties": {
"server_root_certificate": {
"target": "/api/data/File/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Server Root Certificate",
"format": "uri",
"choices": [],
"target_model_type": "data/File",
"type": "string",
"description": "When trust_all is False, the LDAP server's SSL certificate will be validated against this root certificate. If this certificate is not specified, validation will done against any existing trusted CA certificates. Use this option for custom root certificates in (.pem format)"
},
"trust_all": {
"type": "boolean",
"description": "When enabled, the system will not check if the server's certificate is trusted.",
"title": "Trust All"
}
},
"type": "object",
"description": "Specifies behavior for certificate validation eg. Trust all certificates (no validation).",
"title": "Certificate Validation"
}
},
"title": "Connection Security"
},
"password": {
"is_password": true,
"description": "The administrator Password associated with the Username to connect to the LDAP server.",
"title": "Admin Password",
"required": true,
"store_encrypted": true,
"type": "string"
},
"port": {
"default": "389",
"type": "string",
"description": "The port number for LDAP traffic. The ports a fully configurable.",
"title": "Port"
},
"search_base_dn": {
"required": true,
"type": "string",
"description": "The base Distinguished Name for LDAP search.",
"title": "Search Base DN"
}
},
"schema_version": "0.3.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/Ldap/add/ |
|
The GUI Add form of data/Ldap as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/Ldap | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/Ldap/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Ldap/[pkid1]", "/api/data/Ldap/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Ldap/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/Ldap/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/Ldap/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/Ldap/[pkid1]", "/api/v0/data/Ldap/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/Ldap/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Ldap; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Ldap/export/ |
|
{ "hrefs":["/api/data/Ldap/[pkid1]", "/api/data/Ldap/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/Ldap and the JSON format can be used to import instances of data/Ldap.
GET http://[host-proxy]/api/data/Ldap/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Ldap | POST | /api/data/Ldap/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/Ldap/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/Ldap/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/Ldap/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Ldap/ |
|
The data/Ldap schema and all instances as JSON. |
(The list will return 0 to 3 data/Ldap instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "description",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/Ldap/?skip=0&limit=3&order_by=description&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 4
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port",
"search_base_dn"
]
},
"schema_version": "0.3.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/Ldap/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Ldap/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/Ldap/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Ldap/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/Ldap/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/Ldap/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/Ldap/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/Ldap/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/Ldap/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Ldap/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Ldap",
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"import",
"list",
"migration",
"remove",
"test_connect",
"update"
],
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6130e8c4e04a4a0015a9d647",
"meta": {
"tags": [],
"cached": true,
"title": "10.120.2.221 - 636 - OU=VOSSSOL9557,DC=vossqa,DC=net",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port",
"search_base_dn"
]
},
"schema_version": "0.3.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6130e8c4e04a4a0015a9d647",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"test_connect": {
"support_async": false,
"class": "test_connect",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/test_connect/",
"method": "POST",
"title": "Test Connection"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Ldap",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"6130e8c4e04a4a0015a9d647"
],
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "AAAGlobal",
"server_type": "microsoft_active_directory",
"pkid": "6130e8c4e04a4a0015a9d648",
"user_dn": "CN=administrator,CN=Users,DC=vossqa,DC=net",
"auth_attribute": {
"model_type": "device/ldap/user",
"name": "sAMAccountName"
},
"connection_security": {
"encryption_method": "ssl",
"certificate_validation": {
"trust_all": true
}
},
"search_base_dn": "OU=VOSSSOL9557,DC=vossqa,DC=net",
"host": "10.120.2.221",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"password": "==$R4WZSjI9tWbD9elL$yC7lfSCAKHQ=$==",
"port": "636",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5f3ae5bfce894e0012055af1",
"meta": {
"tags": [],
"cached": true,
"title": "10.120.2.221 - 389 - OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port",
"search_base_dn"
]
},
"schema_version": "0.3.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5bfce894e0012055af1",
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/"
}
],
"parent": [
{
"pkid": "5f3ae5bace894e00120559f8",
"href": "/api/data/HierarchyNode/5f3ae5bace894e00120559f8"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"test_connect": {
"support_async": false,
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/test_connect/",
"title": "Test Connection",
"class": "test_connect",
"method": "POST"
}
},
{
"import": {
"support_async": true,
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/Ldap/5f3ae5bfce894e0012055af1/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/Ldap",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae5bfce894e0012055af1"
],
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "AB_Group-Civil LDAP Server",
"server_type": "microsoft_active_directory",
"pkid": "5f3ae5bfce894e0012055af2",
"user_dn": "CN=Administrator,CN=Users,DC=vossqa,DC=net",
"auth_attribute": {
"model_type": "device/ldap/user",
"name": "sAMAccountName"
},
"connection_security": {
"encryption_method": "no_encryption"
},
"search_base_dn": "OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net",
"host": "10.120.2.221",
"hierarchy_friendly_name": "AB-C (IntermediateNode)",
"password": "==$gv0RN5CcdTgk1XuT$V7rCw2G98qM=$==",
"port": "389",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C"
}
},
{
"pkid": "5f3ae5cbce894e0012055cd0",
"meta": {
"tags": [],
"cached": true,
"title": "10.120.2.221 - 389 - OU=AB-DS,OU=AB-GROUP,DC=vossqa,DC=net",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port",
"search_base_dn"
]
},
"schema_version": "0.3.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5cbce894e0012055cd0",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/"
}
],
"parent": [
{
"pkid": "5f3ae5bbce894e0012055a46",
"href": "/api/data/HierarchyNode/5f3ae5bbce894e0012055a46"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"test_connect": {
"support_async": false,
"method": "POST",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/test_connect/",
"class": "test_connect",
"title": "Test Connection"
}
},
{
"import": {
"support_async": true,
"class": "import",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/import/",
"method": "POST",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/Ldap/5f3ae5cbce894e0012055cd0/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/Ldap",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bbce894e0012055a46",
"5f3ae5cbce894e0012055cd0"
],
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "AB_Group-D&S LDAP Server",
"server_type": "microsoft_active_directory",
"pkid": "5f3ae5cbce894e0012055cd1",
"user_dn": "CN=Administrator,CN=Users,DC=vossqa,DC=net",
"auth_attribute": {
"model_type": "device/ldap/user",
"name": "sAMAccountName"
},
"connection_security": {
"encryption_method": "no_encryption"
},
"search_base_dn": "OU=AB-DS,OU=AB-GROUP,DC=vossqa,DC=net",
"host": "10.120.2.221",
"hierarchy_friendly_name": "AB-DS (IntermediateNode)",
"password": "==$Ra8BlVGurHwSJ6pL$/GVbvSzfLRA=$==",
"port": "389",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-DS"
}
}
]
}
(Show the first instance)
{
"pkid": "6130e8c4e04a4a0015a9d647",
"meta": {
"tags": [],
"cached": false,
"title": "10.120.2.221 - 636 - OU=VOSSSOL9557,DC=vossqa,DC=net",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port",
"search_base_dn"
]
},
"schema_version": "0.3.1",
"references": {
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"self": [
{
"pkid": "6130e8c4e04a4a0015a9d647",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"test_connect": {
"support_async": false,
"class": "test_connect",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/test_connect/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Test Connection"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Ldap/6130e8c4e04a4a0015a9d647/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Ldap",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"6130e8c4e04a4a0015a9d647"
],
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"description": "AAAGlobal",
"server_type": "microsoft_active_directory",
"pkid": "6130e8c4e04a4a0015a9d648",
"user_dn": "CN=administrator,CN=Users,DC=vossqa,DC=net",
"port": "636",
"host": "10.120.2.221",
"connection_security": {
"encryption_method": "ssl",
"certificate_validation": {
"trust_all": true
}
},
"password": "==$R4WZSjI9tWbD9elL$yC7lfSCAKHQ=$==",
"auth_attribute": {
"model_type": "device/ldap/user",
"name": "sAMAccountName"
},
"search_base_dn": "OU=VOSSSOL9557,DC=vossqa,DC=net"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Ldap. | GET | /api/data/Ldap/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Ldap as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Ldap/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Ldap/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Ldap/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Ldap/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Test Connection | POST | /api/data/Ldap/[pkid]/test_connect | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/Ldap/[pkid]/import | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/Ldap; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Ldap/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/Ldap and the JSON format can be used to import instances of data/Ldap.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Ldap/[pkid] | hierarchy=[hierarchy] | The data/Ldap instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Ldap/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Ldap. |