GET Security Identities ID

The GET /Security/Identities/{id} operation returns the security identities configured in Keyfactor Command with the specified ID. On success, the operation returns HTTP 200 OK with  the details of the security identity's permissions.

Note:  This operation is for managing legacy formatted Active Directory identities only and is retained for backwards compatibility. New applications should use the Security Claims set of operations for both Active Directory and other identity providers (see Security).
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/security/read/

Table 741: GET Security Identities {id} Input Parameters

Name In Description
id Path

Required. An integer indicating the Keyfactor Command reference ID of the security identity to retrieve.

Use the GET Security Identities operation to retrieve a list of all the security identities to determine the identity's ID.

Table 742: GET Security Identities {id} Response Data

Name Description
Identity A string containing the account name for the security identity. For Active Directory users and groups, this will be in the form DOMAIN\\user or group name. For example:
KEYEXAMPLE\\PKI Administrators
SecuredAreaPermissions

An array of objects containing information about the global permissions granted to the security identity. ClosedShow global permission details.

For example:

Copy 
"SecuredAreaPermissions": [
   {
      "Permission": "AdminPortal:Read",
      "GrantedByRoles": [
         "Read Only",
         "Staff"
      ]
   },
   {
      "Permission": "Reports:Read",
      "GrantedByRoles": [
         "Read Only"
      ]
   },
]

For more information about global permissions, see Security Roles and Claims.
CollectionPermissions

An array of objects containing information about the certificate collection permissions granted to the security identity. ClosedShow collection permission details.

For example:

Copy 
"CollectionPermissions": [
   {
      "Permission": "Issued in the Last Week:Certificates_Read",
      "GrantedByRoles": [
         "Staff",
         "Power Users"
      ]
   },
   {
      "Permission": "Web Server Certs:Certificates_EditMetadata",
         "GrantedByRoles": [
         "Power Users"
      ]
   },
]

For more information about collection permissions, see Certificate Collection Permissions.
ContainerPermissions

An array of objects containing information about the certificate store container permissions granted to the security identity. ClosedShow container permission details.

For example:

Copy 
"ContainerPermissions": [
   {
      "Permission": "IIS Personal:CertificateStoreManagement_Read",
      "GrantedByRoles": [
         "Power Users",
         "Staff"
      ]
   },
   {
      "Permission": "F5 SSL Profiles REST:CertificateStoreManagement_Schedule",
      "GrantedByRoles": [
         "Power Users"
      ]
   },
]

For more information about container permissions, see Application Permissions.
Tip:  See 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.