GET Security Identities Lookup

The GET /Security/Identities/Lookup operation confirms 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 the POST Security Identities operation to create a new identity in Keyfactor Command with that user or group. On success, the operation returns HTTP 200 OK 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 743: 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 744: GET Security Identities Lookup Response Data

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