GET Security Audit Collections ID

The GET /Security/Audit/Collections/{id} method is used to return the list of security roles and permissions defined for the specified certificate collectionClosed 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).. This method returns HTTP 200 OK on a success with details of the security roles and permissions for the collection.

Note:  Roles granted permissions to collections via the global certificate collections permissions (system-wide collection permissions) rather than on a collection-by-collection basis are included in the AreaPermissions response. The AreaPermissions includes both permissions granted to the role globally and permissions granted on a collection-by-collection basis just to the requested collection. The endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. does differentiate between the sources for the permission in the output.

See also GET Security Roles ID Permissions Collections to list permissions on certificate collections for a specified security role.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/security/read/

Table 669: GET Security Audit Collections {id} Input Parameters

Name In Description
id Path

An integer indicating the Keyfactor Command reference ID of the certificate collection for which to retrieve permission information.

Use the GET /CertificateCollections method (see GET Certificate Collections) to determine the ID of the certificate collection you wish to evaluate.

Table 670: GET Security Audit Collections {id} Response Data

Name Description
QueryId An integer indicating the Keyfactor Command reference ID of the certificate collection.
AccessControlList

An array of objects containing the permissions granted to the role in a comma-separated list of arrays. See Certificate Collection Permissions for an overview of the possible permissions.ClosedShow access control list details.

For example:

Copy 
"AccessControlList": [
  {
    "RoleId": 1,
    "AreaPermissions": [
      4,
      5,
      7,
      8,
      41,
      71
    ]
  },
  {
    "RoleId": 2,
      "AreaPermissions": []
  },
  {
    "RoleId": 3,
    "AreaPermissions": [
      4,
      5
    ]
  },
  {
    "RoleId": 4,
    "AreaPermissions": [
      4,
      7
    ]
  },
  {
    "RoleId": 5,
    "AreaPermissions": [
      8
    ]
  },
  {
    "RoleId": 6,
    "AreaPermissions": [
      41,
      71,
      5,
      4,
      7,
      8
    ]
  },
  {
    "RoleId": 7,
    "AreaPermissions": [
      4,
      8
    ]
  }
]
AssignableRoles

An array of objects containing the security roles defined in Keyfactor Command. ClosedShow role details.

For example:

Copy 
"AssignableRoles": [
  {
    "RoleId": 1,
    "Name": "Administrator"
  },
  {
    "RoleId": 2,
    "Name": "Reporting API Access"
  },
  {
    "RoleId": 3,
    "Name": "Power Users"
  },
  {
    "RoleId": 4,
    "Name": "Read Only"
  },
  {
    "RoleId": 5,
    "Name": "Revokers"
  },
  {
    "RoleId": 6,
    "Name": "My Admins"
  },
  {
    "RoleId": 7,
    "Name": "Orchestrator Renewal"
  }
]
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed 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. 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.