Perform LDAP user search

GET

/domains/ldap/search

curl --request GET \
  --url 'https://example.com/api/v1/domains/ldap/search?limit=50&query=example&showAll=false' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Query Parameters

limit

integer

default: 50

Maximum number of results to return

domain

integer

ID of the domain

organization

integer

ID of the organization

query

required

string

>= 3 characters

Search term

showAll

boolean

Do not filter un-importable results

Responses

200

List of users returned

Media typeapplication/json

object

data

Array<object>

object

ID

LDAP object ID of the person

string

name

Display name of the person

string

email

E-mail address of the person

string

nullable

type

Type of the entry (either ‘user’ or ‘contact’)

string

error

Why the entry cannot be imported (showAll=true only)

string

nullable

Example^generated

{
  "data": [
    {
      "ID": "example",
      "name": "example",
      "email": "example",
      "type": "example",
      "error": "example"
    }
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

One of the required external services is unavailable

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}