[Index]
Model ref.: device/activedirectoryhybrid/ADComputer
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": {
"primaryGroupID": {
"__type_requested": "System.Int32",
"required": false,
"name": "primaryGroupID",
"title": "primaryGroupID",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"logonCount": {
"__type_requested": "System.Int32",
"required": false,
"name": "logonCount",
"title": "logonCount",
"__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"
},
"rIDSetReferences": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "rIDSetReferences",
"title": "rIDSetReferences",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"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"
}
}
},
"Certificates": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"description": "Modifies the DER-encoded X.509v3 certificates of the account. These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. This parameter sets the Certificates property of the account object. The LDAP Display Name (ldapDisplayName) for this property is userCertificate.\nSyntax:\nTo add values:\n-Certificates @{Add=value1,value2,...}\nTo remove values:\n-Certificates @{Remove=value3,value4,...}\nTo replace values:\n-Certificates @{Replace=value1,value2,...}\nTo clear all values:\n-Certificates $null\nYou can specify more than one operation by using a list separated by semicolons. For example, use the following syntax to add and remove Certificate values\n-Certificates @{Add=value1,value2,...};@{Remove=value3,value4,...}\nThe operators will be applied in the following sequence:\n..Remove\n..Add\n..Replace",
"title": "Certificates",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "Certificates"
},
"instanceType": {
"__type_requested": "System.Int32",
"required": false,
"name": "instanceType",
"title": "instanceType",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"AuthenticationPolicy": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"description": "Specifies an Active Directory Domain Services authentication policy object. Specify the authentication policy object in one of the following formats: \n\n-- Distinguished Name\n-- GUID\n-- Name\nThis parameter can also get this object through the pipeline or you can set this parameter to an object instance.\nThe cmdlet searches the default naming context or partition to find the object. If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error.",
"title": "AuthenticationPolicy",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "AuthenticationPolicy"
},
"Credential": {
"__type_requested": "PSCredential",
"required": false,
"description": "Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.\nTo specify this parameter, you can type a user name, such as User1 or Domain01\\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.\nYou can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.\nIf the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error.",
"title": "Credential",
"__type_mapping_type": "Unknown",
"name": "Credential",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"ChangePasswordAtLogon": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether a password must be changed during the next logon attempt. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1\nThis parameter cannot be set to $True or 1 for an account that also has the PasswordNeverExpires property set to $True.",
"title": "ChangePasswordAtLogon",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ChangePasswordAtLogon"
},
"AccountNotDelegated": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether the security context of the user is delegated to a service. When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. This parameter sets the AccountNotDelegated property for an Active Directory account. This parameter also sets the ADS_UF_NOT_DELEGATED flag of the Active Directory User Account Control (UAC) attribute. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1",
"title": "AccountNotDelegated",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "AccountNotDelegated"
},
"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"
}
}
},
"OperatingSystemVersion": {
"__type_requested": "String",
"required": false,
"description": "Specifies an operating system version. This parameter sets the OperatingSystemVersion property of the computer object. The LDAP display name (ldapDisplayName) for this property is operatingSystemVersion.",
"title": "OperatingSystemVersion",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "OperatingSystemVersion"
},
"Path": {
"__type_requested": "String",
"required": false,
"description": "Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created.\nIn many cases, a default value will be used for the Path parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated.\nIn AD DS environments, a default value for Path will be set in the following cases:\n\n-- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. \n-- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. \n-- If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain.\nIn AD LDS environments, a default value for Path will be set in the following cases:\n\n- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. \n-- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. \n-- If the target AD LDS instance has a default naming context, the default value of Path will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. \n-- If none of the previous cases apply, the Path parameter will not take any default value.\nNote: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, Rename-Item, and Set-ItemProperty also contain a Path property. However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets.",
"title": "Path",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Path"
},
"OperatingSystemServicePack": {
"__type_requested": "String",
"required": false,
"description": "Specifies the name of an operating system service pack. This parameter sets the OperatingSystemServicePack property of the computer object. The LDAP display name (ldapDisplayName) for this property is operatingSystemServicePack.",
"title": "OperatingSystemServicePack",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "OperatingSystemServicePack"
},
"whenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "whenChanged",
"title": "whenChanged",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"msDFSR-ComputerReferenceBL": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "msDFSR-ComputerReferenceBL",
"title": "msDFSR-ComputerReferenceBL",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"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,
"description": "Specifies a user principal name (UPN) in the format <user>@<DNS-domain-name>. A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. The UPN is independent of the user object's DN, so a user object can be moved or renamed without affecting the user logon name. When logging on using a UPN, users no longer have to choose a domain from a list on the logon dialog box.",
"title": "UserPrincipalName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "UserPrincipalName"
},
"PasswordNotRequired": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether the account requires a password. This parameter sets the PasswordNotRequired property of an account, such as a user or computer account. This parameter also sets the ADS_UF_PASSWD_NOTREQD flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1",
"title": "PasswordNotRequired",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "PasswordNotRequired"
},
"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": "string"
},
"__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,
"description": "Specifies the display name of the object. This parameter sets the DisplayName property of the object. The LDAP Display Name (ldapDisplayName) for this property is displayName.",
"title": "DisplayName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "DisplayName"
},
"MemberOf": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "MemberOf",
"title": "MemberOf",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"msExchRMSComputerAccountsBL": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "msExchRMSComputerAccountsBL",
"title": "msExchRMSComputerAccountsBL",
"items": {
"type": "string"
},
"__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"
},
"Location": {
"__type_requested": "String",
"required": false,
"description": "Specifies the location of the computer, such as an office number. This parameter sets the Location property of a computer. The LDAP display name (ldapDisplayName) of this property is location.",
"title": "Location",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Location"
},
"serverReferenceBL": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "serverReferenceBL",
"title": "serverReferenceBL",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"ProtectedFromAccidentalDeletion": {
"__type_requested": "System.Boolean",
"required": false,
"name": "ProtectedFromAccidentalDeletion",
"title": "ProtectedFromAccidentalDeletion",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"SAMAccountName": {
"__type_requested": "String",
"required": false,
"description": "Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. The maximum length of the description is 256 characters. To be compatible with older operating systems, create a SAM account name that is 15 characters or less. This parameter sets the SAMAccountName for an account object. The LDAP display name (ldapDisplayName) for this property is sAMAccountName.\nNote: If the SAMAccountName string provided does not end with a $, one will be appended if needed.",
"title": "SAMAccountName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SAMAccountName"
},
"IPv6Address": {
"__type_requested": "System.String",
"required": false,
"name": "IPv6Address",
"title": "IPv6Address",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Deleted": {
"__type_requested": "System.Boolean",
"required": false,
"name": "Deleted",
"title": "Deleted",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"UseDESKeyOnly": {
"__type_requested": "System.Boolean",
"required": false,
"name": "UseDESKeyOnly",
"title": "UseDESKeyOnly",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"localPolicyFlags": {
"__type_requested": "System.Int32",
"required": false,
"name": "localPolicyFlags",
"title": "localPolicyFlags",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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"
},
"isDeleted": {
"__type_requested": "System.Boolean",
"required": false,
"name": "isDeleted",
"title": "isDeleted",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"KerberosEncryptionType": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"description": "Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. This value sets the encryption types supported flags of the Active Directory msDS-SupportedEncryptionTypes attribute. The acceptable values for this parameter are:\u00a0\n\n-- None\n-- DES\n-- RC4\n-- AES128\n-- AES256\nNone will remove all encryption types from the account which may result in the KDC being unable to issue service tickets for services using the account.\nDES is a weak encryption type which is not supported by default since Windows 7 and Windows Server 2008 R2.\nWarning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting.",
"title": "KerberosEncryptionType",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "KerberosEncryptionType"
},
"CompoundIdentitySupported": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. This value sets the compound identity supported flag of the Active Directory msDS-SupportedEncryptionTypes attribute. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1\nWarning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting.",
"title": "CompoundIdentitySupported",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "CompoundIdentitySupported"
},
"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,
"description": "Specifies the authentication method to use. The acceptable values for this parameter are:\u00a0\n\n-- Negotiate or 0\n-- Basic or 1\nThe default authentication method is Negotiate.\nA Secure Sockets Layer (SSL) connection is required for the Basic authentication method.",
"title": "AuthType",
"__type_mapping_type": "Unknown",
"name": "AuthType",
"readonly": 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"
},
"Modified": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "Modified",
"title": "Modified",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"Server": {
"__type_requested": "String",
"required": false,
"description": "Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.\nSpecify the Active Directory Domain Services instance in one of the following ways: \n\n-- Domain name values:\n\n---- Fully qualified domain name\n---- NetBIOS name\n\n-- Directory server values: \n\n---- Fully qualified directory server name\n---- NetBIOS name\n---- Fully qualified directory server name and port\nThe default value for this parameter is determined by one of the following methods in the order that they are listed:\n\n-- By using the Server value from objects passed through the pipeline\n-- By using the server information associated with the Active Directory Domain ServicesWindows PowerShell provider drive, when the cmdlet runs in that drive\n-- By using the domain of the computer running Windows PowerShell",
"title": "Server",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Server"
},
"BadLogonCount": {
"__type_requested": "System.Int32",
"required": false,
"name": "BadLogonCount",
"title": "BadLogonCount",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"SamAccountName": {
"__type_requested": "System.String",
"required": false,
"name": "SamAccountName",
"title": "SamAccountName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"DNSHostName": {
"__type_requested": "String",
"required": false,
"description": "Specifies the fully qualified domain name (FQDN) of the computer. This parameter sets the DNSHostName property for a computer object. The LDAP Display Name for this property is dNSHostName.",
"title": "DNSHostName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "DNSHostName"
},
"LockedOut": {
"__type_requested": "System.Boolean",
"required": false,
"name": "LockedOut",
"title": "LockedOut",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"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,
"description": "Specifies the service principal names for the account. This parameter sets the ServicePrincipalNames property of the account. The LDAP display name (ldapDisplayName) for this property is servicePrincipalName. This parameter uses the following syntax to add remove, replace or clear service principal name values.\nSyntax:\nTo add values:\n-ServicePrincipalNames @{Add=value1,value2,...}\nTo remove values:\n-ServicePrincipalNames @{Remove=value3,value4,...}\nTo replace values:\n-ServicePrincipalNames @{Replace=value1,value2,...}\nTo clear all values:\n-ServicePrincipalNames $null\nYou can specify more than one change by using a list separated by semicolons. For example, use the following syntax to add and remove service principal names.\n@{Add=value1,value2,...};@{Remove=value3,value4,...}\nThe operators will be applied in the following sequence:\n..Remove\n..Add\n..Replace",
"title": "ServicePrincipalNames",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ServicePrincipalNames"
},
"Instance": {
"__type_requested": "ADComputer",
"required": false,
"description": "Specifies an instance of a computer object to use as a template for a new computer object.\nYou can use an instance of an existing computer object as a template or you can construct a new computer object by using the Windows PowerShell command line or by using a script.\nMethod 1: Use an existing computer object as a template for a new object. To retrieve an instance of an existing computer object use Get-ADComputer. Then provide this object to the Instance parameter of the New-ADComputer cmdlet to create a new computer object. You can override property values of the new object by setting the appropriate parameters.\nMethod 2: Create a new ADcomputer object and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-ADcomputer cmdlet to create the new Active Directory computer object.\nNote: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error.",
"title": "Instance",
"__type_mapping_type": "Unknown",
"name": "Instance",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"PasswordNeverExpires": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether the password of an account can expire. This parameter sets the PasswordNeverExpires property of an account object. This parameter also sets the ADS_UF_DONT_EXPIRE_PASSWD flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1\nNote: This parameter cannot be set to $True or 1 for an account that also has the ChangePasswordAtLogon property set to $True.",
"title": "PasswordNeverExpires",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "PasswordNeverExpires"
},
"AccountPassword": {
"__type_requested": "SecureString",
"required": false,
"description": "Specifies a new password value for an account. This value is stored as an encrypted string.\nThe following conditions apply based on the manner in which the password parameter is used:\n\n-- $Null password is specified: random password is set and the account is enabled unless it is requested to be disabled.\n-- No password is specified: random password is set and the account is enabled unless it is requested to be disabled.\n-- User password is specified: password is set and the account is enabled unless it is requested to be disabled, unless the password you provided does not meet password policy or was not set for other reasons, at which point the account is disabled.\nNotes: Computer accounts, by default, are created with a 240-character random password. If you provide a password, an attempt will be made to set that password however, this can fail due to password policy restrictions. The computer account will still be created and you can use Set-ADAccountPassword to set the password on that account. In order to ensure that accounts remain secure, computer accounts will never be enabled unless a valid password is set (either a randomly-generated or user-provided one) or PasswordNotRequired is set to $True.\nThe account is created if the password fails for any reason.\nThe new ADComputer object will always either be disabled or have a user-requested or randomly-generated password. There is no way to create an enabled computer account object with a password that violates domain password policy, such as an empty password.",
"title": "AccountPassword",
"__type_mapping_type": "Unknown",
"name": "AccountPassword",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"userCertificate": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "userCertificate",
"title": "userCertificate",
"items": {
"type": "string"
},
"__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,
"description": "Specifies object attribute values for attributes that are not represented by cmdlet parameters. You can set one or more parameters at the same time with this parameter. If an attribute takes more than one value, you can assign multiple values. To identify an attribute, specify the LDAP display name (ldapDisplayName) defined for it in the Active Directory schema.\nSyntax:\nTo specify a single value for an attribute:\n-OtherAttributes @{'AttributeLDAPDisplayName'=value}\nTo specify multiple values for an attribute\n-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}\nYou can specify values for more than one attribute by using semicolons to separate attributes. The following syntax shows how to set values for multiple attributes:\n-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}",
"title": "OtherAttributes",
"__type_mapping_type": "Unknown",
"name": "OtherAttributes",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"ManagedBy": {
"__type_requested": "System.String",
"required": false,
"description": "Specifies the user or group that manages the object by providing one of the following property values. Note: The identifier in parentheses is the LDAP display name for the property. The acceptable values for this parameter are:\u00a0\n\n-- A Distinguished Name\n-- A GUID (objectGUID) \n-- A Security Identifier (objectSid) \n-- A SAM Account Name (sAMAccountName)\nThis parameter sets the Active Directory attribute with an LDAP Display Name of managedBy.",
"title": "ManagedBy",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ManagedBy"
},
"HomePage": {
"__type_requested": "String",
"required": false,
"description": "Specifies the URL of the home page of the object. This parameter sets the homePage property of an Active Directory object. The LDAP Display Name (ldapDisplayName) for this property is wWWHomePage.",
"title": "HomePage",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "HomePage"
},
"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"
},
"ServiceAccount": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "ServiceAccount",
"title": "ServiceAccount",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"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"
},
"accountExpires": {
"__type_requested": "System.Int64",
"required": false,
"name": "accountExpires",
"title": "accountExpires",
"__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"
},
"LastLogonDate": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "LastLogonDate",
"title": "LastLogonDate",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"OperatingSystemHotfix": {
"__type_requested": "String",
"required": false,
"description": "Specifies an operating system hotfix name. This parameter sets the operatingSystemHotfix property of the computer object. The LDAP display name for this property is operatingSystemHotfix.",
"title": "OperatingSystemHotfix",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "OperatingSystemHotfix"
},
"PrincipalsAllowedToDelegateToAccount": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"description": "Specifies the accounts which can act on the behalf of users to services running as this computer account. This parameter sets the msDS-AllowedToActOnBehalfOfOtherIdentity attribute of a computer account object.",
"title": "PrincipalsAllowedToDelegateToAccount",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "PrincipalsAllowedToDelegateToAccount"
},
"AuthenticationPolicySilo": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"description": "Specifies an Active Directory Domain Services authentication policy silo object. Specify the authentication policy silo object in one of the following formats: \n\n-- Distinguished Name\n-- GUID\n-- Name\nThis parameter can also get this object through the pipeline or you can set this parameter to an object instance.\nThe cmdlet searches the default naming context or partition to find the object. If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error.",
"title": "AuthenticationPolicySilo",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "AuthenticationPolicySilo"
},
"TrustedForDelegation": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether an account is trusted for Kerberos delegation. A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. This parameter sets the TrustedForDelegation property of an account object. This value also sets the ADS_UF_TRUSTED_FOR_DELEGATION flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1",
"title": "TrustedForDelegation",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "TrustedForDelegation"
},
"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"
},
"uSNChanged": {
"__type_requested": "System.Int64",
"required": false,
"name": "uSNChanged",
"title": "uSNChanged",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"modifyTimeStamp": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "modifyTimeStamp",
"title": "modifyTimeStamp",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"msExchCapabilityIdentifiers": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "msExchCapabilityIdentifiers",
"title": "msExchCapabilityIdentifiers",
"items": {
"type": "string"
},
"__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"
},
"CannotChangePassword": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether the account password can be changed. This parameter sets the CannotChangePassword property of an account. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1",
"title": "CannotChangePassword",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "CannotChangePassword"
},
"AccountLockoutTime": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "AccountLockoutTime",
"title": "AccountLockoutTime",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"OperatingSystem": {
"__type_requested": "String",
"required": false,
"description": "Specifies an operating system name. This parameter sets the OperatingSystem property of the computer object. The LDAP Display Name (ldapDisplayName) for this property is operatingSystem.",
"title": "OperatingSystem",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "OperatingSystem"
},
"SIDHistory": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "SIDHistory",
"title": "SIDHistory",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"dSCorePropagationData": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "dSCorePropagationData",
"title": "dSCorePropagationData",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"Description": {
"__type_requested": "String",
"required": false,
"description": "Specifies a description of the object. This parameter sets the value of the Description property for the object. The LDAP Display Name (ldapDisplayName) for this property is description.",
"title": "Description",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Description"
},
"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"
},
"whenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "whenCreated",
"title": "whenCreated",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"uSNCreated": {
"__type_requested": "System.Int64",
"required": false,
"name": "uSNCreated",
"title": "uSNCreated",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"Name": {
"__type_requested": "String",
"required": true,
"description": "Specifies the name of the object. This parameter sets the Name property of the Active Directory object. The LDAP Display Name (ldapDisplayName) of this property is name.",
"title": "Name",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Name"
},
"Enabled": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies if an account is enabled. An enabled account requires a password. This parameter sets the Enabled property for an account object. This parameter also sets the ADS_UF_ACCOUNTDISABLE flag of the Active Directory User Account Control (UAC) attribute. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1",
"title": "Enabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "Enabled"
},
"createTimeStamp": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "createTimeStamp",
"title": "createTimeStamp",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"IPv4Address": {
"__type_requested": "System.String",
"required": false,
"name": "IPv4Address",
"title": "IPv4Address",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AccountExpirationDate": {
"__type_requested": "DateTime",
"__type_mapping_type": "DateTime",
"description": "Specifies the expiration date for an account. When you set this parameter to 0, the account never expires. This parameter sets the AccountExpirationDate property of an account object. The LDAP Display name (ldapDisplayName) for this property is accountExpires.\nUse the DateTime syntax when you specify this parameter. Time is assumed to be local time unless otherwise specified. When a time value is not specified, the time is assumed to 12:00:00 AM local time. When a date is not specified, the date is assumed to be the current date.",
"title": "AccountExpirationDate",
"format": "date-time",
"required": false,
"readonly": false,
"type": "string",
"name": "AccountExpirationDate"
},
"PasswordLastSet": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "PasswordLastSet",
"title": "PasswordLastSet",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"userAccountControl": {
"__type_requested": "System.Int32",
"required": false,
"name": "userAccountControl",
"title": "userAccountControl",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"CanonicalName": {
"__type_requested": "System.String",
"required": false,
"name": "CanonicalName",
"title": "CanonicalName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AllowReversiblePasswordEncryption": {
"__type_requested": "Boolean",
"required": false,
"description": "Specifies whether reversible password encryption is allowed for the account. This parameter sets the AllowReversiblePasswordEncryption property of the account. This parameter also sets the ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED flag of the Active Directory User Account Control (UAC) attribute. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1",
"title": "AllowReversiblePasswordEncryption",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "AllowReversiblePasswordEncryption"
},
"lastLogon": {
"__type_requested": "System.Int64",
"required": false,
"name": "lastLogon",
"title": "lastLogon",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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/activedirectoryhybrid/ADComputer/add/ |
|
The GUI Add form of device/activedirectoryhybrid/ADComputer 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/activedirectoryhybrid/ADComputer | 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/activedirectoryhybrid/ADComputer/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/activedirectoryhybrid/ADComputer/[pkid1]", "/api/device/activedirectoryhybrid/ADComputer/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADComputer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/activedirectoryhybrid/ADComputer/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/activedirectoryhybrid/ADComputer/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/activedirectoryhybrid/ADComputer/[pkid1]", "/api/v0/device/activedirectoryhybrid/ADComputer/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADComputer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADComputer |
|
{"hrefs": ["/api/device/activedirectoryhybrid/ADComputer/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADComputer |
|
{"hrefs": ["/api/device/activedirectoryhybrid/ADComputer/[pkid1]", "/api/device/activedirectoryhybrid/ADComputer/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/activedirectoryhybrid/ADComputer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/activedirectoryhybrid/ADComputer/export/ |
|
{ "hrefs":["/api/device/activedirectoryhybrid/ADComputer/[pkid1]", "/api/device/activedirectoryhybrid/ADComputer/[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/activedirectoryhybrid/ADComputer and the JSON format can be used to import instances of device/activedirectoryhybrid/ADComputer.
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADComputer/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/activedirectoryhybrid/ADComputer | POST | /api/device/activedirectoryhybrid/ADComputer/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/activedirectoryhybrid/ADComputer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/activedirectoryhybrid/ADComputer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/activedirectoryhybrid/ADComputer/ |
|
The device/activedirectoryhybrid/ADComputer schema and all instances as JSON. |
(The list will return 0 to 3 device/activedirectoryhybrid/ADComputer instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/activedirectoryhybrid/ADComputer/?skip=0&limit=3&order_by=DisplayName&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/activedirectoryhybrid/ADComputer/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/activedirectoryhybrid/ADComputer/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/activedirectoryhybrid/ADComputer/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/activedirectoryhybrid/ADComputer",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/activedirectoryhybrid/ADComputer/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/activedirectoryhybrid/ADComputer/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/activedirectoryhybrid/ADComputer/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/activedirectoryhybrid/ADComputer/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/activedirectoryhybrid/ADComputer/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/activedirectoryhybrid/ADComputer/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/activedirectoryhybrid/ADComputer/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/activedirectoryhybrid/ADComputer",
"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": "DisplayName",
"title": "DisplayName"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "Name",
"title": "Name"
},
{
"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/activedirectoryhybrid/ADComputer. | GET | /api/device/activedirectoryhybrid/ADComputer/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/activedirectoryhybrid/ADComputer as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/activedirectoryhybrid/ADComputer/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/activedirectoryhybrid/ADComputer/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/activedirectoryhybrid/ADComputer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADComputer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/activedirectoryhybrid/ADComputer | 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/activedirectoryhybrid/ADComputer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/activedirectoryhybrid/ADComputer/[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/activedirectoryhybrid/ADComputer and the JSON format can be used to import instances of device/activedirectoryhybrid/ADComputer.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/activedirectoryhybrid/ADComputer/[pkid] | hierarchy=[hierarchy] | The device/activedirectoryhybrid/ADComputer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/activedirectoryhybrid/ADComputer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/activedirectoryhybrid/ADComputer. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/activedirectoryhybrid/ADComputer/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |