GET Security Identities Lookup

The GET /Security/Identities/Lookup method is used to confirm that the security identity specified is valid for the environment—the Active Directory forestClosed An Active Directory forest (AD forest) is the top most logical container in an Active Directory configuration that contains domains, and objects such as users and computers. in which Keyfactor Command is installed and any forests in a two-way trust (or one-way trust in a direction that allows the lookup to occur). It can be used to query an identity in the source identity store (Active Directory) to confirm its validity before using POST /Security/Identities (see POST Security Identities) to create a new identity in Keyfactor Command with that user or group. This method returns HTTP 200 OK on a success with a response of true or false.

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

/security/read/

Table 568: GET Security Identities Lookup Input Parameters

Name In Description
Name Query Required. The identity name in the source identity store. For Active Directory users and groups, this can be given either as DOMAIN\name or name@domain.com. For users in the local domain (the domain in which the Keyfactor Command server is installed), the lookup may be done without a domain name.

Table 569: GET Security Identities Lookup Response Data

Name Description
Valid A Boolean that indicates whether the provided name is valid (true) or not (false).
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.