Skip to content

ldapPrincipalConnection

Search LDAP Principals.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String An opaque cursor returned from a previous query's endCursor field. Pass this value verbatim to retrieve the next page of results.
last Int Returns the last n elements from the list.
before String An opaque cursor returned from a previous query's startCursor field. Pass this value verbatim to retrieve the previous page of results.
id (required) UUID! ID for your LDAP integration.
searchText (required) String! Search Text for LDAP principal.
sortOrder SortOrder Sorts the order of results.
sortBy LdapPrincipalFieldEnum Field to sort LDAP principals by.

Returns

PrincipalConnection!

Sample

query LdapPrincipalConnection($id: UUID!, $searchText: String!) {
  ldapPrincipalConnection(
    id: $id
    searchText: $searchText
    first: 10
  ) {
    nodes {
      authDomainId
      authDomainName
      description
      email
      id
      name
      principalType
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
{
  "id": "00000000-0000-0000-0000-000000000000",
  "searchText": "example-string"
}
{
  "data": {
    "ldapPrincipalConnection": {
      "nodes": [
        [
          {
            "authDomainId": "example-string",
            "authDomainName": "example-string",
            "description": "example-string",
            "email": "example-string",
            "id": "example-string",
            "name": "example-string"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}