The GET /Certificates/IdentityAudit/{id} operation returns a list of all the users or groups defined in the system that have permissions on the certificate ID entered. On success, the operation returns HTTP 200 OK with certificate identity audit details in the message body.
Permissions for certificates can be set at the system-wide or resource-specific level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions for more information.
In permission strings, # represents a specific resource identifier. In /certificates/collections/ permission strings it refers to a certificate collection ID (for example, CollectionId) and in /certificate_stores/ permission strings it refers to a certificate store application ID (for example, containerId).
This operation has two available versions. Keyfactor recommends using the newer operation when possible. For more information, see Endpoint Definition Versioning.
Version 2 of GET /Certificates/IdentityAudit/{id} redesigns the response to support security claims and environments with either an OAuth identity provider or Active Directory as an identity provider.
Table 296: 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 optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store applications. Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:
Use either ContainerId or CollectionId, not both. See Certificate Collection Permissions for more information. |
Table 297: 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 GET /Certificates/IdentityAudit/{id} 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 298: 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 optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store applications. Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:
Use either ContainerId or CollectionId, not both. See Certificate Collection Permissions for more information. |
Table 299: 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. |
An API is 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflow A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (
) in the Management Portal.Was this page helpful? Provide Feedback