Search Ldap Identity Source

Search for LDAP users and groups to grant roles to

Searches one or all configured LDAP identity sources for users and groups matching search_param, typically as a precursor to POST /iam/role-bindings - use the distinguished_name or principal_name from a result as the entity_name when granting a role. The match is case-insensitive in most LDAP server configurations.

Request

URI

GET

https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/ldap-identity-sources/search

COPY

Query Parameters

string

identity_source_id

Optional

Restrict the search to this LDAP identity source. If omitted, all configured sources are searched.

string

search_param

Required

Text to search for, matched as a prefix (an implicit wildcard * is appended). Must be at least 3 characters; shorter values are rejected to avoid overly broad LDAP queries.

integer

offset

Optional

Constraints: minimum: 0 default: 0

Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the offset and the page_size options to request a particular set or page of items.

integer

page_size

Optional

Constraints: minimum: 0 default: 1000

Number of records to be returned in the API request from the provided offset

boolean,null

sort_ascending

Optional

Constraints: default: false

True, if the list of records returned need to be sorted in ascending order, false otherwise.

string

sort_by

Optional

The parameter name on which to sort the list of records. Only top-level parameters in the returned list of records will be supported. If not provided, system will define the parameter by which results are sorted.

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

200

The search completed successfully; results may be empty if nothing matched.

Returns LdapIdentitySearchResults of type(s) application/json

This response body class contains all of the following: ListResult , InlineLdapIdentitySearchResults1

{
    "offset": 0,
    "number_of_results": 1,
    "total_result_count": 1,
    "total_pages": 1,
    "sort_ascending": true,
    "sort_by": "common_name",
    "results": [
        {
            "common_name": "sspuser1",
            "distinguished_name": "cn=sspuser1,ou=Users,dc=corp,dc=example,dc=com",
            "principal_name": "[email protected]",
            "user_type": "REMOTE_USER"
        }
    ]
}

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

4XX and 5XX type errors with appropriate message

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/ldap-identity-sources/search?search_param=v

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

User Management Operations

POST

Logout

POST