[Index]
Model ref.: device/activedirectory/ADUser
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": { "msExchApprovalApplicationLink": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msExchApprovalApplicationLink", "title": "msExchApprovalApplicationLink", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "logonCount": { "__type_requested": "System.Int32", "required": false, "name": "logonCount", "title": "logonCount", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchPoliciesIncluded": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msExchPoliciesIncluded", "title": "msExchPoliciesIncluded", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "Title": { "__type_requested": "string", "required": false, "name": "Title", "title": "Title", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "PasswordLastSet": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "PasswordLastSet", "title": "PasswordLastSet", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "msExchUMTemplateLink": { "__type_requested": "System.String", "required": false, "name": "msExchUMTemplateLink", "title": "msExchUMTemplateLink", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msRTCSIP-DeploymentLocator": { "readonly": true, "required": false, "type": "string", "name": "msRTCSIP-DeploymentLocator", "title": "msRTCSIP-DeploymentLocator" }, "msExchArchiveStatus": { "__type_requested": "System.Int32", "required": false, "name": "msExchArchiveStatus", "title": "msExchArchiveStatus", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "lastLogonTimestamp": { "__type_requested": "System.Int64", "required": false, "name": "lastLogonTimestamp", "title": "lastLogonTimestamp", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchModerationFlags": { "__type_requested": "System.Int32", "required": false, "name": "msExchModerationFlags", "title": "msExchModerationFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "SID": { "__type_requested": "System.Security.Principal.SecurityIdentifier", "required": false, "name": "SID", "title": "SID", "__type_mapping_type": "Complex.SecurityIdentifier", "readonly": true, "type": "object", "properties": { "BinaryLength": { "type": "integer", "name": "BinaryLength", "title": "BinaryLength" }, "Value": { "type": "string", "name": "Value", "title": "Value" }, "AccountDomainSid": { "type": "string", "name": "AccountDomainSid", "title": "AccountDomainSid" } } }, "Department": { "__type_requested": "string", "required": false, "name": "Department", "title": "Department", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "HomePhone": { "__type_requested": "string", "required": false, "name": "HomePhone", "title": "HomePhone", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "instanceType": { "__type_requested": "System.Int32", "required": false, "name": "instanceType", "title": "instanceType", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "isDeleted": { "__type_requested": "System.Boolean", "required": false, "name": "isDeleted", "title": "isDeleted", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Credential": { "__type_requested": "pscredential", "required": false, "name": "Credential", "title": "Credential", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Fax": { "__type_requested": "string", "required": false, "name": "Fax", "title": "Fax", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ChangePasswordAtLogon": { "__type_requested": "bool", "required": false, "name": "ChangePasswordAtLogon", "title": "ChangePasswordAtLogon", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "Company": { "__type_requested": "string", "required": false, "name": "Company", "title": "Company", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AccountNotDelegated": { "__type_requested": "bool", "required": false, "name": "AccountNotDelegated", "title": "AccountNotDelegated", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "objectSid": { "__type_requested": "System.Security.Principal.SecurityIdentifier", "required": false, "name": "objectSid", "title": "objectSid", "__type_mapping_type": "Complex.SecurityIdentifier", "readonly": true, "type": "object", "properties": { "BinaryLength": { "type": "integer", "name": "BinaryLength", "title": "BinaryLength" }, "Value": { "type": "string", "name": "Value", "title": "Value" }, "AccountDomainSid": { "type": "string", "name": "AccountDomainSid", "title": "AccountDomainSid" } } }, "whenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "whenCreated", "title": "whenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "msExchMessageHygieneSCLRejectThreshold": { "__type_requested": "System.Int32", "required": false, "name": "msExchMessageHygieneSCLRejectThreshold", "title": "msExchMessageHygieneSCLRejectThreshold", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchTransportRecipientSettingsFlags": { "__type_requested": "System.Int32", "required": false, "name": "msExchTransportRecipientSettingsFlags", "title": "msExchTransportRecipientSettingsFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "TrustedToAuthForDelegation": { "__type_requested": "System.Boolean", "required": false, "name": "TrustedToAuthForDelegation", "title": "TrustedToAuthForDelegation", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "OfficePhone": { "__type_requested": "string", "required": false, "name": "OfficePhone", "title": "OfficePhone", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msRTCSIP-OptionFlags": { "__type_requested": "System.Int32", "required": false, "name": "msRTCSIP-OptionFlags", "title": "msRTCSIP-OptionFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchHideFromAddressLists": { "__type_requested": "System.Boolean", "required": false, "name": "msExchHideFromAddressLists", "title": "msExchHideFromAddressLists", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "mDBOverQuotaLimit": { "__type_requested": "System.Int32", "required": false, "name": "mDBOverQuotaLimit", "title": "mDBOverQuotaLimit", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchRequireAuthToSendTo": { "__type_requested": "System.Boolean", "required": false, "name": "msExchRequireAuthToSendTo", "title": "msExchRequireAuthToSendTo", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "POBox": { "__type_requested": "string", "required": false, "name": "POBox", "title": "POBox", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "whenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "whenChanged", "title": "whenChanged", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "StreetAddress": { "__type_requested": "string", "required": false, "name": "StreetAddress", "title": "StreetAddress", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msExchRBACPolicyLink": { "__type_requested": "System.String", "required": false, "name": "msExchRBACPolicyLink", "title": "msExchRBACPolicyLink", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Organization": { "__type_requested": "string", "required": false, "name": "Organization", "title": "Organization", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msRTCSIP-InternetAccessEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "msRTCSIP-InternetAccessEnabled", "title": "msRTCSIP-InternetAccessEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "authOrigBL": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "authOrigBL", "title": "authOrigBL", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "Initials": { "__type_requested": "string", "required": false, "name": "Initials", "title": "Initials", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "MobilePhone": { "__type_requested": "string", "required": false, "name": "MobilePhone", "title": "MobilePhone", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msExchUMEnabledFlags2": { "__type_requested": "System.Int32", "required": false, "name": "msExchUMEnabledFlags2", "title": "msExchUMEnabledFlags2", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchRecipientTypeDetails": { "__type_requested": "System.Int64", "required": false, "name": "msExchRecipientTypeDetails", "title": "msExchRecipientTypeDetails", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "codePage": { "__type_requested": "System.Int32", "required": false, "name": "codePage", "title": "codePage", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "UserPrincipalName": { "__type_requested": "string", "required": false, "name": "UserPrincipalName", "title": "UserPrincipalName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "PasswordNotRequired": { "__type_requested": "bool", "required": false, "name": "PasswordNotRequired", "title": "PasswordNotRequired", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "msExchUserBL": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msExchUserBL", "title": "msExchUserBL", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "PrimaryGroup": { "__type_requested": "System.String", "required": false, "name": "PrimaryGroup", "title": "PrimaryGroup", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "servicePrincipalName": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "servicePrincipalName", "title": "servicePrincipalName", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "lastLogoff": { "__type_requested": "System.Int64", "required": false, "name": "lastLogoff", "title": "lastLogoff", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "isCriticalSystemObject": { "__type_requested": "System.Boolean", "required": false, "name": "isCriticalSystemObject", "title": "isCriticalSystemObject", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "DisplayName": { "__type_requested": "string", "required": false, "name": "DisplayName", "title": "DisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "MemberOf": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "MemberOf", "title": "MemberOf", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "PasswordExpired": { "__type_requested": "System.Boolean", "required": false, "name": "PasswordExpired", "title": "PasswordExpired", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Certificates": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "Certificates", "title": "Certificates", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "State": { "__type_requested": "string", "required": false, "name": "State", "title": "State", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "HomeDirectory": { "__type_requested": "string", "required": false, "name": "HomeDirectory", "title": "HomeDirectory", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "homeMDB": { "__type_requested": "System.String", "required": false, "name": "homeMDB", "title": "homeMDB", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Type": { "__type_requested": "string", "required": false, "name": "Type", "title": "Type", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ProtectedFromAccidentalDeletion": { "__type_requested": "System.Boolean", "required": false, "name": "ProtectedFromAccidentalDeletion", "title": "ProtectedFromAccidentalDeletion", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "submissionContLength": { "__type_requested": "System.Int32", "required": false, "name": "submissionContLength", "title": "submissionContLength", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "Deleted": { "__type_requested": "System.Boolean", "required": false, "name": "Deleted", "title": "Deleted", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "msExchDumpsterWarningQuota": { "__type_requested": "System.Int32", "required": false, "name": "msExchDumpsterWarningQuota", "title": "msExchDumpsterWarningQuota", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "UseDESKeyOnly": { "__type_requested": "System.Boolean", "required": false, "name": "UseDESKeyOnly", "title": "UseDESKeyOnly", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "msDS-SupportedEncryptionTypes": { "__type_requested": "System.Int32", "required": false, "name": "msDS-SupportedEncryptionTypes", "title": "msDS-SupportedEncryptionTypes", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "LastKnownParent": { "__type_requested": "System.String", "required": false, "name": "LastKnownParent", "title": "LastKnownParent", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchAddressBookFlags": { "__type_requested": "System.Int32", "required": false, "name": "msExchAddressBookFlags", "title": "msExchAddressBookFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "AuthenticationPolicy": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "AuthenticationPolicy", "title": "AuthenticationPolicy", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "msExchDumpsterQuota": { "__type_requested": "System.Int32", "required": false, "name": "msExchDumpsterQuota", "title": "msExchDumpsterQuota", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "uSNChanged": { "__type_requested": "System.Int64", "required": false, "name": "uSNChanged", "title": "uSNChanged", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msRTCSIP-UserRoutingGroupId": { "__type_requested": "System.Byte[]", "required": false, "name": "msRTCSIP-UserRoutingGroupId", "title": "msRTCSIP-UserRoutingGroupId", "items": { "type": "integer" }, "__type_mapping_type": "Integer[]", "readonly": true, "type": "array" }, "CompoundIdentitySupported": { "__type_requested": "bool", "required": false, "name": "CompoundIdentitySupported", "title": "CompoundIdentitySupported", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "msExchMessageHygieneSCLQuarantineThreshold": { "__type_requested": "System.Int32", "required": false, "name": "msExchMessageHygieneSCLQuarantineThreshold", "title": "msExchMessageHygieneSCLQuarantineThreshold", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "DistinguishedName": { "__type_requested": "System.String", "required": false, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "pwdLastSet": { "__type_requested": "System.Int64", "required": false, "name": "pwdLastSet", "title": "pwdLastSet", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "AuthType": { "__type_requested": "ADAuthType", "required": false, "name": "AuthType", "title": "AuthType", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Path": { "__type_requested": "string", "required": false, "name": "Path", "title": "Path", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msRTCSIP-Line": { "readonly": true, "required": false, "type": "string", "name": "msRTCSIP-Line", "title": "msRTCSIP-Line" }, "mDBStorageQuota": { "__type_requested": "System.Int32", "required": false, "name": "mDBStorageQuota", "title": "mDBStorageQuota", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "OtherName": { "__type_requested": "string", "required": false, "name": "OtherName", "title": "OtherName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Modified": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "Modified", "title": "Modified", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "msExchUMPinChecksum": { "__type_requested": "System.Byte[]", "required": false, "name": "msExchUMPinChecksum", "title": "msExchUMPinChecksum", "items": { "type": "integer" }, "__type_mapping_type": "Integer[]", "readonly": true, "type": "array" }, "msRTCSIP-FederationEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "msRTCSIP-FederationEnabled", "title": "msRTCSIP-FederationEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ScriptPath": { "__type_requested": "string", "required": false, "name": "ScriptPath", "title": "ScriptPath", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Server": { "__type_requested": "string", "required": false, "name": "Server", "title": "Server", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "EmployeeID": { "__type_requested": "string", "required": false, "name": "EmployeeID", "title": "EmployeeID", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "BadLogonCount": { "__type_requested": "System.Int32", "required": false, "name": "BadLogonCount", "title": "BadLogonCount", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "SamAccountName": { "__type_requested": "string", "required": false, "name": "SamAccountName", "title": "SamAccountName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ObjectCategory": { "__type_requested": "System.String", "required": false, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchMailboxAuditLogAgeLimit": { "__type_requested": "System.Int32", "required": false, "name": "msExchMailboxAuditLogAgeLimit", "title": "msExchMailboxAuditLogAgeLimit", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchTextMessagingState": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": true, "name": "msExchTextMessagingState", "title": "msExchTextMessagingState", "items": { "type": "integer" }, "__type_mapping_type": "Integer[]", "readonly": false, "type": "array" }, "msRTCSIP-LineServer": { "__type_requested": "System.String", "required": false, "name": "msRTCSIP-LineServer", "title": "msRTCSIP-LineServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "middleName": { "__type_requested": "System.String", "required": false, "name": "middleName", "title": "middleName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "primaryGroupID": { "__type_requested": "System.Int32", "required": false, "name": "primaryGroupID", "title": "primaryGroupID", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "LockedOut": { "__type_requested": "System.Boolean", "required": false, "name": "LockedOut", "title": "LockedOut", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "msExchUMEnabledFlags": { "__type_requested": "System.Int32", "required": false, "name": "msExchUMEnabledFlags", "title": "msExchUMEnabledFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchMobileMailboxFlags": { "__type_requested": "System.Int32", "required": false, "name": "msExchMobileMailboxFlags", "title": "msExchMobileMailboxFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "DoesNotRequirePreAuth": { "__type_requested": "System.Boolean", "required": false, "name": "DoesNotRequirePreAuth", "title": "DoesNotRequirePreAuth", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ServicePrincipalNames": { "__type_requested": "string[]", "required": false, "name": "ServicePrincipalNames", "title": "ServicePrincipalNames", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "msExchRMSComputerAccountsLink": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msExchRMSComputerAccountsLink", "title": "msExchRMSComputerAccountsLink", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "HomeDrive": { "__type_requested": "string", "required": false, "name": "HomeDrive", "title": "HomeDrive", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "City": { "__type_requested": "string", "required": false, "name": "City", "title": "City", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msExchMessageHygieneSCLDeleteThreshold": { "__type_requested": "System.Int32", "required": false, "name": "msExchMessageHygieneSCLDeleteThreshold", "title": "msExchMessageHygieneSCLDeleteThreshold", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "CannotChangePassword": { "__type_requested": "bool", "required": false, "name": "CannotChangePassword", "title": "CannotChangePassword", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "showInAdvancedViewOnly": { "__type_requested": "System.Boolean", "required": false, "name": "showInAdvancedViewOnly", "title": "showInAdvancedViewOnly", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "adminCount": { "__type_requested": "System.Int32", "required": false, "name": "adminCount", "title": "adminCount", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "Instance": { "__type_requested": "ADUser", "required": false, "name": "Instance", "title": "Instance", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "msExchBypassAudit": { "__type_requested": "System.Boolean", "required": false, "name": "msExchBypassAudit", "title": "msExchBypassAudit", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "PasswordNeverExpires": { "__type_requested": "bool", "required": false, "name": "PasswordNeverExpires", "title": "PasswordNeverExpires", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "msExchArchiveGUID": { "__type_requested": "System.Byte[]", "required": false, "name": "msExchArchiveGUID", "title": "msExchArchiveGUID", "items": { "type": "integer" }, "__type_mapping_type": "Integer[]", "readonly": true, "type": "array" }, "LogonWorkstations": { "__type_requested": "string", "required": false, "name": "LogonWorkstations", "title": "LogonWorkstations", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "GivenName": { "__type_requested": "string", "required": false, "name": "GivenName", "title": "GivenName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AccountPassword": { "__type_requested": "securestring", "required": true, "name": "AccountPassword", "title": "AccountPassword", "__type_mapping_type": "Unknown", "ignore": true, "readonly": false, "is_password": true, "store_encrypted": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Created": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "Created", "title": "Created", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "msExchUserAccountControl": { "__type_requested": "System.Int32", "required": false, "name": "msExchUserAccountControl", "title": "msExchUserAccountControl", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchRecipientSoftDeletedStatus": { "__type_requested": "System.Int32", "required": false, "name": "msExchRecipientSoftDeletedStatus", "title": "msExchRecipientSoftDeletedStatus", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "userCertificate": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "userCertificate", "title": "userCertificate", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "ObjectGUID": { "__type_requested": "System.Nullable`1[[System.Guid,", "required": false, "name": "ObjectGUID", "title": "ObjectGUID", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "OtherAttributes": { "__type_requested": "hashtable", "required": false, "name": "OtherAttributes", "title": "OtherAttributes", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "garbageCollPeriod": { "__type_requested": "System.Int32", "required": false, "name": "garbageCollPeriod", "title": "garbageCollPeriod", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchUMRecipientDialPlanLink": { "__type_requested": "System.String", "required": false, "name": "msExchUMRecipientDialPlanLink", "title": "msExchUMRecipientDialPlanLink", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "HomePage": { "__type_requested": "string", "required": false, "name": "HomePage", "title": "HomePage", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "MNSLogonAccount": { "__type_requested": "System.Boolean", "required": false, "name": "MNSLogonAccount", "title": "MNSLogonAccount", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "badPasswordTime": { "__type_requested": "System.Int64", "required": false, "name": "badPasswordTime", "title": "badPasswordTime", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "CN": { "__type_requested": "System.String", "required": false, "name": "CN", "title": "CN", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchArchiveName": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msExchArchiveName", "title": "msExchArchiveName", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "SmartcardLogonRequired": { "__type_requested": "bool", "required": false, "name": "SmartcardLogonRequired", "title": "SmartcardLogonRequired", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "Enabled": { "__type_requested": "bool", "required": false, "name": "Enabled", "title": "Enabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "badPwdCount": { "__type_requested": "System.Int32", "required": false, "name": "badPwdCount", "title": "badPwdCount", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "LastBadPasswordAttempt": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "LastBadPasswordAttempt", "title": "LastBadPasswordAttempt", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "internetEncoding": { "__type_requested": "System.Int32", "required": false, "name": "internetEncoding", "title": "internetEncoding", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "mail": { "__type_requested": "System.String", "required": false, "name": "mail", "title": "mail", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "LastLogonDate": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "LastLogonDate", "title": "LastLogonDate", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "msExchMailboxAuditEnable": { "__type_requested": "System.Boolean", "required": false, "name": "msExchMailboxAuditEnable", "title": "msExchMailboxAuditEnable", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "PrincipalsAllowedToDelegateToAccount": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "PrincipalsAllowedToDelegateToAccount", "title": "PrincipalsAllowedToDelegateToAccount", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "Surname": { "__type_requested": "string", "required": false, "name": "Surname", "title": "Surname", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AuthenticationPolicySilo": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "AuthenticationPolicySilo", "title": "AuthenticationPolicySilo", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "Office": { "__type_requested": "string", "required": false, "name": "Office", "title": "Office", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "TrustedForDelegation": { "__type_requested": "bool", "required": false, "name": "TrustedForDelegation", "title": "TrustedForDelegation", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "msExchMDBRulesQuota": { "__type_requested": "System.Int32", "required": false, "name": "msExchMDBRulesQuota", "title": "msExchMDBRulesQuota", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "sAMAccountType": { "__type_requested": "System.Int32", "required": false, "name": "sAMAccountType", "title": "sAMAccountType", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msDS-User-Account-Control-Computed": { "__type_requested": "System.Int32", "required": false, "name": "msDS-User-Account-Control-Computed", "title": "msDS-User-Account-Control-Computed", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "EmailAddress": { "__type_requested": "string", "required": false, "name": "EmailAddress", "title": "EmailAddress", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "mDBOverHardQuotaLimit": { "__type_requested": "System.Int32", "required": false, "name": "mDBOverHardQuotaLimit", "title": "mDBOverHardQuotaLimit", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "mDBUseDefaults": { "__type_requested": "System.Boolean", "required": false, "name": "mDBUseDefaults", "title": "mDBUseDefaults", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "modifyTimeStamp": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "modifyTimeStamp", "title": "modifyTimeStamp", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "PostalCode": { "__type_requested": "string", "required": false, "name": "PostalCode", "title": "PostalCode", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "mailNickname": { "__type_requested": "System.String", "required": false, "name": "mailNickname", "title": "mailNickname", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchCapabilityIdentifiers": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msExchCapabilityIdentifiers", "title": "msExchCapabilityIdentifiers", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "countryCode": { "__type_requested": "System.Int32", "required": false, "name": "countryCode", "title": "countryCode", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msRTCSIP-UserEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "msRTCSIP-UserEnabled", "title": "msRTCSIP-UserEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "msRTCSIP-UserPolicies": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msRTCSIP-UserPolicies", "title": "msRTCSIP-UserPolicies", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "AccountLockoutTime": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "AccountLockoutTime", "title": "AccountLockoutTime", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "msExchUMDtmfMap": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "msExchUMDtmfMap", "title": "msExchUMDtmfMap", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "authOrig": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "authOrig", "title": "authOrig", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "msExchWhenMailboxCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "msExchWhenMailboxCreated", "title": "msExchWhenMailboxCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "msExchRecipientDisplayType": { "__type_requested": "System.Int32", "required": false, "name": "msExchRecipientDisplayType", "title": "msExchRecipientDisplayType", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchMessageHygieneSCLJunkThreshold": { "__type_requested": "System.Int32", "required": false, "name": "msExchMessageHygieneSCLJunkThreshold", "title": "msExchMessageHygieneSCLJunkThreshold", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "SIDHistory": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "SIDHistory", "title": "SIDHistory", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "Division": { "__type_requested": "string", "required": false, "name": "Division", "title": "Division", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Description": { "__type_requested": "string", "required": false, "name": "Description", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ObjectClass": { "__type_requested": "System.String", "required": false, "name": "ObjectClass", "title": "ObjectClass", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "HomedirRequired": { "__type_requested": "System.Boolean", "required": false, "name": "HomedirRequired", "title": "HomedirRequired", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "logonHours": { "__type_requested": "System.Byte[]", "required": false, "name": "logonHours", "title": "logonHours", "items": { "type": "integer" }, "__type_mapping_type": "Integer[]", "readonly": true, "type": "array" }, "Manager": { "__type_requested": "System.String", "required": false, "name": "Manager", "title": "Manager", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msExchHomeServerName": { "__type_requested": "System.String", "required": false, "name": "msExchHomeServerName", "title": "msExchHomeServerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchArchiveQuota": { "__type_requested": "System.Int64", "required": false, "name": "msExchArchiveQuota", "title": "msExchArchiveQuota", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchCalendarLoggingQuota": { "__type_requested": "System.Int32", "required": false, "name": "msExchCalendarLoggingQuota", "title": "msExchCalendarLoggingQuota", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "uSNCreated": { "__type_requested": "System.Int64", "required": false, "name": "uSNCreated", "title": "uSNCreated", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "delivContLength": { "__type_requested": "System.Int32", "required": false, "name": "delivContLength", "title": "delivContLength", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "legacyExchangeDN": { "__type_requested": "System.String", "required": false, "name": "legacyExchangeDN", "title": "legacyExchangeDN", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "EmployeeNumber": { "__type_requested": "string", "required": false, "name": "EmployeeNumber", "title": "EmployeeNumber", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msExchELCMailboxFlags": { "__type_requested": "System.Int32", "required": false, "name": "msExchELCMailboxFlags", "title": "msExchELCMailboxFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "Name": { "__type_requested": "string", "required": true, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "dSCorePropagationData": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "dSCorePropagationData", "title": "dSCorePropagationData", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "Country": { "__type_requested": "string", "required": false, "name": "Country", "title": "Country", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msExchArchiveDatabaseLink": { "__type_requested": "System.String", "required": false, "name": "msExchArchiveDatabaseLink", "title": "msExchArchiveDatabaseLink", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchVersion": { "__type_requested": "System.Int64", "required": false, "name": "msExchVersion", "title": "msExchVersion", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "showInAddressBook": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "showInAddressBook", "title": "showInAddressBook", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "msExchArchiveWarnQuota": { "__type_requested": "System.Int64", "required": false, "name": "msExchArchiveWarnQuota", "title": "msExchArchiveWarnQuota", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "createTimeStamp": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "createTimeStamp", "title": "createTimeStamp", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "ProfilePath": { "__type_requested": "string", "required": false, "name": "ProfilePath", "title": "ProfilePath", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "msExchMasterAccountSid": { "__type_requested": "System.Security.Principal.SecurityIdentifier", "required": false, "name": "msExchMasterAccountSid", "title": "msExchMasterAccountSid", "__type_mapping_type": "Complex.SecurityIdentifier", "readonly": true, "type": "object", "properties": { "BinaryLength": { "type": "integer", "name": "BinaryLength", "title": "BinaryLength" }, "Value": { "type": "string", "name": "Value", "title": "Value" }, "AccountDomainSid": { "type": "string", "name": "AccountDomainSid", "title": "AccountDomainSid" } } }, "AccountExpirationDate": { "__type_requested": "datetime", "__type_mapping_type": "DateTime", "name": "AccountExpirationDate", "title": "AccountExpirationDate", "format": "date-time", "required": false, "readonly": false, "type": "string" }, "KerberosEncryptionType": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "KerberosEncryptionType", "title": "KerberosEncryptionType", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "msRTCSIP-PrimaryHomeServer": { "__type_requested": "System.String", "required": false, "name": "msRTCSIP-PrimaryHomeServer", "title": "msRTCSIP-PrimaryHomeServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "userAccountControl": { "__type_requested": "System.Int32", "required": false, "name": "userAccountControl", "title": "userAccountControl", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "proxyAddresses": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "proxyAddresses", "title": "proxyAddresses", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "CanonicalName": { "__type_requested": "System.String", "required": false, "name": "CanonicalName", "title": "CanonicalName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AllowReversiblePasswordEncryption": { "__type_requested": "bool", "required": false, "name": "AllowReversiblePasswordEncryption", "title": "AllowReversiblePasswordEncryption", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "lastLogon": { "__type_requested": "System.Int64", "required": false, "name": "lastLogon", "title": "lastLogon", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msExchProvisioningFlags": { "__type_requested": "System.Int32", "required": false, "name": "msExchProvisioningFlags", "title": "msExchProvisioningFlags", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "msRTCSIP-PrimaryUserAddress": { "__type_requested": "System.String", "required": false, "name": "msRTCSIP-PrimaryUserAddress", "title": "msRTCSIP-PrimaryUserAddress", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "protocolSettings": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "protocolSettings", "title": "protocolSettings", "items": { "type": "integer" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "sn": { "__type_requested": "System.String", "required": false, "name": "sn", "title": "sn", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchMailboxTemplateLink": { "__type_requested": "System.String", "required": false, "name": "msExchMailboxTemplateLink", "title": "msExchMailboxTemplateLink", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "msExchMailboxGuid": { "__type_requested": "System.Byte[]", "required": false, "name": "msExchMailboxGuid", "title": "msExchMailboxGuid", "items": { "type": "integer" }, "__type_mapping_type": "Integer[]", "readonly": true, "type": "array" }, "msExchUserCulture": { "__type_requested": "System.String", "required": false, "name": "msExchUserCulture", "title": "msExchUserCulture", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "sDRightsEffective": { "__type_requested": "System.Int32", "required": false, "name": "sDRightsEffective", "title": "sDRightsEffective", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" } }, "schema_version": "69" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/activedirectory/ADUser/add/ |
|
The GUI Add form of device/activedirectory/ADUser 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/device/activedirectory/ADUser/ | 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/device/activedirectory/ADUser/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/activedirectory/ADUser/[pkid1]", "/api/device/activedirectory/ADUser/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/activedirectory/ADUser/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/activedirectory/ADUser/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/activedirectory/ADUser/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/activedirectory/ADUser/[pkid1]", "/api/v0/device/activedirectory/ADUser/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/activedirectory/ADUser/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/activedirectory/ADUser |
|
{"hrefs": ["/api/device/activedirectory/ADUser/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/activedirectory/ADUser |
|
{"hrefs": ["/api/device/activedirectory/ADUser/[pkid1]", "/api/device/activedirectory/ADUser/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/activedirectory/ADUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/activedirectory/ADUser/export/ |
|
{ "hrefs":["/api/device/activedirectory/ADUser/[pkid1]", "/api/device/activedirectory/ADUser/[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 device/activedirectory/ADUser and the JSON format can be used to import instances of device/activedirectory/ADUser.
GET http://[host-proxy]/api/device/activedirectory/ADUser/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/activedirectory/ADUser | POST | /api/device/activedirectory/ADUser/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/activedirectory/ADUser/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/activedirectory/ADUser/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/activedirectory/ADUser/ |
|
The device/activedirectory/ADUser schema and all instances as JSON. |
(The list will return 0 to 3 device/activedirectory/ADUser instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/activedirectory/ADUser/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "69", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/activedirectory/ADUser/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/activedirectory/ADUser/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/activedirectory/ADUser/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/activedirectory/ADUser", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/activedirectory/ADUser/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/activedirectory/ADUser/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/activedirectory/ADUser/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/activedirectory/ADUser/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/activedirectory/ADUser/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/activedirectory/ADUser/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/activedirectory/ADUser/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/activedirectory/ADUser", "model_specific_actions": [ "get", "list", "add", "remove", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "Surname", "title": "Surname" }, { "name": "msRTCSIP-UserEnabled", "title": "msRTCSIP-UserEnabled" }, { "name": "msRTCSIP-Line", "title": "msRTCSIP-Line" }, { "name": "msRTCSIP-DeploymentLocator", "title": "msRTCSIP-DeploymentLocator" }, { "name": "mailNickname", "title": "mailNickname" }, { "name": "msExchUMEnabledFlags", "title": "msExchUMEnabledFlags" }, { "name": "MobilePhone", "title": "MobilePhone" }, { "name": "OfficePhone", "title": "OfficePhone" }, { "name": "EmailAddress", "title": "EmailAddress" }, { "name": "Company", "title": "Company" }, { "name": "City", "title": "City" }, { "name": "Country", "title": "Country" }, { "name": "UserPrincipalName", "title": "UserPrincipalName" }, { "name": "DistinguishedName", "title": "DistinguishedName" }, { "name": "SamAccountName", "title": "SamAccountName" }, { "name": "DisplayName", "title": "DisplayName" }, { "name": "Enabled", "title": "Enabled" }, { "name": "Deleted", "title": "Deleted" }, { "name": "Description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/activedirectory/ADUser. | GET | /api/device/activedirectory/ADUser/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/activedirectory/ADUser as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/activedirectory/ADUser/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/activedirectory/ADUser/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/activedirectory/ADUser/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/activedirectory/ADUser/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/activedirectory/ADUser | 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 device/activedirectory/ADUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/activedirectory/ADUser/[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 device/activedirectory/ADUser and the JSON format can be used to import instances of device/activedirectory/ADUser.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/activedirectory/ADUser/[pkid]/ | hierarchy=[hierarchy] | The device/activedirectory/ADUser instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/activedirectory/ADUser/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/activedirectory/ADUser. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/activedirectory/ADUser/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |