Connectors Reference
Take back control of your Microsoft Public Key Infrastructure (ADCS) with the Microsoft Power Platform and Cloud PKI Management from 509 Solutions.
|
Status: Preview |
Tier: Standard |
Version: 1.0.6 |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Query Certificates
Description: Query Certificates Issued by this Cloud PKI deployment
Syntax:
CloudPKIManagement.Query-Certificates (string regionid, string deploymentid, [Optional]string timevalid, [Optional]string important, [Optional]string renewalstatus, [Optional]integer expiring, [Optional]string subject, [Optional]string status, [Optional]string serialnumber, [Optional]string ski, [Optional]string aki, [Optional]string keytype, [Optional]integer keylength, [Optional]string owneremail)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
timevalid |
string (Time Valid)Values: [true, false] |
Certificates that are still time valid |
False |
|
|
important |
string (Important Certificate) |
Certificates that are marked important |
False |
|
|
renewalstatus |
string (Renewal Status) |
Query by Current renewal status |
False |
|
|
expiring |
integer(int32) (Expiring in) |
Certificates expiring in the next days. (Min=1 Max=180) |
False |
|
|
subject |
string (Subject) |
Subject name to query for |
False |
|
|
status |
string (Status)Values: [Issued, Revoked] |
Current status of the certificate |
False |
|
|
serialnumber |
string (Serial Number) |
Serial Number of the certificate to query for |
False |
|
|
ski |
string (Subject Key Identifier (SKI)) |
Subject Key Identifier of the certificates to query for |
False |
|
|
aki |
string (Authority Key Identifier) |
Authority Key Identifier of the certificates to query for |
False |
|
|
keytype |
string (Key Type) |
Public Key Algorithm Type to search for |
False |
|
|
keylength |
integer (Key Length) |
Public Key Length of the certificates to query for |
False |
|
|
owneremail |
string (Owner Email Addresses) |
Email Address of Certificate Owners to query certificates for |
False |
Returns:
Type:array of (Query-CertificatesResponseItem)
Summary: Get Certificate
Description: Get a Certificate by its SHA1 Thumbprint
Syntax:
CloudPKIManagement.Get-Certificate (string regionid, string deploymentid, string thumbprint)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
thumbprint |
string (Thumbprint) |
Certificate SHA1 Thumbprint |
True |
Returns:
Summary: Update Certificate
Description: Change the status or metadata of a certificate
Syntax:
CloudPKIManagement.Update-Certificate ([internal]string Content-Type, string regionid, string deploymentid, string thumbprint, string powerapps, [Optional]Update-CertificateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content-Type) |
Must be "application/merge-patch+json" |
True |
|
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
thumbprint |
string (Thumbprint) |
Certificate SHA1 Thumbprint |
True |
|
|
powerapps |
string (Are You PowerApps?)Values: [false, true] |
Set to false unless calling from PowerApps |
True |
|
|
body |
Update-CertificateParameterBody
|
|
False |
Returns:
Type:Update-CertificateResponse
Summary: Get Template
Description: Fetch a certificate template configuration
Syntax:
CloudPKIManagement.Get-Template (string regionid, string deploymentid, string templateid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
templateid |
string (Template ID) |
Template Identifier |
True |
Returns:
Type:Get-TemplateResponse
Summary: Update Template
Description: Change the status or metadata of a Template
Syntax:
CloudPKIManagement.Update-Template ([internal]string Content-Type, string regionid, string deploymentid, string templateid, string powerapps, [Optional]Update-TemplateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content-Type) |
Must be "application/merge-patch+json" |
True |
|
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
templateid |
string (Template ID) |
Certificate Template ID |
True |
|
|
powerapps |
string (Are You PowerApps?)Values: [false, true] |
Set to false unless calling from PowerApps |
True |
|
|
body |
|
|
False |
Returns:
Summary: Query Certificate Templates
Description: Search for certificate templates
Syntax:
CloudPKIManagement.Query-Templates (string regionid, string deploymentid, [Optional]string status, [Optional]string type, [Optional]string version, [Optional]string templateoid, [Optional]string keytype, [Optional]integer min-minkeylength, [Optional]integer max-minkeylength, [Optional]integer min-validity, [Optional]integer max-validity)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
status |
string (Status)Values: [Published, Unpublished] |
Select Published or Unpublished |
False |
|
|
type |
string (Type)Values: [User, Computer] |
Select User or Computer |
False |
|
|
version |
string (Template Version)Values: [1, 2, 3, 4] |
Select Version 1 (Server 2000), Version 2 (Server 2003 Enterprise), Version 3 (Server 2008 Standard), Version 4 (Server 2012 Standard) |
False |
|
|
templateoid |
string (Template OID) |
eg..1.3.6.1.4.1.52136 |
False |
|
|
keytype |
string (Key Type)Values: [RSA, ECC] |
Select RSA or ECC |
False |
|
|
min-minkeylength |
integer (Smallest Minimum Key Length) |
Minimum key lengths greater than or equal to eg.. 512 |
False |
|
|
max-minkeylength |
integer (Largest Minimum Key Length) |
Minimum key lengths less than or equal to eg.. 4096 |
False |
|
|
min-validity |
integer (Shortest Validity Period) |
Certificates valid for at least "x" days eg.. 180 |
False |
|
|
max-validity |
integer (Longest Validity Period) |
Certificates valid for at most "x" days eg.. 180 |
False |
Returns:
Type:array of (Query-TemplatesResponseItem)
Summary: Get Certificate Revocation List (CRL)
Description: Get a Certificate Revocation List from this deployment by its CRL ID
Syntax:
CloudPKIManagement.Get-CRL (string regionid, string deploymentid, string crlid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
crlid |
string (CRL ID) |
Certificate Revocation List in the form of <AKI>-<CRLNumber> |
True |
Returns:
Type:Get-CRLResponse
Summary: Query Certificate Revocation Lists (CRLs)
Description: Queries for CRLs based on selected criteria
Syntax:
CloudPKIManagement.Query-CRLs (string regionid, string deploymentid, [Optional]string crlid, [Optional]string status, [Optional]integer issued, [Optional]integer expiring, [Optional]string crlnumber, [Optional]string crlnumberdecimal, [Optional]string aki, [Optional]string serialnumber)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
crlid |
string (CRL ID) |
Cloud PKI Certificate Revocation List ID |
False |
|
|
status |
string (CRL Status)Values: [valid, expired] |
Current CRL Status |
False |
|
|
issued |
integer (Issued in the past # days) |
Days |
False |
|
|
expiring |
integer (CRLS Expiring in the next # days) |
Days |
False |
|
|
crlnumber |
string (CRL Number) |
Hexadecimal CRL number as shown by the OS |
False |
|
|
crlnumberdecimal |
string (CRL Number in Decimal) |
Decimal representation of the CRL Number |
False |
|
|
aki |
string (Authority Key Identifier) |
AKI which is the SKI of the CRLs Issuing CA |
False |
|
|
serialnumber |
string (Contains Serial Number) |
Serial number to search for in certificate revocation lists |
False |
Returns:
Type:array of (Query-CRLsResponseItem)
Summary: Query Requests
Description: Query Certificate Signing Requests
Syntax:
CloudPKIManagement.Query-Requests (string regionid, string deploymentid, [Optional]string status, [Optional]string source, [Optional]string approverid, [Optional]string approveremail, [Optional]string submitterid, [Optional]string submitteremail, [Optional]string owneremail)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
status |
string (Request Status)Values: [pending, denied, failed, approved] |
Current Request Status |
False |
|
|
source |
string (Request Source) |
"Cloud PKI" or Certificate Authority Common Name eg "Issuing CA 1" |
False |
|
|
approverid |
string (Approver ID) |
Azure Active Directory Approver ID |
False |
|
|
approveremail |
string (Approver Email) |
Approvers Email Address |
False |
|
|
submitterid |
string (Submitter ID) |
Azure Active Directory Submitter ID |
False |
|
|
submitteremail |
string (Submitter Email) |
Submitters Email Address |
False |
|
|
owneremail |
string (Owner Email Addresses) |
Certificate Owner Email Addresses |
False |
Returns:
Type:array of (Query-RequestsResponseItem)
Summary: New Request
Description: New Certificate Request
Syntax:
CloudPKIManagement.New-Request (string regionid, string deploymentid, string powerapps, [Optional]New-RequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
powerapps |
string (Are You PowerApps?)Values: [false, true] |
Set to false unless calling from PowerApps |
True |
|
|
body |
|
|
False |
Returns:
Type:New-RequestResponse
Summary: Get Request
Description: Retrieve a Certificate Signing Request (CSR)
Syntax:
CloudPKIManagement.Get-Request (string regionid, string deploymentid, string requestid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
requestid |
string (Request ID) |
Cloud PKI Request ID |
True |
Returns:
Type:Get-RequestResponse
Summary: Update Request
Description: Approve, Deny or Update an existing Certificate Request
Syntax:
CloudPKIManagement.Update-Request ([internal]string Content-Type, string regionid, string deploymentid, string requestid, string powerapps, [Optional]Update-RequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content-Type) |
Must be "application/merge-patch+json" |
True |
|
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
requestid |
string (Request ID) |
Cloud PKI Request ID |
True |
|
|
powerapps |
string (Are You PowerApps?)Values: [false, true] |
Set to false unless calling from PowerApps |
True |
|
|
body |
|
|
False |
Returns:
Summary: Query Hooks
Description: Query all hooks in this Cloud PKI Deployment
Syntax:
CloudPKIManagement.Query-Hooks (string regionid, string deploymentid, [Optional]string status, [Optional]string type, [Optional]string event)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
status |
string (Status)Values: [Enabled, Disabled] |
Hook Status |
False |
|
|
type |
string (Type)Values: [Email, Web, PowerBI] |
Hook Type |
False |
|
|
event |
string (Event)Values: [issued-certificate, revoked-certificate, pending-request, approved-request, denied-request, failed-request, updated-request, issued-crl, published-template, unpublished-template, added-hook, removed-hook, renewing-certificate, expiring-certificate, expired-certificate] |
Event Name |
False |
Returns:
Type:array of (Query-HooksResponseItem)
Summary: New Hook
Description: Add a new hook to this Cloud PKI Deployment
Syntax:
CloudPKIManagement.New-Hook (string regionid, string deploymentid, string powerapps, [Optional]New-HookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
powerapps |
string (Are You PowerApps?)Values: [false, true] |
Set to false unless calling from PowerApps |
True |
|
|
body |
|
|
False |
Returns:
Type:New-HookResponse
Summary: Get Hook
Description: Get a hook subscribed to this deployment by its HookID
Syntax:
CloudPKIManagement.Get-Hook (string regionid, string deploymentid, string hookid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
hookid |
string (Hook ID) |
Cloud PKI Hook ID. It is a SHA1 Thumbprint of the Callback URL/Email Address |
True |
Returns:
Type:Get-HookResponse
Summary: Delete Hook
Description: Delete a hook subscribed to this deployment by its ID
Syntax:
CloudPKIManagement.Delete-Hook (string regionid, string deploymentid, string hookid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
hookid |
string (Hook ID) |
Cloud PKI Hook ID. It is a SHA1 Thumbprint of the Callback URL/Email Address |
True |
Returns:
Type:string
Summary: Get Published Certificate
Description: Download Issued Certificates for Submitters and Owners
Syntax:
CloudPKIManagement.Get-PublishedCertificate (string regionid, string deploymentid, string thumbprint)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
thumbprint |
string (Thumbprint) |
Certificate SHA1 Thumbprint to Download |
True |
Returns:
Type:string
Summary: Get Published Templates
Description: Gets Published Templates for Certificate Requests
Syntax:
CloudPKIManagement.Get-PublishedTemplates (string regionid, string deploymentid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
Returns:
Type:array of (Get-PublishedTemplatesResponseItem)
Summary: Get Connector Action
Description: Get a Connector Action by its Action ID
Syntax:
CloudPKIManagement.Get-ConnectorAction (string regionid, string deploymentid, string connectoractionid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
connectoractionid |
string (Connector Action ID) |
Connector Action ID |
True |
Returns:
Type:Get-ConnectorActionResponse
Summary: Get Actions
Description: Retrieve upcoming required actions for this PKI
Syntax:
CloudPKIManagement.Get-Actions (string regionid, string deploymentid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
Returns:
Type:array of (Get-ActionsResponseItem)
Summary: Get Authentication Details
Description: Gets the Azure Authentication Details for the Current Session
Syntax:
CloudPKIManagement.Get-Authentication ()
Returns:
Type:string
Summary: Get Regions
Description: Gets the currently active Cloud PKI Management Regions
Syntax:
CloudPKIManagement.Get-Regions ()
Returns:
Type:array of (Get-RegionsResponseItem)
Summary: Get User Deployments
Description: Retrieves the users configured deployments
Syntax:
CloudPKIManagement.Get-UserDeployments ()
Returns:
Type:array of (Get-UserDeploymentsResponseItem)
Summary: Get Region Deployments
Description: Gets a Users Deployments Filtered by RegionID
Syntax:
CloudPKIManagement.Get-RegionDeployments (string regionid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
|
True |
Returns:
Type:array of (Get-RegionDeploymentsResponseItem)
Summary: Hook Added
Description: A new hook has been added to this Cloud PKI deployment
Syntax:
CloudPKIManagement.Added-Hook (string regionid, string deploymentid, Added-HookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Type:Added-HookResponse
Summary: Hook Removed
Description: A hook has been removed from this Cloud PKI deployment
Syntax:
CloudPKIManagement.Removed-Hook (string regionid, string deploymentid, Removed-HookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Type:Removed-HookResponse
Summary: Certificate Issued
Description: A new certificate has been issued by the Certificate Authority
Syntax:
CloudPKIManagement.Issued-Certificate (string regionid, string deploymentid, Issued-CertificateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Issued-CertificateParameterBody
|
|
True |
Returns:
Type:Issued-CertificateResponse
Summary: Certificate Revoked
Description: An existing certificate has been revoked by the Certificate Authority
Syntax:
CloudPKIManagement.Revoked-Certificate (string regionid, string deploymentid, Revoked-CertificateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Revoked-CertificateParameterBody
|
|
True |
Returns:
Type:Revoked-CertificateResponse
Summary: Certificate Updated
Description: An existing certificate's CloudPKI properties have been updated.
Syntax:
CloudPKIManagement.Updated-Certificate (string regionid, string deploymentid, Updated-CertificateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Updated-CertificateParameterBody
|
|
True |
Returns:
Type:Updated-CertificateResponse
Summary: Certificate Expiring
Description: A certificate is expiring in 60 days
Syntax:
CloudPKIManagement.Expiring-Certificate (string regionid, string deploymentid, Expiring-CertificateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Expiring-CertificateParameterBody
|
|
True |
Returns:
Type:Expiring-CertificateResponse
Summary: Certificate Expired
Description: A certificate has expired.
Syntax:
CloudPKIManagement.Expired-Certificate (string regionid, string deploymentid, Expired-CertificateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Expired-CertificateParameterBody
|
|
True |
Returns:
Type:Expired-CertificateResponse
Summary: Certificate Renewing
Description: A certificate is available for renewal.
Syntax:
CloudPKIManagement.Renewing-Certificate (string regionid, string deploymentid, Renewing-CertificateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Renewing-CertificateParameterBody
|
|
True |
Returns:
Type:Renewing-CertificateResponse
Summary: Request Pending Approval
Description: A new certificate request is pending approval from a Certificate Manager
Syntax:
CloudPKIManagement.Pending-Request (string regionid, string deploymentid, Pending-RequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Summary: Request Approved
Description: A certificate request has been approved for issuance by a Certificate Manager
Syntax:
CloudPKIManagement.Approved-Request (string regionid, string deploymentid, Approved-RequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Summary: Request Denied
Description: A certificate request has been denied issuance by a Certificate Manager
Syntax:
CloudPKIManagement.Denied-Request (string regionid, string deploymentid, Denied-RequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Summary: Request Updated
Description: An existing request's CloudPKI properties have been updated.
Syntax:
CloudPKIManagement.Updated-Request (string regionid, string deploymentid, Updated-RequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Summary: Request Failed
Description: A certificate request has failed to be processed by the Certificate Authority
Syntax:
CloudPKIManagement.Failed-Request (string regionid, string deploymentid, Failed-RequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Summary: Template Published
Description: A certificate template has been published by the Certificate Authority
Syntax:
CloudPKIManagement.Published-Template (string regionid, string deploymentid, Published-TemplateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Published-TemplateParameterBody
|
|
True |
Returns:
Type:Published-TemplateResponse
Summary: Template Unpublished
Description: A certificate template has been unpublished by the Certificate Authority
Syntax:
CloudPKIManagement.Unpublished-Template (string regionid, string deploymentid, Unpublished-TemplateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Unpublished-TemplateParameterBody
|
|
True |
Returns:
Type:Unpublished-TemplateResponse
Summary: Template Updated
Description: A certificate template has been updated.
Syntax:
CloudPKIManagement.Updated-Template (string regionid, string deploymentid, Updated-TemplateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Summary: CRL Issued
Description: A new certificate revocation list (CRL) has been issued by the Certificate Authority
Syntax:
CloudPKIManagement.Issued-CRL (string regionid, string deploymentid, Issued-CRLParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
|
|
True |
Returns:
Type:Issued-CRLResponse
Summary: Connector Action Added
Description: A new Cloud PKI Connector action has been Added.
Syntax:
CloudPKIManagement.New-ConnectorAction (string regionid, string deploymentid, New-ConnectorActionParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
New-ConnectorActionParameterBody
|
|
True |
Returns:
Type:New-ConnectorActionResponse
Summary: Connector Action Completed
Description: An action executed by the Cloud PKI Connector has completed.
Syntax:
CloudPKIManagement.Completed-ConnectorAction (string regionid, string deploymentid, Completed-ConnectorActionParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Completed-ConnectorActionParameterBody
|
|
True |
Returns:
Type:Completed-ConnectorActionResponse
Summary: Connector Action Failed
Description: An action executed by the Cloud PKI Connector has failed.
Syntax:
CloudPKIManagement.Failed-ConnectorAction (string regionid, string deploymentid, Failed-ConnectorActionParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Failed-ConnectorActionParameterBody
|
|
True |
Returns:
Type:Failed-ConnectorActionResponse
Summary: Connector Action Stalled
Description: An action executed by the Cloud PKI Connector has stalled.
Syntax:
CloudPKIManagement.Stalled-ConnectorAction (string regionid, string deploymentid, Stalled-ConnectorActionParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
regionid |
string (Region ID) |
Cloud PKI Deployment Region |
True |
|
|
deploymentid |
string (Deployment ID) |
Cloud PKI Deployment ID eg.. 24F3NU4E |
True |
|
|
body |
Stalled-ConnectorActionParameterBody
|
|
True |
Returns:
Type:Stalled-ConnectorActionResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Status |
|
hookid |
string
|
Hook ID |
|
message |
string
|
Status Message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
thumbprint |
string
|
Certificate Thumbprint |
|
validto |
string
|
Certificate Expiry Date |
|
validtoepoch |
integer(int32)
|
Certificate Expiry Date as Epoch Timestamp |
|
renewalstatus |
string
|
Current Renewal Status |
|
days |
integer(int32)
|
Days Until Certificate Expiry or Days Since Request Submitted |
|
objecttype |
string
|
Object Type (Certificate, or Request) |
|
objectstatus |
string
|
Current Status. Renewing, Expiring or Pending |
|
phase |
string
|
Certificate Life-cycle phase |
|
requestid |
string
|
CloudPKI Request ID |
|
requestsource |
string
|
Request Source (Cloud PKI or Issuing CA) |
|
submittedwhen |
string
|
When a Request Was Submitted |
|
submittedwhenepoch |
string
|
When a Request Was Submitted Epoch Time |
|
submitteremail |
string
|
Request Submitter Email |
|
displaysubject |
string
|
A Rationalised Subject Name for Easy Identification. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
thumbprint |
string
|
Certificate SHA1 Thumbprint |
|
serialnumber |
string
|
Serial Number |
|
validfrom |
string
|
Certificate Start Date |
|
validto |
string
|
Certificate Expiry Date |
|
validfromepoch |
integer(int32)
|
Certificate Start Date as Epoch timestamp |
|
validtoepoch |
integer(int32)
|
Certificate Expiry Date as Epoch Timestamp |
|
signaturealgorithm |
string
|
signaturealgorithm |
|
subjectkeyidentifier |
string
|
The Subject Key Identifier of the certificate. |
|
authoritykeyidentifier |
string
|
The Authority Key Identifier of the certificate. |
|
templateoid |
string
|
Template Object ID - Unique per AD Forest |
|
templatename |
string
|
Template Short Name |
|
keytype |
string
|
The Asymmetric KeyType. (RSA or ECC) |
|
keysize |
integer(int32)
|
The Asymmetric key length |
|
keyusage |
array of (string)
|
Basic Key Usages |
|
enhancedkeyusage |
array of (string)
|
The Enhanced Key Usages |
|
issuername |
string
|
The Issuers Common CA Name |
|
subject |
array of (string)
|
The subject of the certificate |
|
subjectalternativename |
array of (string)
|
Subject Alternate Names for the Certificate |
|
displaysubject |
string
|
A rationalised subject name for easier identification. |
|
cdp |
array of (string)
|
CRL Distribution Points |
|
aia |
array of (string)
|
Authority Information Access |
|
basicconstraints |
array of (string)
|
Basic Certificate Constraints |
|
status |
string
|
Certificate Status (Issued or Revoked) |
|
publickey |
string
|
Public Key of the Certificate |
|
cloudpki |
|
cloudpki |
|
requestdetails |
|
requestdetails |
Summary:
Description: cloudpki
Properties:
|
Name |
Type |
Summary |
|
templateid |
string
|
Cloud PKI Template ID |
|
requestid |
string
|
Cloud PKI Request ID if requested through Cloud PKI Management |
|
phase |
string
|
Current Certificate Life-cycle Phase |
|
important |
string
|
Certificate Marked As Important |
|
comment |
string
|
Comment |
|
reference |
string
|
Reference |
|
owneremail |
array of (string)
|
owneremail |
|
owneremailstring |
string
|
Owner Email Addresses String |
|
renewalstatus |
string
|
Current Renewal Status |
|
renewallastmodified |
string
|
Renewal Status Last Modified Timestamp |
|
renewallastmodifiedepoch |
integer(int32)
|
Renewal Status Last Modified Epoch Timestamp |
|
renewallastmodifiedid |
string
|
Renewal Status Last Modified ID |
|
renewallastmodifiedemail |
string
|
Renewal Status Last Modified Email |
|
lastmodified |
string
|
Last Modified Epoch Timestamp |
|
lastmodifiedepoch |
integer(int32)
|
lastmodifiedepoch |
|
lastmodifiedid |
string
|
Last Modified By ID |
|
lastmodifiedemail |
string
|
Last Modified By Email |
|
lastmodifiedevent |
string
|
Last Modified Event |
|
revocationstatus |
string
|
Revocation Status |
|
revocationlastmodified |
string
|
Last Revocation Timestamp |
|
revocationlastmodifiedepoch |
string
|
Last Revocation Epoch Timestamp |
|
revocationlastmodifiedid |
string
|
Last Revoker ID |
|
revocationlastmodifiedemail |
string
|
Last Revoker Email |
Summary:
Description: requestdetails
Properties:
|
Name |
Type |
Summary |
|
carequestid |
integer(int32)
|
Request ID from Issuing CA |
|
statusmessage |
string
|
Status Message from Certificate Request Submission to Issuing CA |
|
submittedwhen |
string
|
Submitted When |
|
resolvedwhen |
string
|
Resolved When from Issuing CA |
|
revokedwhen |
string
|
Revoked When |
|
revokedeffectivewhen |
string
|
Revocation Effective When |
|
revokedreason |
integer(int32)
|
Revocation Reason |
|
requestername |
string
|
Requester Name from Issuing CA |
|
callername |
string
|
Caller Name from Issuing CA |
|
requestosversion |
string
|
requestosversion |
|
requestcspprovider |
string
|
CSP Provider / KSP Provider Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
The Event being executed by the Connector Action |
|
assetid |
string
|
The Asset ID being updated by the Connector Action |
|
assettype |
string
|
The Asset Type being updated by the Connector Action |
|
createdwhen |
string
|
Connector Action Created Timestamp |
|
resolvedwhen |
string
|
Connector Action Resolved Timestamp |
|
submittedwhen |
string
|
Connector Action Submitted to CA Timestamp |
|
message |
string
|
The Message returned from the Connector Action |
|
connectoractionid |
string
|
Connector Action ID |
|
status |
string
|
The Status of the Connector Action |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
validfrom |
string
|
CRL Start Date |
|
validto |
string
|
CRL Expiry Date |
|
validfromepoch |
integer(int32)
|
CRL Start Date as Epoch timestamp |
|
validtoepoch |
integer(int32)
|
CRL Expiry Date as Epoch Timestamp |
|
issuer |
string
|
Issuing CA Common Name |
|
signaturealgorithm |
string
|
Signature Algorithm |
|
signaturehashalgorithm |
string
|
Signature Hash Algorithm |
|
caversion |
string
|
CA Version of the Associated CA Certificate |
|
aki |
string
|
Authority Key Identifier |
|
crlnumber |
string
|
CRL Number in Hex |
|
crlnumberdecimal |
integer(int32)
|
CRL Number Decimal |
|
nextpublish |
string(date-time)
|
Next Publish Date |
|
nextpublishepoch |
integer(int32)
|
Next Publish Epoch Timestamp |
|
crlid |
string
|
ID of the CRL |
|
crlentries |
array of (string)
|
crlentries |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
hookid |
string
|
Unique Identifier of Hook (SHA1 of Email Address or CallbackURL) |
|
events |
string
|
Events this hook is triggered by |
|
callbackurl |
string
|
The URL the hook will notify of subscribed events |
|
type |
string
|
Hook Type (Web, Email or PowerBI) |
|
objecturi |
string
|
Object URI of the Hook |
|
creatorid |
string
|
Username of Admin Who Created the Hook |
|
creatoremail |
string
|
Email Address of Admin Who Created the Hook |
|
status |
string
|
Hook Status (Enabled or Disabled) |
|
whenchanged |
string(date-time)
|
When Changed Timestamp |
|
whenchangedepoch |
integer(int32)
|
When Changed Epoch Timestamp |
|
useragent |
string
|
Useragent Header of Hook Creation Call |
|
workflowdetails |
|
workflowdetails |
Summary:
Description: workflowdetails
Properties:
|
Name |
Type |
Summary |
|
workflowname |
string
|
Workflow Name of the Logic Apps or Flow Workflow |
|
workflowoperationname |
string
|
Operation Name of the Logic Apps or Flow Workflow |
|
workflowid |
string
|
ID of the Logic Apps or Flow Workflow |
|
workflowversion |
string
|
Version of the Logic Apps or Flow Workflow |
|
workflowsubscriptionid |
string
|
Subscription ID of the Logic Apps or Flow Workflow |
|
workflowlocation |
string
|
Location of the Logic Apps or Flow Workflow |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
templateid |
string
|
Cloud PKI Template ID |
|
templatename |
string
|
Template Short Name |
|
templateoid |
string
|
Template Object ID |
|
templateforestrootfqdn |
string
|
Template Active Directory Forest DNS Name |
|
templatedisplayname |
string
|
Template Display Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
default |
string
|
Is this the default deployment |
|
regionid |
string
|
Region ID |
|
deploymentid |
string
|
Cloud PKI Management Deployment ID |
|
friendlyname |
string
|
Deployment Friendly Name |
|
displayname |
string
|
Friendly Name with Deployment ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
regionname |
string
|
regionname |
|
regionid |
string
|
regionid |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
requestsource |
string
|
Source of Request (Cloud PKI or Issuing CA Name) |
|
status |
string
|
Request Status (Pending, Approved, Denied, Failed, Issued) |
|
publickey |
string
|
Public Key of Request |
|
keytype |
string
|
Key Type (RSA or ECC) |
|
keylength |
integer(int32)
|
Key Length |
|
subject |
array of (string)
|
subject |
|
subjectalternativename |
array of (string)
|
subjectalternativename |
|
requesthash |
string
|
Hashing Algorithm Used to Sign the Request |
|
signaturealgorithm |
string
|
Signature Algorithm |
|
alternatesignaturealgorithm |
boolean
|
alternatesignaturealgorithm |
|
templateoid |
string
|
Template Object ID |
|
templateid |
string
|
Template ID |
|
templatename |
string
|
Template Name |
|
criticalextensions |
array of (string)
|
criticalextensions |
|
enhancedkeyusage |
array of (string)
|
enhancedkeyusage |
|
keyusage |
array of (string)
|
keyusage |
|
applicationpolicies |
array of (string)
|
applicationpolicies |
|
subjectkeyidentifier |
string
|
Subject Key Identifier |
|
displaysubject |
string
|
Display Subject |
|
requestid |
string
|
Cloud PKI Request ID (Always different to the CA Request ID) |
|
requestdetails |
|
requestdetails |
|
cloudpki |
|
cloudpki |
Summary:
Description: requestdetails
Properties:
|
Name |
Type |
Summary |
|
carequestid |
integer(int32)
|
Request ID from the Issuing CA |
|
statusmessage |
string
|
Status Message from CA when Request Submitted |
|
submittedwhen |
string
|
Timestamp When Submitted to the Issuing CA |
|
resolvedwhen |
string
|
resolvedwhen |
|
revokedwhen |
string
|
When the Issuing CA Revoked the Certificate |
|
revokedeffectivewhen |
string
|
When the Certificate Revocation should apply. Signatures post this date should be considered invalid. |
|
revokedreason |
string
|
Why the Certificate was Revoked |
|
requestername |
string
|
requestername |
|
callername |
string
|
callername |
|
requestosversion |
string
|
Operation System Version of the Request |
|
requestcspprovider |
string
|
requestcspprovider |
|
cdc |
string
|
cdc |
|
rmd |
string
|
rmd |
|
ccm |
string
|
ccm |
Summary:
Description: cloudpki
Properties:
|
Name |
Type |
Summary |
|
cloudpkirequestid |
string
|
cloudpkirequestid |
|
reference |
string
|
Reference |
|
comment |
string
|
Comment |
|
urgent |
string
|
Urgent Flag |
|
important |
string
|
Important Flag |
|
owneremail |
array of (string)
|
owneremail |
|
owneremailstring |
string
|
owneremail |
|
submittedcsr |
string
|
Certificate Signing Request Text |
|
submittedtemplateid |
string
|
Submitted Template ID |
|
submittedreference |
string
|
Refernce From Request Submitter |
|
submittedcomment |
string
|
Submitted Comment |
|
submittedurgent |
string
|
Submitted Urgent Flag |
|
submittedimportant |
string
|
Submitted Important Flag |
|
submittedowneremail |
array of (string)
|
submittedowneremail |
|
submittedwhen |
string
|
Timestamp of Request Submission |
|
submittedwhenepoch |
integer(int32)
|
Submitted When Epoch Timestamp |
|
submitterid |
string
|
Username of Request Submitter |
|
submitteremail |
string
|
Submitter Email Address |
|
approvedstatus |
string
|
approvedstatus |
|
approvedcomment |
string
|
Comment from Request Approver |
|
approvedreference |
string
|
approvedreference |
|
approvedimportant |
string
|
Important Status from Request Approver |
|
approvedwhen |
string
|
approvedwhen |
|
approvedwhenepoch |
integer(int32)
|
approvedwhenepoch |
|
approverid |
string
|
approverid |
|
approveremail |
string
|
approveremail |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
templateid |
string
|
Template ID |
|
name |
string
|
Template Short Name |
|
displayname |
string
|
Template Display Name |
|
distinguishedname |
string
|
Active Directory Forest Distinguished Name of Template |
|
objectguid |
string
|
AD Object GUID of Template |
|
forestrootdn |
string
|
Active Directory Forest Root Distinguished Name |
|
forestrootfqdn |
string
|
Active Directory Forest Root DNS Name |
|
whencreated |
string(date-time)
|
Creation Date of Template Active Directory Object |
|
whenchanged |
string(date-time)
|
Last Modified Date of Template Active Directory Object |
|
status |
string
|
Current Template Status (Published or Unpublished) |
|
publishedby |
array of (string)
|
publishedby |
|
templateoid |
string
|
Template OID |
|
templateversion |
integer(int32)
|
Template Version - 1,2,3,4 (2000, 2003 Ent, 2008, 2012) |
|
majorversion |
integer(int32)
|
Template Major Version |
|
minorversion |
integer(int32)
|
Template Minor Version |
|
templatetype |
string
|
Template Type (User or Computer) |
|
validityperiod |
integer(int32)
|
Certificate Validity Period in Days |
|
renewalperiod |
integer(int32)
|
renewalperiod |
|
defaultkeyspec |
integer(int32)
|
defaultkeyspec |
|
defaultkeyspecdecoded |
string
|
defaultkeyspecdecoded |
|
basickeyusage |
integer(int32)
|
Basic Key Usages |
|
basickeyusagedecoded |
|
basickeyusagedecoded |
|
enhancedkeyusage |
array of (string)
|
enhancedkeyusage |
|
criticalextensions |
array of (string)
|
criticalextensions |
|
minimumkeysize |
integer(int32)
|
Minimum Key Size |
|
defaultcsps |
array of (string)
|
defaultcsps |
|
maxdepth |
integer(int32)
|
maxdepth |
|
supersededtemplates |
array of (string)
|
supersededtemplates |
|
issuancepolicy |
array of (string)
|
issuancepolicy |
|
applicationpolicy |
array of (string)
|
applicationpolicy |
|
rasignaturecount |
integer(int32)
|
rasignaturecount |
|
rasignatureissuancepolicies |
array of (string)
|
rasignatureissuancepolicies |
|
templateflags |
integer(int32)
|
templateflags |
|
templateflagsdecoded |
|
templateflagsdecoded |
|
enrollmentflags |
integer(int32)
|
enrollmentflags |
|
enrollmentflagsdecoded |
|
enrollmentflagsdecoded |
|
certificatenameflags |
integer(int32)
|
certificatenameflags |
|
certificatenameflagsdecoded |
|
certificatenameflagsdecoded |
|
privatekeyflags |
integer(int32)
|
privatekeyflags |
|
privatekeyflagsdecoded |
|
privatekeyflagsdecoded |
|
rasignatureapplicationpolicy |
string
|
rasignatureapplicationpolicy |
|
keytype |
string
|
keytype |
|
cloudpki |
|
cloudpki |
Summary:
Description: basickeyusagedecoded
Properties:
|
Name |
Type |
Summary |
|
KEYENCIPHERMENT |
string
|
Basic Key Usage - Key Encipherment |
|
NONREPUDIATION |
string
|
Basic Key Usage - Non-Repudiation |
|
KEYAGREEMENT |
string
|
Basic Key Usage - Key Agreement |
|
DIGITALSIGNATURE |
string
|
Basic Key Usage - Digital Signature |
|
DATAENCIPHERMENT |
string
|
Basic Key Usage - Data Encipherment |
|
KEYCERTSIGN |
string
|
Basic Key Usage - Key Certificate Signing |
|
CRLSIGN |
string
|
Basic Key Usage - CRL Signing |
Summary:
Description: templateflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
PRIVATEKEYEXPORTABLE |
string
|
Is The Private Key Exportable |
|
ENABLEAUTOENROLLMENT |
string
|
ENABLEAUTOENROLLMENT |
|
ISCOMPUTERCERT |
string
|
ISCOMPUTERCERT |
|
ISCROSSCA |
string
|
ISCROSSCA |
|
ISCA |
string
|
ISCA |
|
PUBLISHTOREQUESTERUSEROBJECT |
string
|
PUBLISHTOREQUESTERUSEROBJECT |
|
ISEDITABLE |
string
|
ISEDITABLE |
|
DONOTPERSISTINDB |
string
|
DONOTPERSISTINDB |
|
ADDDETAILSTOCERT |
string
|
ADDDETAILSTOCERT |
|
ADDEMAIL |
string
|
ADDEMAIL |
|
ISDEFAULT |
string
|
ISDEFAULT |
Summary:
Description: enrollmentflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
ENABLEKEYREUSEONNTTOKENKEYSETSTORAGEFULL |
string
|
ENABLEKEYREUSEONNTTOKENKEYSETSTORAGEFULL |
|
EXCLUDECRLDETAILSINCERT |
string
|
EXCLUDECRLDETAILSINCERT |
|
PREVIOUSAPPROVALVALIDATEREENROLLMENT |
string
|
PREVIOUSAPPROVALVALIDATEREENROLLMENT |
|
AUTOENROLLMENTCHECKUSERDSCERTIFICATE |
string
|
AUTOENROLLMENTCHECKUSERDSCERTIFICATE |
|
INCLUDEBASICCONSTRAINTSFOREECERTS |
string
|
INCLUDEBASICCONSTRAINTSFOREECERTS |
|
REMOVEINVALIDCERTIFICATEFROMPERSONALSTORE |
string
|
REMOVEINVALIDCERTIFICATEFROMPERSONALSTORE |
|
EXCLUDEOCSPDETAILSINCERT |
string
|
EXCLUDEOCSPDETAILSINCERT |
|
ALLOWISSUANCEPOLICIESFROMREQUEST |
string
|
ALLOWISSUANCEPOLICIESFROMREQUEST |
|
AUTOENROLLMENT |
string
|
AUTOENROLLMENT |
|
PUBLISHTODS |
string
|
PUBLISHTODS |
|
ALLOWENROLLONBEHALFOF |
string
|
ALLOWENROLLONBEHALFOF |
|
ALLOWKEYBASEDRENEWAL |
string
|
ALLOWKEYBASEDRENEWAL |
|
PUBLISHTOKRACONTAINER |
string
|
PUBLISHTOKRACONTAINER |
|
USERINTERACTIONREQUIRED |
string
|
USERINTERACTIONREQUIRED |
|
CERTMGRAPPROVALREQUIRED |
string
|
CERTMGRAPPROVALREQUIRED |
|
INCLUDESYMETRICALGORITHMS |
string
|
INCLUDESYMETRICALGORITHMS |
Summary:
Description: certificatenameflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
SUBJECTREQUIREDNSASCN |
string
|
SUBJECTREQUIREDNSASCN |
|
SUBJECTALTREQUIREEMAIL |
string
|
SUBJECTALTREQUIREEMAIL |
|
SUBJECTREQUIREEMAIL |
string
|
SUBJECTREQUIREEMAIL |
|
SUBJECTALTREQUIREDNS |
string
|
SUBJECTALTREQUIREDNS |
|
SUBJECTALTREQUIREDOMAINDNS |
string
|
SUBJECTALTREQUIREDOMAINDNS |
|
ENROLEESUPLIESSUBJECTALTNAME |
string
|
ENROLEESUPLIESSUBJECTALTNAME |
|
OLDCERTSUPPLIESSUBJECTANDALTNAME |
string
|
OLDCERTSUPPLIESSUBJECTANDALTNAME |
|
SUBJECTALTREQUIREUPN |
string
|
SUBJECTALTREQUIREUPN |
|
SUBJECTALTREQUIREDIRECTORYGUID |
string
|
SUBJECTALTREQUIREDIRECTORYGUID |
|
SUBJECTREQUIRECOMMONNAME |
string
|
SUBJECTREQUIRECOMMONNAME |
|
SUBJECTALTREQUIRESPN |
string
|
SUBJECTALTREQUIRESPN |
|
ENROLEESUPLIESSUBJECT |
string
|
ENROLEESUPLIESSUBJECT |
|
SUBJECTREQUIREDIRECTORYPATH |
string
|
SUBJECTREQUIREDIRECTORYPATH |
Summary:
Description: privatekeyflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
REQUIREALTERNATESIGNATUREALGORITHM |
string
|
REQUIREALTERNATESIGNATUREALGORITHM |
|
EXPORTABLEKEY |
string
|
EXPORTABLEKEY |
|
REQUIRESAMEKEYRENEWAL |
string
|
REQUIRESAMEKEYRENEWAL |
|
EKVALIDATECERT |
string
|
EKVALIDATECERT |
|
EKVALIDATEKEY |
string
|
EKVALIDATEKEY |
|
STRONGKEYPROTECTIONREQUIRED |
string
|
STRONGKEYPROTECTIONREQUIRED |
|
ATTESTATIONWITHOUTPOLICY |
string
|
ATTESTATIONWITHOUTPOLICY |
|
EKTRUSTONUSE |
string
|
EKTRUSTONUSE |
|
ATTESTREQUIRED |
string
|
ATTESTREQUIRED |
|
USELEGACYPROVIDER |
string
|
USELEGACYPROVIDER |
|
ATTESTPREFERRED |
string
|
ATTESTPREFERRED |
|
REQUIREPRIVATEKEYARCHIVAL |
string
|
REQUIREPRIVATEKEYARCHIVAL |
|
ATTESTNONE |
string
|
ATTESTNONE |
Summary:
Description: cloudpki
Properties:
|
Name |
Type |
Summary |
|
important |
string
|
Imported Certificates from this template will be marked as important |
|
owneremail |
array of (string)
|
owneremail |
|
owneremailstring |
string
|
owneremailstring |
|
autoapproveid |
array of (string)
|
owneremail |
|
autoapproveidstring |
string
|
autoapproveidstring |
|
hidden |
string
|
Certificate Template hidden from certificate requesters. |
|
renewalstatus |
string
|
Imported certificates will have this renewal status |
|
lastmodified |
string
|
Last Modified Epoch Timestamp |
|
lastmodifiedepoch |
integer(int32)
|
lastmodifiedepoch |
|
lastmodifiedid |
string
|
Last Modified By ID |
|
lastmodifiedemail |
string
|
Last Modified By Email |
|
lastmodifiedevent |
string
|
Last Modified Event |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
default |
string
|
default |
|
regionid |
string
|
regionid |
|
deploymentid |
string
|
deploymentid |
|
friendlyname |
string
|
friendlyname |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email Address to be notified when Event is triggered. |
|
callbackurl |
string
|
The URL to be called when an Event is triggered |
|
type |
string
|
Select Hook Type - Web, Email or PowerBI Values: [Web, Email, PowerBI] |
|
events |
array of (string)
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
objecturi |
string
|
objecturi |
|
hookid |
string
|
hookid |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
csr |
string
|
Paste your CSR here. It must start with '-----BEGIN NEW CERTIFICATE REQUEST-----' |
|
templateid |
string
|
Template Name |
|
owneremail |
string
|
Owner Email |
|
reference |
string
|
RFC ID, CMDB Reference, Ticket Reference or other reference |
|
comment |
string
|
Extra non-critical info for the request approver |
|
urgent |
string
|
Urgent Request Values: [, true, false] |
|
important |
string
|
Important Certificate Values: [, true, false] |
|
renewal |
string
|
Is this request renewing an existing certificate? Values: [, true, false] |
|
previouscertificate |
string
|
Thumbprint Of Certificate being renewed with this request |
|
renewalstatus |
string
|
Pre-Approve Future Renewal of the issued Certificate? Values: [, true, false] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Submission Status |
|
requestid |
string
|
Request ID |
|
objecturi |
string
|
objecturi |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Certificate Status (Issued or Revoked) |
|
thumbprint |
string
|
Certificate SHA1 Thumbprint |
|
serialnumber |
string
|
Serial Number |
|
validfrom |
string
|
Certificate Start Date |
|
validto |
string
|
Certificate Expiry Date |
|
validfromepoch |
integer(int32)
|
Certificate Start Date as Epoch timestamp |
|
validtoepoch |
integer(int32)
|
Certificate Expiry Date as Epoch Timestamp |
|
issuername |
string
|
The Issuers Common CA Name |
|
subject |
array of (string)
|
The subject of the certificate |
|
subjectalternativename |
array of (string)
|
Subject Alternate Names for the Certificate |
|
displaysubject |
string
|
A rationalised subject name for easier identification. |
|
templatename |
string
|
Template Short Name |
|
cloudpki |
|
cloudpki |
Summary:
Description: cloudpki
Properties:
|
Name |
Type |
Summary |
|
templateid |
string
|
Cloud PKI Template ID |
|
owneremail |
array of (string)
|
owneremail |
|
renewalstatus |
string
|
Current Renewal Status |
|
phase |
string
|
Current Certificate Life-cycle Phase |
|
important |
string
|
Certificate Marked As Important |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
validfrom |
string
|
CRL Start Date |
|
validto |
string
|
CRL Expiry Date |
|
validfromepoch |
integer(int32)
|
CRL Start Date as Epoch timestamp |
|
validtoepoch |
integer(int32)
|
CRL Expiry Date as Epoch Timestamp |
|
issuer |
string
|
issuer |
|
signaturealgorithm |
string
|
signaturealgorithm |
|
signaturehashalgorithm |
string
|
signaturehashalgorithm |
|
caversion |
string
|
caversion |
|
aki |
string
|
aki |
|
crlnumber |
string
|
crlnumber |
|
crlnumberdecimal |
integer(int32)
|
crlnumberdecimal |
|
nextpublish |
string(date-time)
|
nextpublish |
|
nextpublishepoch |
integer(int32)
|
nextpublishepoch |
|
crlid |
string
|
crlid |
|
crlentries |
array of (string)
|
crlentries |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
hookid |
string
|
Unique Identifier of Hook (SHA1 of Email Address or CallbackURL) |
|
events |
string
|
Events this hook is triggered by |
|
callbackurl |
string
|
The URL the hook will notify of subscribed events |
|
type |
string
|
Hook Type (Web, Email or PowerBI) |
|
objecturi |
string
|
Object URI of the Hook |
|
creatorid |
string
|
Username of Admin Who Created the Hook |
|
creatoremail |
string
|
Email Address of Admin Who Created the Hook |
|
status |
string
|
Hook Status (Enabled or Disabled) |
|
whenchanged |
string(date-time)
|
When Changed Timestamp |
|
whenchangedepoch |
integer(int32)
|
When Changed Epoch Timestamp |
|
useragent |
string
|
Useragent Header of Hook Creation Call |
|
workflowdetails |
|
workflowdetails |
Summary:
Description: workflowdetails
Properties:
|
Name |
Type |
Summary |
|
workflowname |
string
|
Workflow Name of the Logic Apps or Flow Workflow |
|
workflowoperationname |
string
|
Operation Name of the Logic Apps or Flow Workflow |
|
workflowid |
string
|
ID of the Logic Apps or Flow Workflow |
|
workflowversion |
string
|
Version of the Logic Apps or Flow Workflow |
|
workflowsubscriptionid |
string
|
Subscription ID of the Logic Apps or Flow Workflow |
|
workflowlocation |
string
|
Location of the Logic Apps or Flow Workflow |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
requestid |
string
|
Cloud PKI Request ID |
|
status |
string
|
Request Status |
|
requestsource |
string
|
Request Source |
|
displaysubject |
string
|
Display Subject |
|
subject |
array of (string)
|
Subject |
|
templateid |
string
|
Template ID |
|
templatename |
string
|
Template Name |
|
requestdetails |
|
requestdetails |
|
cloudpki |
|
cloudpki |
|
subjectalternativename |
array of (string)
|
subjectalternativename |
Summary:
Description: requestdetails
Properties:
|
Name |
Type |
Summary |
|
carequestid |
integer(int32)
|
Request ID from the Issuing CA |
|
requestername |
string
|
CA Requester Name |
Summary:
Description: cloudpki
Properties:
|
Name |
Type |
Summary |
|
reference |
string
|
Reference |
|
comment |
string
|
Comment |
|
urgent |
string
|
Urgent Flag |
|
important |
string
|
Important Flag |
|
submitterid |
string
|
Submitter ID |
|
submitteremail |
string
|
Submitter Email |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
displayname |
string
|
displayname |
|
distinguishedname |
string
|
distinguishedname |
|
objectguid |
string
|
objectguid |
|
forestrootdn |
string
|
forestrootdn |
|
forestrootfqdn |
string
|
forestrootfqdn |
|
whencreated |
string
|
whencreated |
|
whenchanged |
string
|
whenchanged |
|
status |
string
|
status |
|
publishedby |
array of (string)
|
publishedby |
|
templateoid |
string
|
templateoid |
|
templateversion |
integer(int32)
|
templateversion |
|
majorversion |
integer(int32)
|
majorversion |
|
minorversion |
integer(int32)
|
minorversion |
|
templateid |
string
|
templateid |
|
templatetype |
string
|
templatetype |
|
validityperiod |
integer(int32)
|
validityperiod |
|
renewalperiod |
integer(int32)
|
renewalperiod |
|
defaultkeyspec |
integer(int32)
|
defaultkeyspec |
|
basickeyusage |
integer(int32)
|
basickeyusage |
|
basickeyusagedecoded |
|
basickeyusagedecoded |
|
enhancedkeyusage |
array of (string)
|
enhancedkeyusage |
|
criticalextensions |
array of (string)
|
criticalextensions |
|
minimumkeysize |
integer(int32)
|
minimumkeysize |
|
defaultcsps |
array of (string)
|
defaultcsps |
|
maxdepth |
integer(int32)
|
maxdepth |
|
supersededtemplates |
array of (string)
|
supersededtemplates |
|
issuancepolicy |
array of (string)
|
issuancepolicy |
|
applicationpolicy |
array of (string)
|
applicationpolicy |
|
rasignaturecount |
integer(int32)
|
rasignaturecount |
|
rasignatureissuancepolicies |
array of (string)
|
rasignatureissuancepolicies |
|
templateflags |
integer(int32)
|
templateflags |
|
templateflagsdecoded |
|
templateflagsdecoded |
|
enrollmentflags |
integer(int32)
|
enrollmentflags |
|
enrollmentflagsdecoded |
|
enrollmentflagsdecoded |
|
certificatenameflags |
integer(int32)
|
certificatenameflags |
|
certificatenameflagsdecoded |
|
certificatenameflagsdecoded |
|
privatekeyflags |
integer(int32)
|
privatekeyflags |
|
privatekeyflagsdecoded |
|
privatekeyflagsdecoded |
|
rasignatureapplicationpolicy |
string
|
rasignatureapplicationpolicy |
|
keytype |
string
|
keytype |
|
defaultkeyspecdecoded |
string
|
defaultkeyspecdecoded |
|
privatekeyasymmetricalgorithm |
string
|
privatekeyasymmetricalgorithm |
|
requesthashalgorithm |
string
|
requesthashalgorithm |
|
privatekeysecuritydescriptor |
string
|
privatekeysecuritydescriptor |
|
privatekeyusage |
string
|
privatekeyusage |
|
privatekeyusagedecoded |
|
privatekeyusagedecoded |
|
keyarchivalsymmetricalgorithm |
string
|
keyarchivalsymmetricalgorithm |
|
keyarchivalsymmetrickeylength |
string
|
keyarchivalsymmetrickeylength |
|
cloudpki |
|
cloudpki |
Summary:
Description: basickeyusagedecoded
Properties:
|
Name |
Type |
Summary |
|
KEYENCIPHERMENT |
string
|
KEYENCIPHERMENT |
|
NONREPUDIATION |
string
|
NONREPUDIATION |
|
KEYAGREEMENT |
string
|
KEYAGREEMENT |
|
DIGITALSIGNATURE |
string
|
DIGITALSIGNATURE |
|
DATAENCIPHERMENT |
string
|
DATAENCIPHERMENT |
|
KEYCERTSIGN |
string
|
KEYCERTSIGN |
|
CRLSIGN |
string
|
CRLSIGN |
Summary:
Description: templateflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
PRIVATEKEYEXPORTABLE |
string
|
PRIVATEKEYEXPORTABLE |
|
ENABLEAUTOENROLLMENT |
string
|
ENABLEAUTOENROLLMENT |
|
ISCOMPUTERCERT |
string
|
ISCOMPUTERCERT |
|
ISCROSSCA |
string
|
ISCROSSCA |
|
ISCA |
string
|
ISCA |
|
PUBLISHTOREQUESTERUSEROBJECT |
string
|
PUBLISHTOREQUESTERUSEROBJECT |
|
ISEDITABLE |
string
|
ISEDITABLE |
|
DONOTPERSISTINDB |
string
|
DONOTPERSISTINDB |
|
ADDDETAILSTOCERT |
string
|
ADDDETAILSTOCERT |
|
ADDEMAIL |
string
|
ADDEMAIL |
|
ISDEFAULT |
string
|
ISDEFAULT |
Summary:
Description: enrollmentflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
ENABLEKEYREUSEONNTTOKENKEYSETSTORAGEFULL |
string
|
ENABLEKEYREUSEONNTTOKENKEYSETSTORAGEFULL |
|
EXCLUDECRLDETAILSINCERT |
string
|
EXCLUDECRLDETAILSINCERT |
|
PREVIOUSAPPROVALVALIDATEREENROLLMENT |
string
|
PREVIOUSAPPROVALVALIDATEREENROLLMENT |
|
AUTOENROLLMENTCHECKUSERDSCERTIFICATE |
string
|
AUTOENROLLMENTCHECKUSERDSCERTIFICATE |
|
INCLUDEBASICCONSTRAINTSFOREECERTS |
string
|
INCLUDEBASICCONSTRAINTSFOREECERTS |
|
REMOVEINVALIDCERTIFICATEFROMPERSONALSTORE |
string
|
REMOVEINVALIDCERTIFICATEFROMPERSONALSTORE |
|
EXCLUDEOCSPDETAILSINCERT |
string
|
EXCLUDEOCSPDETAILSINCERT |
|
ALLOWISSUANCEPOLICIESFROMREQUEST |
string
|
ALLOWISSUANCEPOLICIESFROMREQUEST |
|
AUTOENROLLMENT |
string
|
AUTOENROLLMENT |
|
PUBLISHTODS |
string
|
PUBLISHTODS |
|
ALLOWENROLLONBEHALFOF |
string
|
ALLOWENROLLONBEHALFOF |
|
ALLOWKEYBASEDRENEWAL |
string
|
ALLOWKEYBASEDRENEWAL |
|
PUBLISHTOKRACONTAINER |
string
|
PUBLISHTOKRACONTAINER |
|
USERINTERACTIONREQUIRED |
string
|
USERINTERACTIONREQUIRED |
|
CERTMGRAPPROVALREQUIRED |
string
|
CERTMGRAPPROVALREQUIRED |
|
INCLUDESYMETRICALGORITHMS |
string
|
INCLUDESYMETRICALGORITHMS |
Summary:
Description: certificatenameflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
SUBJECTREQUIREDNSASCN |
string
|
SUBJECTREQUIREDNSASCN |
|
SUBJECTALTREQUIREEMAIL |
string
|
SUBJECTALTREQUIREEMAIL |
|
SUBJECTREQUIREEMAIL |
string
|
SUBJECTREQUIREEMAIL |
|
SUBJECTALTREQUIREDNS |
string
|
SUBJECTALTREQUIREDNS |
|
SUBJECTALTREQUIREDOMAINDNS |
string
|
SUBJECTALTREQUIREDOMAINDNS |
|
ENROLEESUPLIESSUBJECTALTNAME |
string
|
ENROLEESUPLIESSUBJECTALTNAME |
|
OLDCERTSUPPLIESSUBJECTANDALTNAME |
string
|
OLDCERTSUPPLIESSUBJECTANDALTNAME |
|
SUBJECTALTREQUIREUPN |
string
|
SUBJECTALTREQUIREUPN |
|
SUBJECTALTREQUIREDIRECTORYGUID |
string
|
SUBJECTALTREQUIREDIRECTORYGUID |
|
SUBJECTREQUIRECOMMONNAME |
string
|
SUBJECTREQUIRECOMMONNAME |
|
SUBJECTALTREQUIRESPN |
string
|
SUBJECTALTREQUIRESPN |
|
ENROLEESUPLIESSUBJECT |
string
|
ENROLEESUPLIESSUBJECT |
|
SUBJECTREQUIREDIRECTORYPATH |
string
|
SUBJECTREQUIREDIRECTORYPATH |
Summary:
Description: privatekeyflagsdecoded
Properties:
|
Name |
Type |
Summary |
|
REQUIREALTERNATESIGNATUREALGORITHM |
string
|
REQUIREALTERNATESIGNATUREALGORITHM |
|
EXPORTABLEKEY |
string
|
EXPORTABLEKEY |
|
REQUIRESAMEKEYRENEWAL |
string
|
REQUIRESAMEKEYRENEWAL |
|
EKVALIDATECERT |
string
|
EKVALIDATECERT |
|
EKVALIDATEKEY |
string
|
EKVALIDATEKEY |
|
STRONGKEYPROTECTIONREQUIRED |
string
|
STRONGKEYPROTECTIONREQUIRED |
|
ATTESTATIONWITHOUTPOLICY |
string
|
ATTESTATIONWITHOUTPOLICY |
|
EKTRUSTONUSE |
string
|
EKTRUSTONUSE |
|
ATTESTREQUIRED |
string
|
ATTESTREQUIRED |
|
USELEGACYPROVIDER |
string
|
USELEGACYPROVIDER |
|
ATTESTPREFERRED |
string
|
ATTESTPREFERRED |
|
REQUIREPRIVATEKEYARCHIVAL |
string
|
REQUIREPRIVATEKEYARCHIVAL |
|
ATTESTNONE |
string
|
ATTESTNONE |
Summary:
Description: privatekeyusagedecoded
Properties:
|
Name |
Type |
Summary |
|
KEYAGREEMENT |
string
|
KEYAGREEMENT |
|
SIGNING |
string
|
SIGNING |
|
DECRYPTION |
string
|
DECRYPTION |
|
ALLUSAGES |
string
|
ALLUSAGES |
Summary:
Description: cloudpki
Properties:
|
Name |
Type |
Summary |
|
important |
string
|
Imported Certificates from this template will be marked as important |
|
owneremail |
array of (string)
|
owneremail |
|
owneremailstring |
string
|
owneremail |
|
autoapproveid |
array of (string)
|
autoapproveid |
|
autoapproveidstring |
string
|
autoapproveidstring |
|
hidden |
string
|
Certificate Template hidden from certificate requesters. |
|
renewalstatus |
string
|
Imported certificates will have this renewal status |
|
lastmodified |
string
|
Last Modified Epoch Timestamp |
|
lastmodifiedepoch |
integer(int32)
|
lastmodifiedepoch |
|
lastmodifiedid |
string
|
Last Modified By ID |
|
lastmodifiedemail |
string
|
Last Modified By Email |
|
lastmodifiedevent |
string
|
Last Modified Event |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
important |
string
|
Choose if this certificate is Important Values: [, true, false] |
|
status |
string
|
Change the issued status of the certificate Values: [Revoked, Unrevoked] |
|
renewalstatus |
string
|
Should this certificate be renewed? Values: [approved, denied, none] |
|
comment |
string
|
A comment for the Certificate |
|
reference |
string
|
A reference for the certificate eg Server Name, CMDB URL |
|
owneremail |
string
|
Certificate Owner Email Addresses |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Status |
|
message |
string
|
Status Message |
|
connectoractionid |
string
|
Connector Action ID |
|
thumbprint |
string
|
Updated Certificate Thumbprint |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Set the Request Status Values: [Approved, Denied, UpdateOnly] |
|
comment |
string
|
Set a comment on the request |
|
reference |
string
|
Set an RFC ID, CMDB Reference, Ticket Reference or other reference to the request |
|
urgent |
string
|
Is this Certificate Request Urgent? Values: [True, False] |
|
important |
string
|
Mark the issued Certificate as Important Values: [true, false] |
|
renewalstatus |
string
|
Should this certificate be renewed? Values: [approved, denied, none] |
|
templateid |
string
|
The template name for the Issued Certificate |
|
owneremail |
string
|
Email Addresses of Certificate Owners to be Notified of Certificate Life-Cycle Events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Status |
|
message |
string
|
Status Message |
|
requestid |
string
|
Request ID |
|
connectoractionid |
string
|
Connector Action ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
important |
string
|
Choose if certificates issued from this template are Important. Values: [, true, false] |
|
renewalstatus |
string
|
Choose the renewalstatus for certificates issued from this template. Values: [approved, denied, none] |
|
hidden |
string
|
Choose if this template should be hidden from certificate requesters. Values: [, true, false] |
|
owneremail |
string
|
Certificate Owner Email Addresses |
|
autoapproveid |
string
|
Account IDs of certificate requesters who will have their requests approved automatically |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Status |
|
message |
string
|
Status Message |
|
templateid |
string
|
Updated Certificate Template ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackurl |
string
|
callbackurl |
|
type |
string
|
type |
|
events |
string
|
events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
hookid |
string
|
hookid |
|
message |
string
|
message |