[Index]
Model ref.: relation/HcsLdapUserSyncREL
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"
},
"ldapWriteBackOnlyTemplate": {
"is_password": false,
"description": "The LDAP Configuration Template to use for Write Back.",
"title": "LDAP Write Back Template",
"required": false,
"displayable": false,
"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 for Authentication purpose.",
"title": "LDAP Authentication Only",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"UserFieldMapping": {
"type": "object",
"properties": {
"customString3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"customListOfStrings10": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 10"
},
"last_name": {
"type": "string",
"description": "The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "Last Name"
},
"customString7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"data_exist": {
"type": "boolean",
"description": "Flag to see if data exists for the server. If data exist the username and email fields will be disabled. These mappings cannot be changed once data exists.",
"title": "Data Exist"
},
"manager": {
"type": "string",
"description": "Manager.",
"title": "Manager"
},
"street": {
"type": "string",
"description": "Contains site information from a postal address.",
"title": "Street"
},
"postal_code": {
"type": "string",
"description": "Contains code used by a Postal Service to identify postal service zones.",
"title": "Postal Code"
},
"other_mailbox": {
"type": "string",
"description": "Other Mailbox.",
"title": "Other Mailbox"
},
"timezone": {
"type": "string",
"description": "Timezone.",
"title": "Timezone"
},
"customBoolean1": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"object_class": {
"type": "string",
"description": "Object Class.",
"title": "Object Class"
},
"customListOfStrings2": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 2"
},
"building_name": {
"type": "string",
"description": "Building name or number.",
"title": "Building Name"
},
"city": {
"type": "string",
"description": "Contains the name of a person's locality.",
"title": "City"
},
"first_name": {
"type": "string",
"description": "The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "First Name"
},
"jabber_id": {
"type": "string",
"description": "Jabber ID",
"title": "Jabber ID"
},
"display_name": {
"type": "string",
"description": "Display name of the user",
"title": "Display Name"
},
"customListOfStrings3": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 3"
},
"directory_uri": {
"type": "string",
"description": "Alphanumeric Directory URI (e.g. SIP URI)",
"title": "Directory URI"
},
"customBoolean10": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"customBoolean2": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"facsimile_telephone_number": {
"type": "string",
"description": "Facsimile Telephone Number",
"title": "Facsimile Telephone Number"
},
"customListOfStrings5": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 5"
},
"application": {
"target": "/api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Application name",
"format": "uri",
"required": true,
"choices": [],
"target_attr": "name",
"target_model_type": "data/UserSyncSource",
"type": "string",
"description": "Application name like CUCM, LDAP, CUC"
},
"state": {
"type": "string",
"description": "Contains full names of state or province.",
"title": "State"
},
"customListOfStrings6": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 6"
},
"home_phone": {
"type": "string",
"description": "Contains strings that represent the user's home phone number(s).",
"title": "Home Phone"
},
"department": {
"type": "string",
"description": "Department names and numbers.",
"title": "Department"
},
"customListOfStrings7": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 7"
},
"email": {
"required": false,
"type": "string",
"description": "The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "Email Address"
},
"username": {
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "User Name"
},
"customString2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"customString1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"physical_delivery_office_name": {
"type": "string",
"description": "Physical Delivery Office Name.",
"title": "Physical Delivery Office Name"
},
"description": {
"type": "string",
"description": "The description of the user mapping object.",
"title": "Description"
},
"customString5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"customString4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"title": {
"type": "string",
"description": "Title.",
"title": "Title"
},
"customString9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"customString8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"customListOfStrings8": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 8"
},
"customListOfStrings9": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 9"
},
"customListOfStrings1": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 1"
},
"employee_type": {
"type": "string",
"description": "Employee type",
"title": "Employee Type"
},
"password": {
"type": "string",
"description": "The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.",
"title": "Password"
},
"customListOfStrings4": {
"type": "string",
"description": "Custom List of Strings",
"title": "Custom List of Strings 4"
},
"unverified_mailbox": {
"type": "string",
"description": "Unverified Mail Box.",
"title": "Unverified Mail Box"
},
"customString6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"photo_url": {
"type": "string",
"description": "Photo URL.",
"title": "Photo URL"
},
"customBoolean7": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"customBoolean6": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"customBoolean5": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"customBoolean4": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"customBoolean3": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"name": {
"required": true,
"type": "string",
"description": "The name of the user mapping object.",
"title": "Name"
},
"preferred_language": {
"type": "string",
"description": "Preferred Language.",
"title": "Preferred Language"
},
"member_of": {
"type": "string",
"description": "The user can be a member of a variety of groups.",
"title": "Member Of"
},
"mobile": {
"type": "string",
"description": "Contains strings that represent the user's IP mobile number(s).",
"title": "Mobile"
},
"country": {
"type": "string",
"description": "Country name.",
"title": "Country"
},
"employee_number": {
"type": "string",
"description": "Employee number of the user",
"title": "Employee Number"
},
"telephone_number": {
"type": "string",
"description": "Telephone Number.",
"title": "Telephone Number"
},
"customBoolean9": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"customBoolean8": {
"type": "string",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"customString10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"ip_phone": {
"type": "string",
"description": "Contains strings that represent the user's IP phone number(s).",
"title": "IP Phone"
},
"model_type": {
"type": "string",
"description": "The model type used for this LDAP server.",
"title": "Model Type"
},
"organization": {
"type": "string",
"description": "The name of the person's organization.",
"title": "Organization"
},
"ou": {
"type": "string",
"description": "The name of the person's organization unit.",
"title": "Organizational Unit"
}
},
"title": "User Field Mapping"
},
"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"
},
"ldapWriteBackOnly": {
"is_password": false,
"description": "This LDAP Server is only used for write back purpose. This setting can be used when using a Microsoft AD onprem server that is synced to Microsoft Azure.",
"title": "LDAP Write Back Only",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"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,
"target_model_type": "data/Ldap",
"description": "The assoicated LDAP server host.",
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "LDAP Server",
"type": "string",
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"userEntitlementProfile": {
"is_password": false,
"target_model_type": "data/HcsEntitlementProfileDAT",
"description": "The default user server profile for users added via sync.",
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "User Entitlement Profile",
"type": "string",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"userRole": {
"is_password": false,
"target_model_type": "data/Role",
"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",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"title": "User Role (default)",
"type": "string",
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"shadow": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Shadow"
},
"userLanguage": {
"is_password": false,
"target_model_type": "data/Language",
"description": "The default user language for users added via sync.",
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"title": "User Language",
"type": "string",
"target": "/api/data/Language/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"userMappingAttr": {
"is_password": false,
"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": "LDAP Authentication Attribute",
"required": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsLdapUserSyncREL/add/ |
|
The GUI Add form of relation/HcsLdapUserSyncREL 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/relation/HcsLdapUserSyncREL | 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/relation/HcsLdapUserSyncREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsLdapUserSyncREL/[pkid1]", "/api/relation/HcsLdapUserSyncREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsLdapUserSyncREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsLdapUserSyncREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsLdapUserSyncREL/export/ |
|
{ "hrefs":["/api/relation/HcsLdapUserSyncREL/[pkid1]", "/api/relation/HcsLdapUserSyncREL/[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 relation/HcsLdapUserSyncREL and the JSON format can be used to import instances of relation/HcsLdapUserSyncREL.
GET http://[host-proxy]/api/relation/HcsLdapUserSyncREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsLdapUserSyncREL | POST | /api/relation/HcsLdapUserSyncREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsLdapUserSyncREL/ |
|
The relation/HcsLdapUserSyncREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsLdapUserSyncREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "ldapServer",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsLdapUserSyncREL/?skip=0&limit=3&order_by=ldapServer&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 3
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsLdapUserSyncREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsLdapUserSyncREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsLdapUserSyncREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLdapUserSyncREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsLdapUserSyncREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsLdapUserSyncREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsLdapUserSyncREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsLdapUserSyncREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"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": "6130e8d7e04a4a0015a9d7b7",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.7",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6130e8d7e04a4a0015a9d7b7",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": [
{
"pkid": "6130e8c4e04a4a0015a9d647",
"path": "ldapServer",
"model_type": "data/Ldap"
},
{
"pkid": "6130e770e04a4a0015a9d294",
"path": "userEntitlementProfile",
"model_type": "data/HcsEntitlementProfileDAT"
},
{
"pkid": "6130d6a8e04a4a0015a93d91",
"path": "userRole",
"model_type": "data/Role"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsLdapUserSyncREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"6130e8d7e04a4a0015a9d7b7"
],
"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": "Manual",
"pkid": "6130e8d7e04a4a0015a9d7b9",
"userPurgeMode": "Automatic",
"ldapServer": "[\"10.120.2.221\", \"636\", \"OU=VOSSSOL9557,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"userEntitlementProfile": "[\"RST Entitlement Profile\", \"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": "5f3ae5d6ce894e0012055eb0",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.7",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5d6ce894e0012055eb0",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5d6ce894e0012055eb0/"
}
],
"parent": [
{
"pkid": "5f3ae5bace894e00120559f8",
"href": "/api/data/HierarchyNode/5f3ae5bace894e00120559f8"
}
],
"foreign_key": [
{
"pkid": "5f3ae5bfce894e0012055af1",
"path": "ldapServer",
"model_type": "data/Ldap"
},
{
"pkid": "5f3ae56fce894e0012054339",
"path": "userEntitlementProfile",
"model_type": "data/HcsEntitlementProfileDAT"
},
{
"pkid": "5f3ae55bce894e00120539d1",
"path": "userRole",
"model_type": "data/Role"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5d6ce894e0012055eb0/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5d6ce894e0012055eb0/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5d6ce894e0012055eb0/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5d6ce894e0012055eb0/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5d6ce894e0012055eb0/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "relation/HcsLdapUserSyncREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae5d6ce894e0012055eb0"
],
"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": {
"info": "Enable automatic sync by activating the LDAP Schedule or initiate a manual sync from the Sync & Purge Users menu. A sync cannot be cancelled, and an LDAP server cannot be deleted while a sync is in-progress.",
"FieldMapping": {
"directoryUri": "mail",
"objectClass": "objectClass",
"unverifiedMailBox": "unverifiedMailBox",
"ldap_username": "sAMAccountName",
"manager": "manager",
"street": "streetAddress",
"uid": "uid",
"buildingName": "physicalDeliveryOfficeName",
"employeeType": "employeeType",
"otherMailbox": "otherMailbox",
"title": "title",
"facsimileTelephoneNumber": "facsimileTelephoneNumber",
"data_username": "data_username",
"postalCode": "postalCode",
"mail": "mail",
"departmentNumber": "department",
"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": "5f3ae5d6ce894e0012055eb4",
"userPurgeMode": "Manual",
"ldapServer": "[\"10.120.2.221\", \"389\", \"OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net\", \"hcs.CS-P.CS-AB.AB_Group.AB-C\"]",
"userEntitlementProfile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"userRole": "AB_GroupSelfService",
"hierarchy_friendly_name": "AB-C (IntermediateNode)",
"userDeleteMode": "Manual",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C"
}
},
{
"pkid": "5f3ae5dfce894e001205600d",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.7",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5dfce894e001205600d",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5dfce894e001205600d/"
}
],
"parent": [
{
"pkid": "5f3ae5bbce894e0012055a46",
"href": "/api/data/HierarchyNode/5f3ae5bbce894e0012055a46"
}
],
"foreign_key": [
{
"pkid": "5f3ae5cbce894e0012055cd0",
"path": "ldapServer",
"model_type": "data/Ldap"
},
{
"pkid": "5f3ae56fce894e0012054339",
"path": "userEntitlementProfile",
"model_type": "data/HcsEntitlementProfileDAT"
},
{
"pkid": "5f3ae55bce894e00120539d1",
"path": "userRole",
"model_type": "data/Role"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5dfce894e001205600d/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5dfce894e001205600d/",
"class": "delete",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5dfce894e001205600d/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5dfce894e001205600d/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsLdapUserSyncREL/5f3ae5dfce894e001205600d/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "relation/HcsLdapUserSyncREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bbce894e0012055a46",
"5f3ae5dfce894e001205600d"
],
"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": {
"info": "Enable automatic sync by activating the LDAP Schedule or initiate a manual sync from the Sync & Purge Users menu. A sync cannot be cancelled, and an LDAP server cannot be deleted while a sync is in-progress.",
"FieldMapping": {
"directoryUri": "mail",
"objectClass": "objectClass",
"unverifiedMailBox": "unverifiedMailBox",
"ldap_username": "sAMAccountName",
"manager": "manager",
"street": "streetAddress",
"uid": "uid",
"buildingName": "physicalDeliveryOfficeName",
"employeeType": "employeeType",
"otherMailbox": "otherMailbox",
"title": "title",
"facsimileTelephoneNumber": "facsimileTelephoneNumber",
"data_username": "data_username",
"postalCode": "postalCode",
"mail": "mail",
"departmentNumber": "department",
"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": "5f3ae5dfce894e0012056011",
"userPurgeMode": "Manual",
"ldapServer": "[\"10.120.2.221\", \"389\", \"OU=AB-DS,OU=AB-GROUP,DC=vossqa,DC=net\", \"hcs.CS-P.CS-AB.AB_Group.AB-DS\"]",
"userEntitlementProfile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"userRole": "AB_GroupSelfService",
"hierarchy_friendly_name": "AB-DS (IntermediateNode)",
"userDeleteMode": "Manual",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-DS"
}
}
]
}
(Show the first instance)
{
"pkid": "6130e8d7e04a4a0015a9d7b7",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "[\"10.120.2.221\", \"636\", \"OU=VOSSSOL9557,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": "6130e8d7e04a4a0015a9d7b7",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/"
}
],
"children": [],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsLdapUserSyncREL/6130e8d7e04a4a0015a9d7b7/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsLdapUserSyncREL",
"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,
"UserFieldMapping": {
"last_name": "sn",
"manager": "manager",
"street": "streetAddress",
"postal_code": "postalCode",
"other_mailbox": "otherMailbox",
"object_class": "objectClass",
"city": "l",
"first_name": "givenName",
"display_name": "displayName",
"employee_number": "employeeNumber",
"facsimile_telephone_number": "facsimileTelephoneNumber",
"application": "LDAP",
"state": "st",
"home_phone": "homePhone",
"department": "department",
"email": "mail",
"username": "sAMAccountName",
"physical_delivery_office_name": "physicalDeliveryOfficeName",
"description": "LDAP field mapping for [\"10.120.2.221\", \"636\", \"OU=VOSSSOL9557,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"employee_type": "employeeType",
"name": "[\"10.120.2.221\", \"636\", \"OU=VOSSSOL9557,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"member_of": "memberOf",
"mobile": "mobile",
"country": "c",
"title": "title",
"telephone_number": "telephoneNumber",
"ip_phone": "ipPhone",
"model_type": "device/ldap/user",
"organization": "o",
"ou": "ou"
},
"userModelType": "device/ldap/user",
"userMoveMode": "Manual",
"userPurgeMode": "Automatic",
"ldapServer": "[\"10.120.2.221\", \"636\", \"OU=VOSSSOL9557,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"userEntitlementProfile": "[\"RST Entitlement Profile\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"userRole": "AAAGlobalSelfService",
"shadow": [],
"userMappingAttr": "sAMAccountName",
"userDeleteMode": "Manual"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsLdapUserSyncREL. | GET | /api/relation/HcsLdapUserSyncREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsLdapUserSyncREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsLdapUserSyncREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsLdapUserSyncREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsLdapUserSyncREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsLdapUserSyncREL/[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 relation/HcsLdapUserSyncREL and the JSON format can be used to import instances of relation/HcsLdapUserSyncREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsLdapUserSyncREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsLdapUserSyncREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsLdapUserSyncREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsLdapUserSyncREL. |