Query User

Query User

Query given user or a set of users in ldap.

Request
URI
POST
https://{api_host}/https://{{host}}:{{port}}/api/v5/rbac/{instanceName}/query
COPY
Path Parameters
string
instanceName
Required

Instance name.

Query Parameters
string
userName
Required

LDAP username to run query on.

string
domainComponent
Optional

LDAP domain component to search user against.

boolean
filter
Optional

Enable filter to query users.

Responses
200

LDAP users.

[
    {
        "id": "string",
        "uid": "string",
        "authInstanceName": "string",
        "fullName": "string",
        "email": "string",
        "userMetaData": {
            "userMetaData": [
                "string"
            ]
        },
        "role": {
            "id": "string",
            "name": "string",
            "permissions": [
                {
                    "name": "string"
                }
            ]
        },
        "memberOf": [
            "string"
        ]
    }
]

401

Unauthorized access

[
    {
        "id": "string",
        "uid": "string",
        "authInstanceName": "string",
        "fullName": "string",
        "email": "string",
        "userMetaData": {
            "userMetaData": [
                "string"
            ]
        },
        "role": {
            "id": "string",
            "name": "string",
            "permissions": [
                {
                    "name": "string"
                }
            ]
        },
        "memberOf": [
            "string"
        ]
    }
]

404

Such resource was not found.

[
    {
        "id": "string",
        "uid": "string",
        "authInstanceName": "string",
        "fullName": "string",
        "email": "string",
        "userMetaData": {
            "userMetaData": [
                "string"
            ]
        },
        "role": {
            "id": "string",
            "name": "string",
            "permissions": [
                {
                    "name": "string"
                }
            ]
        },
        "memberOf": [
            "string"
        ]
    }
]

504

Connection timed out.

[
    {
        "id": "string",
        "uid": "string",
        "authInstanceName": "string",
        "fullName": "string",
        "email": "string",
        "userMetaData": {
            "userMetaData": [
                "string"
            ]
        },
        "role": {
            "id": "string",
            "name": "string",
            "permissions": [
                {
                    "name": "string"
                }
            ]
        },
        "memberOf": [
            "string"
        ]
    }
]

On This Page
Rbac Operations
POST
Add Ad Settings
POST
Add Ldap Settings
POST
Add New Group
POST
Add New User
POST
Create Role
DELETE
Delete Group For Instance
DELETE
Delete Ldap Settings
DELETE
Delete Role
DELETE
Delete User
GET
Get All Groups
GET
Get All Ldap Settings
GET
Get All Users
GET
Get All Users Per Instance
GET
Get Group
GET
Get Ldap Setting
GET
Get Ldap Settings
GET
Get Role
GET
Get Roles
GET
Get User
PUT
Modify Group Role
PUT
Modify User Role
POST
Query User
POST
Test Connection
PUT
Update Ldap Settings
PUT
Update Role