COconductorone
User

Search

Changed on

Search users based on filters specified in the request body.

post/api/v1/search/users

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/search/users
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

delegateStatus'DELEGATE_STATUS_UNSPECIFIED' | 'DELEGATE_STATUS_HAS_DELEGATE' | 'DELEGATE_STATUS_NO_DELEGATE'

Filter for users based on their delegate status.

delegatedUserIdsstring[] nullable

Filter for users that have any of the delegated user IDs on this list.

departmentsstring[] nullable

Search for users that have any of the departments on this list.

emailstring

Search for users based on their email (exact match).

excludeIdsstring[] nullable

An array of users IDs to exclude from the results.

excludeOriginsstring[] nullable

Filter to exclude users with these origins.

excludeTypesstring[] nullable

An array of types to exclude from the results.

idsstring[] nullable

Deprecated. Use refs array instead.

isDelegateboolean

Filter for users who are delegates of at least one other user.

jobTitlesstring[] nullable

Search for users that have any of the job titles on this list.

managerIdsstring[] nullable

Search for users that have any of the manager IDs on this list.

originsstring[] nullable

Filter to include only users with these origins.

pageSizeinteger

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

pageTokenstring

The pageToken field.

querystring

Query the apps with a fuzzy search on display name and emails.

roleIdsstring[] nullable

Search for users that have any of the role IDs on this list.

sourceAppIdsstring[] nullable

Filter to include only users sourced from any of these apps (directories). Each value is an app ID; a user matches when its source_app_ids map contains any of the listed app IDs. Combined with origins using OR.

userStatusesstring[] nullable

Search for users that have any of the statuses on this list. This can only be ENABLED, DISABLED, and DELETED

Response

Successful response

nextPageTokenstring

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Changes

  • f2cf3228f366Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property type changed from object to no type

    • breaking

      added subschema #2 to the // response property oneOf list for the response status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the request property /

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the new optional request property

    • info

      added subschema #2 to the request property oneOf list

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7fa698b04b81Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property /// to the response with the status