The GET /Certificates/IdentityAudit/{id} method is used to return a list of all the users or groups defined in the system that have permission to the certificate ID entered. This method returns HTTP 200 OK on a success with certificate identity audit details in the message body.
Permissions for certificates can be set at either the global or certificate collection
The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). level. See Certificate Collection Permissions for more information about global vs collection permissions. See also the CollectionId input parameter A parameter or argument is a value that is passed into a function in an application., below.
This method has two available versions. Keyfactor recommends using the newer method when possible. For more information about versioning, see Versioning.
Version 2 of the GET /Certificates/IdentityAudit/{id} method redesigns the response to support security claims and environments with either an OAuth identity provider or Active Directory as an identity provider.
Table 234: GET Certificates Identity Audit {id} v2 Input Parameters
| Name | In | Description |
|---|---|---|
| id | Path | Required. An integer containing the Keyfactor Command reference ID of the certificate. |
| CollectionId | Query |
An integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Collection Permissions for more information. |
Table 235: GET Certificates Identity Audit {id} v2 Response Data
| Name | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Identity |
An object containing information about the identity.
|
||||||||||||||||||
| Permissions |
An array of objects containing the permissions granted to the certificate.
|
Version 1 of the GET /Certificates/IdentityAudit/{id} method includes the same functionality as version 2 with similar data in the response but supports only environments using Active Directory as an identity provider.
Table 236: GET Certificates Identity Audit {id} Iv1 nput Parameters
| Name | In | Description |
|---|---|---|
| id | Path | Required. An integer containing the Keyfactor Command reference ID of the certificate. |
| CollectionId | Query |
An integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Collection Permissions for more information. |
Table 237: GET Certificates Identity Audit {id} v1 Response Data
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
| Id | An integer containing the Keyfactor Command reference ID of the identity. | ||||||
| AccountName | A string containing the name of the identity. | ||||||
| IdentityType | A string that specifies the type of identity the entity is. For Active Directory, this will be a user or a group. | ||||||
| SID | A string containing the SID of the identity. | ||||||
| Permissions |
An array of objects containing the permissions granted to the certificate.
|
A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (
) at the top of the Management Portal page next to the Log Out button.