Update all LDAP imported users in this domain

POST

/domains/{domainID}/ldap/downsync

curl --request POST \
  --url 'https://example.com/api/v1/domains/1/ldap/downsync?lang=&timeout=1' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

Header Parameters

X-Csrf-Token

string

CSRF Token

Query Parameters

import

boolean

Import new users from LDAP

lang

string

""

Default language for imported users

timeout

number

default: 1

Time in seconds to wait for completion

Responses

200

Update process successful

Media typeapplication/json

object

data

List of updated/imported users

Array<object>

object

ID

Unique ID of the object

integer

username

string

code

HTTP-like status code of the user update or import

integer

Allowed values: 200 201 400 404 409 500 503

message

Update/import message

string

Example

{
  "data": [
    {
      "code": 200
    }
  ]
}

202

Task took more than timeout seconds and is resumed in the background

Media typeapplication/json

object

message

string

taskID

ID of the task running the command

integer

Example^generated

{
  "message": "example",
  "taskID": 1
}

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"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "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"
}