Skip to main content

List Active Directory domain configurations

GET 

/config/ldaps

Required role: any authenticated user (user, admin, superadmin).

Unknown filter fields, and keys that start with $, are rejected with 400 InvalidQuery. Paging edge cases: limit above 1000 is clamped to 1000; limit=0 or a non-numeric limit returns an empty page (not 400); page below 1 is treated as 1; a page past the end returns an empty array; an unknown sort field is ignored. inlinePageInfo wraps the body whatever its value (even false). Duplicate name values are allowed, so a name filter can return several records.

Request​

Responses​

A page of domain configurations.

Response Headers
    X-Pagination-Count

    Number of records in this page.

    X-Pagination-Max-Count

    Page size used for the request (limit).

    X-Pagination-Page

    Current page number.

    X-Pagination-Pages

    Total number of pages.

    X-Pagination-Total

    Total number of records matching the query.

    Link

    RFC 8288 links with rel values first, last, and, when they exist, prev and next.