[Index]
Model ref.: device/exchangehybrid/SmimeConfig
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": {
"SMIMEExpiredCertificateThumbprint": {
"__type_requested": "System.String",
"required": true,
"name": "SMIMEExpiredCertificateThumbprint",
"title": "SMIMEExpiredCertificateThumbprint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"AdminDisplayName": {
"__type_requested": "System.String",
"required": true,
"name": "AdminDisplayName",
"title": "AdminDisplayName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"OrganizationId": {
"__type_requested": "System.String",
"required": true,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"OWASignedEmailCertificateInclusion": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWASignedEmailCertificateInclusion",
"title": "OWASignedEmailCertificateInclusion",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWASignedEmailCertificateInclusion parameter specifies whether the sender's encryption certificate is excluded from a signed email message in Outlook Web App.\nValid input for this parameter is $true or $false. The default is $true.\nBy default, Outlook Web App and the S/MIME control include both signing and encrypting certificates with signed email messages. When this parameter is set to $false, the size of encrypted messages is reduced. However, recipients don't have access to the sender's encryption certificate in the message. Recipients need to retrieve the certificate from a directory, or from the sender."
},
"OWACRLRetrievalTimeout": {
"__type_requested": "UInt32",
"required": true,
"name": "OWACRLRetrievalTimeout",
"title": "OWACRLRetrievalTimeout",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "The OWACRLRetrievalTimeout parameter specifies the time in milliseconds that Outlook Web App waits to retrieve all CRLs when validating a certificate.\nValid input for this parameter is an integer between 0 and 4294967295 (UInt32). The default value is 10000 (10 seconds).\nIf all the required CRLs are not retrieved before the time limit expires, the operation fails. Suppose the retrieval of three CRLs is required, the OWACRLConnectionTimeout value is set to 60000 (60 seconds), and the OWACRLRetrievalTimeout is set to 120000 (2 minutes). In this example, if any individual CRL retrieval takes more than 60 seconds, the operation fails. Also, if all the CRL retrievals together take more than 120 seconds, the operation fails."
},
"OWABCCEncryptedEmailForking": {
"__type_requested": "UInt32",
"required": true,
"name": "OWABCCEncryptedEmailForking",
"title": "OWABCCEncryptedEmailForking",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "The OWABCCEncryptedEmailForking parameter specifies how Bcc messages are encrypted in Outlook Web App. This parameter uses the following values:\n0 = One encrypted message per Bcc recipient.\n1 = One single encrypted message for all Bcc recipients.\n2 = One encrypted message without Bcc forking.\nThe default value is 0.\nThis setting affects the security and privacy of Outlook Web App. Consult your organization's security policy before you change this setting."
},
"OWAClearSign": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAClearSign",
"title": "OWAClearSign",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAClearSign parameter specifies how email messages are signed in Outlook Web App.\nValid input for this parameter is $true or $false. The default is $true.\nWhen this parameter is set to $true, digitally signed messages are clear-signed. When this parameter is set to $false, digitally signed messages are opaque-signed. Clear-signed messages are larger than opaque-signed messages, but clear-signed messages can be read in most email clients, including clients that don't support S/MIME."
},
"OWAAlwaysSign": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAAlwaysSign",
"title": "OWAAlwaysSign",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAAlwaysSign parameter specifies whether all outgoing messages are automatically signed in Outlook Web App.\nValid input for this parameter is $true or $false. The default value is $false."
},
"OWACheckCRLOnSend": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWACheckCRLOnSend",
"title": "OWACheckCRLOnSend",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWACheckCRLOnSend parameter specifies how the certificate revocation list (CRL) check is enforced when an email message is sent in Outlook Web App.\nValid input for this parameter is $true or $false. The default value is $false.\nWhen this parameter is set to $false and the CRL distribution point is inaccessible, Outlook Web App allows signed or encrypted messages to be sent. When this parameter is set to $true, Outlook Web App displays a warning dialog box and prevents signed or encrypted messages from being sent."
},
"WhenCreatedUTC": {
"__type_requested": "",
"required": true,
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"OWACRLConnectionTimeout": {
"__type_requested": "UInt32",
"required": true,
"name": "OWACRLConnectionTimeout",
"title": "OWACRLConnectionTimeout",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "The OWACRLConnectionTimeout parameter specifies the time in milliseconds that Outlook Web App waits while connecting to retrieve a single CRL as part of a certificate validation operation.\nValid input for this parameter is an integer between 0 and 4294967295 (UInt32). The default value is 60000 (60 seconds).\nWhen multiple CRLs in a certificate chain must be retrieved, the time limit that's specified by this parameter applies to each connection. For example, if a certificate requires the retrieval of three CRLs, and this parameter is set to 60000 (60 seconds), each individual CRL retrieval operation has a time limit of 60 seconds. If any one of the CRLs isn't retrieved before the time limit expires, the entire operation fails. The total time limit for all the retrievals is controlled by the OWACRLRetrievalTimeout parameter."
},
"OWATripleWrapSignedEncryptedMail": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWATripleWrapSignedEncryptedMail",
"title": "OWATripleWrapSignedEncryptedMail",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWATripleWrapSignedEncryptedMail parameter specifies whether signed and encrypted email messages in Outlook Web App are triple-wrapped.\nValid input for this parameter is $true or $false. The default is $true.\nA triple-wrapped message is a signed message that is encrypted, and then the encrypted message is signed (signed-encrypted-signed). When this parameter is set to $false, the signed message is encrypted only (there is no additional signing of the encrypted message). Triple-wrapped messages offer the highest level of security for messages under the S/MIME standard, but are larger in size."
},
"Name": {
"__type_requested": "System.String",
"required": true,
"name": "Name",
"title": "Name",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"OWADisableCRLCheck": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWADisableCRLCheck",
"title": "OWADisableCRLCheck",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWADisableCRLCheck parameter enables or disables CRL checking in Outlook Web App.\nValid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter disables CRL checks when validating certificates. Disabling CRL checking can decrease the time that's required to validate the signatures of signed email messages, but it also validates email messages signed with revoked certificates."
},
"OWAEncryptionAlgorithms": {
"__type_requested": "System.String",
"required": true,
"name": "OWAEncryptionAlgorithms",
"title": "OWAEncryptionAlgorithms",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The OWAEncryptionAlgorithms parameter specifies a list of algorithms that are used by Outlook Web App to encrypt messages.\nValid input for this parameter is a semicolon-separated list of symmetric encryption algorithm identifiers. When you use an algorithm that supports multiple key lengths, you need to specify the key length. Note that RC2 is the only supported algorithm that that offers multiple key lengths.\nYou can specify the object identifier (OID) of the cryptographic service provider (CSP) when using third-party CSPs. An OID must be specified together with an algorithm ID. Outlook Web App needs an algorithm ID so that it can infer how the algorithm should be used. For example, to provide a custom replacement for the 3DES algorithm, you would specify the algorithm ID of 3DES (6603) and the custom OID of the replacement algorithm by using the value 6603,<OID>.\nThe encryption algorithms, key length values, and algorithm IDs that you can use with this parameter are described in the following list:\nRC2 algorithm ID 6602 (supported key lengths are 40, 56, 64, and 128)\nDES (56-bit) algorithm ID 6601\n3DES (168-bit) algorithm ID 6603\nAES128 algorithm ID 660E\nAES192 algorithm ID 660F\nAES256 algorithm ID 6610\nThis parameter uses the following syntax:\n\n{Algorithm ID} |; [Algorithm ID] | [,Custom replacement algorithm OID] |; [Algorithm ID[:key length]] ....\n\nFor example, to set the encryption algorithms to 3DES, RC2-128, RC2-64, DES, and RC2-56, use the following value: 6603;6602:128;6602:64;6601;6602:56.\nThe algorithm specified by OWAEncryptionAlgorithms is always used. If the parameter is not specified or is not formatted correctly, Outlook Web App uses the default value 6610 (AES256). If the encryption algorithm or minimum key length is not available on a client, Outlook Web App does not allow encryption."
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": true,
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array"
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"PSComputerName": {
"__type_requested": "System.String",
"required": false,
"name": "PSComputerName",
"title": "PSComputerName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"OWAIncludeCertificateChainWithoutRootCertificate": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAIncludeCertificateChainWithoutRootCertificate",
"title": "OWAIncludeCertificateChainWithoutRootCertificate",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAIncludeCertificateChainWithoutRootCertificate parameter specifies whether the certificate chains of the signing or encryption certificates are included in messages in Outlook Web App.\nValid input for this parameter is $true or $false. The default is $false.\nBy default, Outlook Web App includes only the signing and encrypting certificates, not their corresponding certificate chains. When this parameter is set to $true, signed or encrypted messages include the full certificate chain, but not the root certificate."
},
"OWADLExpansionTimeout": {
"__type_requested": "UInt32",
"required": true,
"name": "OWADLExpansionTimeout",
"title": "OWADLExpansionTimeout",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "The OWADLExpansionTimeout parameter specifies the time in milliseconds that Outlook Web App waits when sending encrypted messages to members of a distribution group that requires expansion.\nValid input for this parameter is an integer between 0 and 4294967295 (UInt32). The default value is 60000 (60 seconds). If the operation doesn't complete in the time specified by this parameter, the operation fails and the message is not sent.\nWhen sending an encrypted message to a distribution group, Exchange expands the distribution group to retrieve the encryption certificate of each recipient. While the distribution group is being expanded, the sender receives no response from Outlook Web App.\nThe timeout value that's specified by this parameter is applied to the expansion of each distribution group. For example, if an encrypted message is sent to three distribution group, and the value of this parameter is 60000 (60 seconds), the entire operation can take no more than 180 seconds."
},
"ObjectState": {
"__type_requested": "System.String",
"required": true,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"OWASenderCertificateAttributesToDisplay": {
"__type_requested": "System.String",
"required": true,
"name": "OWASenderCertificateAttributesToDisplay",
"title": "OWASenderCertificateAttributesToDisplay",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The OWASenderCertificateAttributesToDisplay parameter controls which certificate attributes are displayed when signature verification proceeds despite a mismatch between the sender's email address and the email address in sender's certificate.\nThe parameter accepts a comma-separated list of object identifiers (OIDs). This setting is blank ($null) by default."
},
"OWAAlwaysEncrypt": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAAlwaysEncrypt",
"title": "OWAAlwaysEncrypt",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAAlwaysEncrypt parameter specifies whether all outgoing messages are automatically encrypted in Outlook Web App.\nValid input for this parameter is $true or $false. The default value is $false."
},
"Identity": {
"__type_requested": "System.String",
"required": true,
"name": "Identity",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": true,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"SMIMECertificateIssuingCA": {
"__type_requested": "Byte[]",
"required": true,
"description": "The SMIMECertificateIssuingCA parameter specifies the serialized certificate store (SST) that contains the Certificate Authority (CA) signing and intermediate certificate information.\nYou need to read the file to a byte-encoded object using the Get-Content cmdlet. For example: -SMIMECertificateIssuingCA $([byte[]](Get-Content -Encoding byte -Path \"C:\\Temp\\CACertificateSerializedStore.sst\" -ReadCount 0)\nEach certificate is checked, and if any certificates are expired, the operation will fail.",
"title": "SMIMECertificateIssuingCA",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "SMIMECertificateIssuingCA"
},
"OriginatingServer": {
"__type_requested": "System.String",
"required": true,
"name": "OriginatingServer",
"title": "OriginatingServer",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"SMIMECertificatesExpiryDate": {
"__type_requested": "",
"required": true,
"name": "SMIMECertificatesExpiryDate",
"title": "SMIMECertificatesExpiryDate",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"OWAUseSecondaryProxiesWhenFindingCertificates": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAUseSecondaryProxiesWhenFindingCertificates",
"title": "OWAUseSecondaryProxiesWhenFindingCertificates",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAUseSecondaryProxiesWhenFindingCertificates parameter specifies whether alternative proxies are used during the certificate search in Outlook Web App.\nValid input for this parameter is $true or $false. The default is $true.\nOutlook Web App attempts to find the correct certificate for a recipient when sending encrypted messages. The certificate subject or subject alternative name values can each contain an email address. Because a recipient can have multiple proxy addresses, the certificate's subject or subject alternative name values may not match the recipient's primary SMTP address. When this parameter is set to $true, and the certificate subject or subject alternative name values do not match the recipient's primary SMTP address, Outlook Web App tries to match the certificate's subject to one of the recipient's proxy addresses."
},
"OWAIncludeCertificateChainAndRootCertificate": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAIncludeCertificateChainAndRootCertificate",
"title": "OWAIncludeCertificateChainAndRootCertificate",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAIncludeCertificateChainAndRootCertificate parameter specifies whether the certificate chains and root certificates of the signing or encryption certificates are included in the message in Outlook Web App.\nValid input for this parameter is $true or $false. The default value is $false."
},
"OWAUseKeyIdentifier": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAUseKeyIdentifier",
"title": "OWAUseKeyIdentifier",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAUseKeyIdentifier parameter specifies whether a certificate's key identifier is used to encode the asymmetrically encrypted token in Outlook Web App.\nValid input for this parameter is $true or $false. The default is $false.\nBy default, Outlook Web App encodes the asymmetrically encrypted token (sometimes called a lockbox) that's required to decrypt the rest of the message by indicating the issuer and serial number of each recipient's certificate. The issuer and serial number can then be used to locate the certificate and private key for decrypting the message.\nThis parameter causes the use of a certificate's key identifier when encoding the asymmetrically encrypted token. Because a key pair can be reused in new certificates, using the key identifier for encrypted email messages means that users need to keep only the most recent certificate and associated private key, rather than all old certificates. Because some email clients do not support finding certificates with a key identifier, Outlook Web App uses the issuer and serial number of each recipient's certificate by default."
},
"OWACopyRecipientHeaders": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWACopyRecipientHeaders",
"title": "OWACopyRecipientHeaders",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": true,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"OWAAllowUserChoiceOfSigningCertificate": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAAllowUserChoiceOfSigningCertificate",
"title": "OWAAllowUserChoiceOfSigningCertificate",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAAllowUserChoiceOfSigningCertificate parameter specifies whether to allow users to select the certificate to use when they digitally sign email messages in Outlook Web App.\nValid input for this parameter is $true or $false. The default value is $false."
},
"OWAForceSMIMEClientUpgrade": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAForceSMIMEClientUpgrade",
"title": "OWAForceSMIMEClientUpgrade",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAForceSMIMEClientUpgrade parameter specifies whether or not users are forced to upgrade an S/MIME control that's older than their current version in Outlook Web App.\nValid input for this parameter is $true or $false. The default is $true.\nIf the parameter is set to $true, users need to download and install the new control before they can use S/MIME. If this parameter is set to $false, users receive a warning if the S/MIME control on their computer is not current, but they can still use S/MIME without updating the control."
},
"OWAOnlyUseSmartCard": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAOnlyUseSmartCard",
"title": "OWAOnlyUseSmartCard",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAOnlyUseSmartCard parameter specifies whether smartcard-based certificates are required for Outlook Web App message signing and decryption.\nValid input for this parameter is $true or $false. The default is $false\nWhen this parameter is set to $true, the use of smartcard-based certificates for signing and decryption is required when you use Outlook Web App and the S/MIME control."
},
"ObjectCategory": {
"__type_requested": "",
"required": true,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"IsValid": {
"__type_requested": "System.Boolean",
"required": true,
"name": "IsValid",
"title": "IsValid",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean"
},
"WhenChanged": {
"__type_requested": "",
"required": true,
"name": "WhenChanged",
"title": "WhenChanged",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"WhenChangedUTC": {
"__type_requested": "",
"required": true,
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"WhenCreated": {
"__type_requested": "",
"required": true,
"name": "WhenCreated",
"title": "WhenCreated",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"OWAEncryptTemporaryBuffers": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAEncryptTemporaryBuffers",
"title": "OWAEncryptTemporaryBuffers",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAEncryptTemporaryBuffers parameter specifies whether the Outlook Web App client-side temporary message storage buffers are encrypted.\nValid input for this parameter is $true or $false. The default value is $true.\nBy default, all client-side temporary buffers that store message data are encrypted using an ephemeral key and the 3DES algorithm. Setting this parameter to $false disables temporary buffer encryption.\nDisabling encryption of the buffers can increase performance of the Outlook Web App client but also leaves information unencrypted in the client's buffer. Consult your organization's security policy before you disable this feature."
},
"OWAIncludeSMIMECapabilitiesInMessage": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAIncludeSMIMECapabilitiesInMessage",
"title": "OWAIncludeSMIMECapabilitiesInMessage",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAIncludeSMIMECapabilitiesInMessage parameter specifies whether signed and encrypted messages in Outlook Web App include attributes that describe the supported encryption and signing algorithms.\nValid input for this parameter is $true or $false. The default is $false.\nEnabling this option increases the size of messages, but may make it easier for some email clients to interact with encrypted messages in Outlook Web App."
},
"RunspaceId": {
"__type_requested": "System.Guid",
"required": false,
"name": "RunspaceId",
"title": "RunspaceId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Guid": {
"__type_requested": "System.Guid",
"required": true,
"name": "Guid",
"title": "Guid",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"Id": {
"__type_requested": "System.String",
"required": true,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"OWASigningAlgorithms": {
"__type_requested": "System.String",
"required": true,
"name": "OWASigningAlgorithms",
"title": "OWASigningAlgorithms",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The OWASigningAlgorithms parameter specifies the list of signing algorithms that are used by Outlook Web App to sign messages with the S/MIME control.\nValid input for this parameter is a semicolon-separated list of symmetric encryption algorithm identifiers.\nYou can specify the object identifier (OID) of the cryptographic service provider (CSP) when using third-party CSPs. An OID must be specified together with an algorithm ID. Outlook Web App needs an algorithm ID so that it can infer how the algorithm should be used. For example, to provide a custom replacement for the SHA1 algorithm, you would specify the algorithm ID of SHA1 (8804) and the custom OID of the replacement algorithm by using the value 8804,<OID>.\nThis parameter supports the following algorithms.\nCALG_SHA_512 Type: 512 bit secure hashing algorithm (SHA). Algorithm ID: 800E.\nCALG_SHA_384 Type: 384 bit SHA. Algorithm ID: 800D.\nCALG_SHA_256 Type: 256 bit SHA. Algorithm ID: 800C.\nSHA1 Type: SHA. Algorithm ID: 8004.\nCALG_MD5 Type: MD5 hashing algorithm. Algorithm ID: 8003.\nThis parameter uses the following syntax:\n\n{Algorithm ID} |; [Algorithm ID] | [,Custom replacement algorithm OID] |; [Algorithm ID[:key length]] ...\n\nFor example, to set the signing algorithms to CALG_SHA_512, SHA1, and CALG_MD5, use the value 800E;8004;8003.\nThe algorithm specified by OWASigningAlgorithms is always used. If this parameter is not specified or is not formatted correctly, Outlook Web App defaults to 8004 (SHA1)."
}
},
"schema_version": "15312"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangehybrid/SmimeConfig/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangehybrid/SmimeConfig/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/SmimeConfig/[pkid1]", "/api/v0/device/exchangehybrid/SmimeConfig/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/SmimeConfig/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/SmimeConfig |
|
{"hrefs": ["/api/device/exchangehybrid/SmimeConfig/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/SmimeConfig |
|
{"hrefs": ["/api/device/exchangehybrid/SmimeConfig/[pkid1]", "/api/device/exchangehybrid/SmimeConfig/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/SmimeConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/SmimeConfig/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/SmimeConfig/[pkid1]", "/api/device/exchangehybrid/SmimeConfig/[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/exchangehybrid/SmimeConfig and the JSON format can be used to import instances of device/exchangehybrid/SmimeConfig.
GET http://[host-proxy]/api/device/exchangehybrid/SmimeConfig/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/SmimeConfig | POST | /api/device/exchangehybrid/SmimeConfig/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/exchangehybrid/SmimeConfig/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchangehybrid/SmimeConfig/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangehybrid/SmimeConfig/ |
|
The device/exchangehybrid/SmimeConfig schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/SmimeConfig instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "Name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/exchangehybrid/SmimeConfig/?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": "15312",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/exchangehybrid/SmimeConfig/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/exchangehybrid/SmimeConfig",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/exchangehybrid/SmimeConfig/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/exchangehybrid/SmimeConfig/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/exchangehybrid/SmimeConfig/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/exchangehybrid/SmimeConfig/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/exchangehybrid/SmimeConfig/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/exchangehybrid/SmimeConfig/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/exchangehybrid/SmimeConfig/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/exchangehybrid/SmimeConfig",
"model_specific_actions": [
"get",
"list",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"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/exchangehybrid/SmimeConfig. | GET | /api/device/exchangehybrid/SmimeConfig/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/SmimeConfig as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangehybrid/SmimeConfig/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/SmimeConfig/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/SmimeConfig/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/SmimeConfig | 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/exchangehybrid/SmimeConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/SmimeConfig/[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/exchangehybrid/SmimeConfig and the JSON format can be used to import instances of device/exchangehybrid/SmimeConfig.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangehybrid/SmimeConfig/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/SmimeConfig instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangehybrid/SmimeConfig/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/SmimeConfig. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangehybrid/SmimeConfig/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |