GET Security Identities ID

The GET /Security/Identities/{id} method is used to return the security identities configured in Keyfactor Command with the specified ID. This method returns HTTP 200 OK on a success with the details of the security identity's permissions.

Note:  This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. is for managing legacy formatted Active Directory identities only and is retained for backwards compatibility. New applications should use the Security Claims set of endpoints 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 566: 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 method (see GET Security Identities) to retrieve a list of all the security identities to determine the identity's ID.

Table 567: 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 Container Permissions.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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 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.