[Index]
HcsLdapUserSyncDAT
Model ref.: data/HcsLdapUserSyncDAT
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": { "info": { "is_password": false, "description": "Information regarding the specified action.", "title": "Information", "required": false, "displayable": true, "readonly": false, "maxLength": 1024, "type": "string" }, "FieldMapping": { "is_password": false, "title": "Field Mapping", "required": false, "displayable": false, "readonly": false, "type": "object", "properties": { "directoryUri": { "is_password": false, "description": "The LDAP field mapped to the user's directory URI.", "title": "Directory URI", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customString2": { "is_password": false, "description": "The LDAP field mapped to a custom string.", "title": "Custom String 2", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "objectClass": { "is_password": false, "title": "Object Class", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "unverifiedMailBox": { "is_password": false, "description": "The LDAP field mapped to the user's unverified mailbox.", "title": "Unverified Mail Box", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "ldap_username": { "is_password": false, "description": "The LDAP field mapped to the user's login attribute.", "title": "LDAP Username", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "manager": { "is_password": false, "description": "The LDAP field mapped to the user's manager.", "title": "Manager", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "street": { "is_password": false, "description": "The LDAP field mapped to the user's street.", "title": "Street", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "timezone": { "is_password": false, "description": "The LDAP field mapped to the user's time zone.", "title": "Timezone", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "uid": { "is_password": false, "description": "The LDAP field mapped to the user's userid.", "title": "Uid", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "jabberID": { "is_password": false, "description": "The LDAP field mapped to the user's Jabber ID.", "title": "Jabber ID", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "buildingName": { "is_password": false, "description": "The LDAP field mapped to the user's building name.", "title": "Building Name", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "employeeType": { "is_password": false, "description": "The LDAP field mapped to the user's employee type.", "title": "Employee Type", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "otherMailbox": { "is_password": false, "title": "Other Mailbox", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "title": { "is_password": false, "description": "The LDAP field mapped to the user's title.", "title": "Title", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "facsimileTelephoneNumber": { "is_password": false, "description": "The LDAP field mapped to the user's FAX number.", "title": "Facsimile Telephone Number", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customString4": { "is_password": false, "description": "The LDAP field mapped to a custom string.", "title": "Custom String 4", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "data_username": { "is_password": false, "description": "The LDAP field mapped to the user's login attribute for local authentication.", "title": "Data Username", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "postalCode": { "is_password": false, "description": "The LDAP field mapped to the user's postal code.", "title": "Postal Code", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "mail": { "is_password": false, "description": "The LDAP field mapped to the user's email address.", "title": "Mail", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customString3": { "is_password": false, "description": "The LDAP field mapped to a custom string.", "title": "Custom String 3", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "departmentNumber": { "is_password": false, "description": "The LDAP field mapped to the user's department number.", "title": "Department Number", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customString1": { "is_password": false, "description": "The LDAP field mapped to a custom string.", "title": "Custom String 1", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customString5": { "is_password": false, "description": "The LDAP field mapped to a custom string.", "title": "Custom String 5", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "photoURL": { "is_password": false, "description": "The LDAP field mapped to the user's photo URL.", "title": "Photo URL", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "employeeNumber": { "is_password": false, "description": "The LDAP field mapped to the user's employee number.", "title": "Employee Number", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "physicalDeliveryOfficeName": { "is_password": false, "description": "The LDAP field mapped to the user's post office.", "title": "Physical Delivery Office Name", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customListOfStrings2": { "is_password": false, "description": "The LDAP field mapped to a custom list of strings.", "title": "Custom List of Strings 2", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customListOfStrings3": { "is_password": false, "description": "The LDAP field mapped to a custom list of strings.", "title": "Custom List of Strings 3", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customListOfStrings4": { "is_password": false, "description": "The LDAP field mapped to a custom list of strings.", "title": "Custom List of Strings 4", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customListOfStrings5": { "is_password": false, "description": "The LDAP field mapped to a custom list of strings.", "title": "Custom List of Strings 5", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "homePhone": { "is_password": false, "description": "The LDAP field mapped to the user's home phone number.", "title": "Home Phone", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "telephoneNumber": { "is_password": false, "description": "The LDAP field mapped to the user's telephone number.", "title": "Telephone Number", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "c": { "is_password": false, "description": "The LDAP field mapped to the user's country.", "title": "C", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "displayName": { "is_password": false, "description": "The LDAP field mapped to the user's display name.", "title": "Display Name", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "mobile": { "is_password": false, "description": "The LDAP field mapped to the user's mobile phone number.", "title": "Mobile", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "memberOf": { "is_password": false, "description": "The LDAP field mapped to the user's groups.", "title": "Member Of", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "customListOfStrings1": { "is_password": false, "description": "The LDAP field mapped to a custom list of strings.", "title": "Custom List of Strings 1", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "l": { "is_password": false, "description": "The LDAP field mapped to the user's city.", "title": "L", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "o": { "is_password": false, "description": "The LDAP field mapped to the user's organization name.", "title": "O", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "st": { "is_password": false, "description": "The LDAP field mapped to the user's state.", "title": "St", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "preferredLanguage": { "is_password": false, "description": "The LDAP field mapped to the user's preferred language.", "title": "Preferred Language", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "sn": { "is_password": false, "description": "The LDAP field mapped to the user's last name.", "title": "Sn", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "ou": { "is_password": false, "description": "The LDAP field mapped to the user's organization unit name.", "title": "Ou", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "givenName": { "is_password": false, "description": "The LDAP field mapped to the user's first name.", "title": "Given Name", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "ipPhone": { "is_password": false, "description": "The LDAP field mapped to the user's IP phone number.", "title": "IP Phone", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "ldapAuthOnly": { "is_password": false, "description": "This LDAP Server is only used fo Authentication purpose.", "title": "LDAP Authentication Only", "default": "false", "required": false, "displayable": false, "readonly": false, "type": "boolean" }, "userModelType": { "is_password": false, "description": "The LDAP model type for users.", "title": "User Model Type", "default": "device/ldap/user", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "userMoveMode": { "is_password": false, "description": "The behavior for moving users to site. Setting this value to Automatic will trigger the system to apply the move filters (refer to User Management) automatically when users are sync'd into the system. Automatic is only applicable to creating new users. Setting this value to Manual means that users must be moved to site by an Adminstrator (refer to User Management).", "title": "User Move Mode", "default": "Automatic", "required": false, "displayable": false, "choices": [ { "value": "Automatic", "title": "Automatic" }, { "value": "Manual", "title": "Manual" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "userPurgeMode": { "is_password": false, "title": "User Purge Mode", "default": "Automatic", "required": false, "displayable": false, "choices": [ { "value": "Automatic", "title": "Automatic" }, { "value": "Manual", "title": "Manual" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "userDeleteMode": { "is_password": false, "description": "The behavior for handling users who are deleted from the LDAP directory. Setting this value to Automatic will trigger the system to automatically delete system settings associated with the user. Setting this value to Manual means that users deleted from the LDAP directory are no longer LDAP Integrated. Manual action by an Administrator is required to remove user settings.", "title": "User Delete Mode", "default": "Manual", "required": false, "displayable": false, "choices": [ { "value": "Automatic", "title": "Automatic" }, { "value": "Manual", "title": "Manual" } ], "readonly": false, "maxLength": 1024, "type": "string" }, "ldapServer": { "is_password": false, "description": "The assoicated LDAP server host.", "format": "uri", "title": "LDAP Server", "required": false, "displayable": false, "choices": [], "readonly": false, "maxLength": 1024, "target_model_type": "data/Ldap", "type": "string", "target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "userEntitlementProfile": { "is_password": false, "description": "The default user server profile for users added via sync.", "format": "uri", "title": "User Entitlement Profile", "required": false, "displayable": false, "choices": [], "readonly": false, "maxLength": 1024, "target_model_type": "data/HcsEntitlementProfileDAT", "type": "string", "target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "userRole": { "is_password": false, "description": "The default role to assign to the synced user (if no other LDAP Custom Role Mappings are applicable for the synced user, then this fallback/default role will be applied).", "format": "uri", "title": "User Role (default)", "required": false, "displayable": false, "choices": [], "target_attr": "name", "readonly": false, "maxLength": 1024, "target_model_type": "data/Role", "type": "string", "target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "userLanguage": { "is_password": false, "description": "The default user language for users added via sync.", "format": "uri", "title": "User Language", "required": false, "displayable": false, "choices": [], "target_attr": "name", "readonly": false, "maxLength": 1024, "target_model_type": "data/Language", "type": "string", "target": "/api/data/Language/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "userMappingAttr": { "is_password": false, "description": "This field is the attribute from NormalizedUser, which will be used for creating LdapUser. And this value will be used for LDAP Authentication against LDAP when LDAP Authentication Only is checked.", "title": "LDAP Authentication Attribute", "required": false, "displayable": false, "choices": [ { "value": " ", "title": " " } ], "readonly": false, "maxLength": 1024, "type": "string" } }, "schema_version": "2.5" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/HcsLdapUserSyncDAT/add/ |
|
The GUI Add form of data/HcsLdapUserSyncDAT 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/HcsLdapUserSyncDAT/ | 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/HcsLdapUserSyncDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsLdapUserSyncDAT/[pkid1]", "/api/data/HcsLdapUserSyncDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsLdapUserSyncDAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsLdapUserSyncDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsLdapUserSyncDAT/export/ |
|
{ "hrefs":["/api/data/HcsLdapUserSyncDAT/[pkid1]", "/api/data/HcsLdapUserSyncDAT/[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/HcsLdapUserSyncDAT and the JSON format can be used to import instances of data/HcsLdapUserSyncDAT.
GET http://[host-proxy]/api/data/HcsLdapUserSyncDAT/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/HcsLdapUserSyncDAT | POST | /api/data/HcsLdapUserSyncDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/HcsLdapUserSyncDAT/ |
|
The data/HcsLdapUserSyncDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsLdapUserSyncDAT 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": "ldapServer", "maximum_limit": 2000, "skip": 0, "current": "/api/data/HcsLdapUserSyncDAT/?skip=0&limit=3&order_by=ldapServer&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 4 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "2.5", "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/HcsLdapUserSyncDAT/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsLdapUserSyncDAT/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/HcsLdapUserSyncDAT/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/HcsLdapUserSyncDAT/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/HcsLdapUserSyncDAT/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/HcsLdapUserSyncDAT/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/HcsLdapUserSyncDAT", "model_specific_actions": [ "list", "get", "add", "update", "remove", "import", "execute", "export", "export_bulkload_template", "help" ], "summary_attrs": [ { "name": "ldapServer", "title": "LDAP Server" }, { "name": "userModelType", "title": "User Model Type" }, { "name": "userEntitlementProfile", "title": "User Entitlement Profile" }, { "name": "userRole", "title": "User Role (default)" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "61b1a9c7eadb826afd88531d", "meta": { "tags": [], "cached": true, "title": "title format", "business_key": {}, "schema_version": "2.5", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b1a9c7eadb826afd88531d", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [ { "pkid": "61b1a9bdeadb826afd8851bc", "path": "ldapServer", "model_type": "data/Ldap" }, { "pkid": "61b12ee7eadb826afd7b7433", "path": "userRole", "model_type": "data/Role" } ] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/", "method": "DELETE", "title": "Delete" } }, { "import": { "support_async": true, "method": "POST", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/import/", "class": "import", "title": "Import" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "execute": { "support_async": true, "class": "execute", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/execute/", "method": "POST", "title": "Execute" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/help", "method": "GET", "title": "Help" } } ], "model_type": "data/HcsLdapUserSyncDAT", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1a9c7eadb826afd88531d" ], "summary_attrs": [ { "name": "ldapServer", "title": "LDAP Server" }, { "name": "userModelType", "title": "User Model Type" }, { "name": "userEntitlementProfile", "title": "User Entitlement Profile" }, { "name": "userRole", "title": "User Role (default)" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "FieldMapping": { "directoryUri": "mail", "objectClass": "objectClass", "ldap_username": "sAMAccountName", "manager": "manager", "street": "streetAddress", "uid": "uid", "employeeType": "employeeType", "otherMailbox": "otherMailbox", "title": "title", "facsimileTelephoneNumber": "facsimileTelephoneNumber", "data_username": "sAMAccountName", "postalCode": "postalCode", "mail": "mail", "departmentNumber": "department", "photoURL": "photo", "employeeNumber": "employeeNumber", "displayName": "displayName", "homePhone": "homePhone", "telephoneNumber": "telephoneNumber", "c": "c", "physicalDeliveryOfficeName": "physicalDeliveryOfficeName", "mobile": "mobile", "memberOf": "memberOf", "l": "l", "o": "o", "st": "st", "preferredLanguage": "preferredLanguage", "sn": "sn", "ou": "ou", "givenName": "givenName", "ipPhone": "ipPhone" }, "ldapAuthOnly": false, "userModelType": "device/ldap/user", "userMoveMode": "Automatic", "pkid": "61b1a9c7eadb826afd88531f", "userPurgeMode": "Automatic", "ldapServer": "[\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "userRole": "AAAGlobalSelfService", "hierarchy_friendly_name": "AAAGlobal (Customer)", "userDeleteMode": "Manual", "userMappingAttr": "sAMAccountName", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } }, { "pkid": "61b1a6b9eadb826afd87c8d2", "meta": { "tags": [], "cached": true, "title": "title format", "business_key": {}, "schema_version": "2.5", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b1a6b9eadb826afd87c8d2", "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [ { "pkid": "61b1a6adeadb826afd87c762", "path": "ldapServer", "model_type": "data/Ldap" }, { "pkid": "61b13b98eadb826afd7ed59f", "path": "userEntitlementProfile", "model_type": "data/HcsEntitlementProfileDAT" }, { "pkid": "61b12ee7eadb826afd7b7433", "path": "userRole", "model_type": "data/Role" } ] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "import": { "support_async": true, "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/import/", "title": "Import", "method": "POST", "class": "import" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "execute": { "support_async": true, "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/execute/", "title": "Execute", "class": "execute", "method": "POST" } }, { "get": { "support_async": false, "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/data/HcsLdapUserSyncDAT/61b1a6b9eadb826afd87c8d2/help", "title": "Help", "class": "help", "method": "GET" } } ], "model_type": "data/HcsLdapUserSyncDAT", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1a6b9eadb826afd87c8d2" ], "summary_attrs": [ { "name": "ldapServer", "title": "LDAP Server" }, { "name": "userModelType", "title": "User Model Type" }, { "name": "userEntitlementProfile", "title": "User Entitlement Profile" }, { "name": "userRole", "title": "User Role (default)" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "FieldMapping": { "directoryUri": "mail", "objectClass": "objectClass", "ldap_username": "sAMAccountName", "manager": "manager", "street": "streetAddress", "uid": "uid", "employeeType": "employeeType", "otherMailbox": "otherMailbox", "title": "title", "facsimileTelephoneNumber": "facsimileTelephoneNumber", "data_username": "sAMAccountName", "postalCode": "postalCode", "mail": "mail", "departmentNumber": "department", "photoURL": "photo", "employeeNumber": "employeeNumber", "displayName": "displayName", "homePhone": "homePhone", "telephoneNumber": "telephoneNumber", "c": "c", "physicalDeliveryOfficeName": "physicalDeliveryOfficeName", "mobile": "mobile", "memberOf": "memberOf", "l": "l", "o": "o", "st": "st", "preferredLanguage": "preferredLanguage", "sn": "sn", "ou": "ou", "givenName": "givenName", "ipPhone": "ipPhone" }, "ldapAuthOnly": false, "userModelType": "device/ldap/user", "userMoveMode": "Automatic", "pkid": "61b1a6b9eadb826afd87c8d4", "userPurgeMode": "Automatic", "ldapServer": "[\"10.120.2.221\", \"389\", \"OU=RAV,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "userEntitlementProfile": "[\"RST Entitlement Profile\", \"hcs.CS-P\"]", "userRole": "AAAGlobalSelfService", "hierarchy_friendly_name": "AAAGlobal (Customer)", "userDeleteMode": "Manual", "userMappingAttr": "sAMAccountName", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } }, { "pkid": "61b1b2c8eadb826afd89f7b1", "meta": { "tags": [], "cached": true, "title": "title format", "business_key": {}, "schema_version": "2.5", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b1b2c8eadb826afd89f7b1", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [ { "pkid": "61b1b2beeadb826afd89f650", "path": "ldapServer", "model_type": "data/Ldap" }, { "pkid": "61b12ee3eadb826afd7b72e3", "path": "userRole", "model_type": "data/Role" } ] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/", "class": "delete", "title": "Delete" } }, { "import": { "support_async": true, "class": "import", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/import/", "method": "POST", "title": "Import" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "execute": { "support_async": true, "method": "POST", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/execute/", "class": "execute", "title": "Execute" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/data/HcsLdapUserSyncDAT/61b1b2c8eadb826afd89f7b1/help", "class": "help", "title": "Help" } } ], "model_type": "data/HcsLdapUserSyncDAT", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1b2c8eadb826afd89f7b1" ], "summary_attrs": [ { "name": "ldapServer", "title": "LDAP Server" }, { "name": "userModelType", "title": "User Model Type" }, { "name": "userEntitlementProfile", "title": "User Entitlement Profile" }, { "name": "userRole", "title": "User Role (default)" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "ldapAuthOnly": false, "userModelType": "device/ldap/user", "userMoveMode": "Automatic", "pkid": "61b1b2c8eadb826afd89f7b3", "userPurgeMode": "Automatic", "ldapServer": "[\"10.120.2.221\", \"389\", \"OU=TM,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "userRole": "AAAGlobalCustomerOperator", "hierarchy_friendly_name": "AAAGlobal (Customer)", "userDeleteMode": "Manual", "userMappingAttr": "sAMAccountName", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } } ] }
(Show the first instance)
{ "pkid": "61b1a9c7eadb826afd88531d", "meta": { "tags": [], "cached": false, "title": "title format", "business_key": {}, "schema_version": "2.5", "references": { "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "self": [ { "pkid": "61b1a9c7eadb826afd88531d", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/" } ], "foreign_key": [ { "pkid": "61b1a9bdeadb826afd8851bc", "path": "ldapServer", "model_type": "data/Ldap" }, { "pkid": "61b12ee7eadb826afd7b7433", "path": "userRole", "model_type": "data/Role" } ], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "import": { "support_async": true, "method": "POST", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/import/?hierarchy=[hierarchy]", "class": "import", "title": "Import" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "execute": { "support_async": true, "class": "execute", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/execute/?hierarchy=[hierarchy]", "method": "POST", "title": "Execute" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/HcsLdapUserSyncDAT/61b1a9c7eadb826afd88531d/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/HcsLdapUserSyncDAT", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1a9c7eadb826afd88531d" ], "summary_attrs": [ { "name": "ldapServer", "title": "LDAP Server" }, { "name": "userModelType", "title": "User Model Type" }, { "name": "userEntitlementProfile", "title": "User Entitlement Profile" }, { "name": "userRole", "title": "User Role (default)" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "FieldMapping": { "uid": "uid", "objectClass": "objectClass", "ldap_username": "sAMAccountName", "manager": "manager", "street": "streetAddress", "directoryUri": "mail", "employeeType": "employeeType", "otherMailbox": "otherMailbox", "title": "title", "facsimileTelephoneNumber": "facsimileTelephoneNumber", "data_username": "sAMAccountName", "postalCode": "postalCode", "mail": "mail", "departmentNumber": "department", "photoURL": "photo", "employeeNumber": "employeeNumber", "displayName": "displayName", "homePhone": "homePhone", "telephoneNumber": "telephoneNumber", "c": "c", "physicalDeliveryOfficeName": "physicalDeliveryOfficeName", "mobile": "mobile", "memberOf": "memberOf", "l": "l", "o": "o", "st": "st", "preferredLanguage": "preferredLanguage", "sn": "sn", "ou": "ou", "givenName": "givenName", "ipPhone": "ipPhone" }, "ldapAuthOnly": false, "userModelType": "device/ldap/user", "userMoveMode": "Automatic", "pkid": "61b1a9c7eadb826afd88531f", "userPurgeMode": "Automatic", "ldapServer": "[\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "userRole": "AAAGlobalSelfService", "userDeleteMode": "Manual", "userMappingAttr": "sAMAccountName" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/HcsLdapUserSyncDAT. | GET | /api/data/HcsLdapUserSyncDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsLdapUserSyncDAT as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/HcsLdapUserSyncDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/HcsLdapUserSyncDAT/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/HcsLdapUserSyncDAT/[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/HcsLdapUserSyncDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsLdapUserSyncDAT/[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/HcsLdapUserSyncDAT and the JSON format can be used to import instances of data/HcsLdapUserSyncDAT.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Execute | POST | /api/data/HcsLdapUserSyncDAT/[pkid]/execute/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/HcsLdapUserSyncDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsLdapUserSyncDAT instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/HcsLdapUserSyncDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsLdapUserSyncDAT. |