[Index]

API Reference for view/LdapSyncList

View to assist user to create an initial set of Ldap Sync List attributes

Model ref.: view/LdapSyncList

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/view/LdapSyncList/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "note": {
               "type": "string",
               "description": "Note about certain fields that will always get synced.",
               "title": "Note"
          },
          "ldap_sync_list_option": {
               "description": "LDAP Sync List Option. Please Note: LDAP server sync will always sync in the following attributes, regardless of whether they are explicitly set in the sync list or not. (sAMAccountName, userPrincipalName, mail, cn, uid, description)",
               "title": "LDAP Sync List Option",
               "default": "none",
               "choices": [
                    {
                         "value": "none",
                         "title": "No sync list - all fields will be synced"
                    },
                    {
                         "value": "manual",
                         "title": "Create sync list manually"
                    },
                    {
                         "value": "template",
                         "title": "Create sync list from template"
                    }
               ],
               "type": "string"
          },
          "ldap_sync_list_template": {
               "type": "string",
               "description": "LDAP Sync List Template. A template contains a predefined list of fields that is normally used when syncing in LDAP servers.",
               "title": "LDAP Sync List Template"
          },
          "ldap_sync_list_template_flag": {
               "type": "boolean",
               "description": "Flag to see if we need to show the LDAP Sync List Template field",
               "title": "LDAP Sync List Template Flag"
          }
     },
     "schema_version": "0.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/LdapSyncList/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/LdapSyncList 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/view/LdapSyncList	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Task	Call	URL	Parameters	Response
Tag	PATCH	/api/view/LdapSyncList/+tag/	hierarchy=[hierarchy] format=json

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/view/LdapSyncList/[pkid]/+tag	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get	GET	/api/view/LdapSyncList/[pkid]	hierarchy=[hierarchy]	The view/LdapSyncList instance with [pkid].

API Reference for view/LdapSyncList

GET http://[host-proxy]/api/view/LdapSyncList/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Tag

Instance API Reference

Tag

Get