GET api/securitydomains/{DomainID}/users

Searches for all the users within the LDAP domain. If the name query parameter is present, it searches for a partial match for the user.

Authorization Roles/Permissions: Must be logged in. The Business Admin, Site Admin, and users having domain read access can search for users.

A user attempting to log in to the platform needs to verify the login credentials. For more information about logging in, refer to the POST /api/login operation.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/securitydomains/{DomainID}/users

Sample Request

The following example shows a request to search for a specific user.

Sample Request URL

https://{hostname}/api/securitydomains/LDAP.acmepaymentscorp/users?name=mrusso

Sample request headers

Accept-Encoding: gzip,deflate
Host: {hostname}
Accept: application/json
Content-Type: application/json
Connection: Keep-Alive
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json
Content-Type	application/json
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
name	Query	String	Required	Contains information about the user name.

Response

If successful, this operation returns HTTP status code 200 with the user name for a specific domain.

Sample Response

The sample response below shows that the operation completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Wed, 10 Jul 2023 19:00:26 GMT

Sample response body

[
  {
    "FullName": "Mike Russo",
    "UserName": "mrusso",
    "Email": "mikerusso@acmepaymentscorp.com"
    "DomainName": "LDAP.acmepaymentscorp"
  }
]

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json

Response Body

Name	Description
FullName	The full name of a user.
UserName	The platform user name.
Email	The email id of a user.
DomainName	The domain name to be searched for.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found.

More information about Akana API Platform API error messages.

Related Topics