GET Security Identities

The GET /Security/Identities method is used to return the list of security identities configured in Keyfactor Command. This method returns HTTP 200 OK on a success with the details of the security identities.

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/modify/

Table 604: GET Security Identities Input Parameters

Name In Description
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is Id.

IdentityType may be used as a sort order.
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.
Validate Query

A Boolean that specifies whether the optional parameter of validate is false, which allows the AuditXML validation to be skipped when loading records, or true (or not specified) in which case validation will occur. The default is true.

Table 605: GET Security Identities Response Data

Name Description
Id An integer containing the Keyfactor Command reference ID for the security identity.
AccountName 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
IdentityType A string indicating the type of identity—User or Group.
Roles

An array of objects containing information about the security roles assigned to the security identity. ClosedShow role details.

Name In Description
Id Body

Required. An integer containing the Keyfactor Command identifier for the security role.

Use the GET /Security/Roles method (see GET Security Roles) to retrieve a list of all the security roles to determine the role's ID.

Name Body Required. A string containing the short reference name for the security role.
Description Body Required. A string containing the description for the security role.
EmailAddress Body A string containing an email address for the role. This address can be used from workflows to direct email messages to the owner of certificates for uses such as certificate expiration alerts (assuming the certificate owner for the certificates, a security role, has been populated).
Enabled Body

A Boolean that indicates whether the security role is enabled (true) or not (false). Security roles that have been disabled cannot be assigned to security identities. The default is true.

This is considered deprecated and may be removed in a future release.
Immutable Body A Boolean that indicates whether the security role has been marked as editable (false) or not (true). Internal Keyfactor Command roles are not editable. This setting is reserved for Keyfactor Command internal use.
Valid Body A Boolean that indicates whether the security role's audit XML is valid (true) or not (false). A security role may become invalid if Keyfactor Command determines that it appears to have been tampered with. This setting is not end-user configurable.
Private Body

A Boolean that indicates whether the security role has been marked private (true) or not (false). The default is false.

This is considered deprecated and may be removed in a future release.
Permission SetId Body A string indicating the Keyfactor Command reference GUID of the permission set associated with the role (see Permission Sets).
Identities Body

An array of objects containing information about the security identities assigned to the security role. ClosedShow identity details.
Permissions Body

An array of strings containing the permissions assigned to the role in a comma-separated list of Name:Value pairs. See Version One Permission Model for an overview of the possible permissions.

For example:

Copy 
"Permissions": [
   "AdminPortal:Read",
   "Dashboard:Read"
],
Valid A Boolean indicating whether the security identity's audit XML is valid (true) or not (false). A security identity may become invalid if Keyfactor Command determines that it appears to have been tampered with.
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.