Create Users

Search

client.search.createUsers(SearchCreateUsersParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateUsersResponse

post/api/v1/search/users

Search users based on filters specified in the request body.

Parameters

bodyemailstringexcludeIdsunionexcludeTypesunionexpandMaskExpandMaskidsunionpageSizenumberpageTokenstringquerystringrefsunionroleIdsunionuserStatusesunionSearchCreateUsersParams

Hide ParametersShow Parameters

emailstring

optional

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

excludeIdsunion

optional

Array<string> | null

An array of users IDs to exclude from the results.

excludeTypesunion

optional

Array<"USER_TYPE_UNSPECIFIED" | "USER_TYPE_SYSTEM" | "USER_TYPE_HUMAN" | 2 more> | null

An array of types to exclude from the results.

Hide ParametersShow Parameters

"USER_TYPE_UNSPECIFIED"

"USER_TYPE_SYSTEM"

"USER_TYPE_HUMAN"

"USER_TYPE_SERVICE"

"USER_TYPE_AGENT"

expandMaskExpandMask

optional

The user expand mask is used to indicate which related objects should be expanded in the response. The supported paths are 'role_ids', 'manager_ids', 'delegated_user_id', 'directory_ids', and '*'.

Hide ParametersShow Parameters

pathsunion

optional

Array<string> | null

An array of paths to be expanded in the response.

idsunion

optional

Array<string> | null

Deprecated. Use refs array instead.

pageSizenumber

optional

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

formatint32

pageTokenstring

optional

The pageToken field.

querystring

optional

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

refsunion

optional

Array<idstringUserRef> | null

An array of user refs to restrict the return values to by ID.

Hide ParametersShow Parameters

idstring

optional

The id of the user.

roleIdsunion

optional

Array<string> | null

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

userStatusesunion

optional

Array<"UNKNOWN" | "ENABLED" | "DISABLED" | "DELETED"> | null

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

Hide ParametersShow Parameters

"UNKNOWN"

"ENABLED"

"DISABLED"

"DELETED"

Returns

SearchCreateUsersResponse

The SearchUsersResponse message.

Hide ParametersShow Parameters

expandedunion

optional

Array<Expanded> | null

List of related objects

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

listunion

optional

Array<delegatedUserPathstringdirectoriesPathstringmanagersPathstringrolesPathstringuserC1APIUserV1UserUserView> | null

The list of results containing up to X results, where X is the page size defined in the request

Hide ParametersShow Parameters

delegatedUserPathstring

optional

JSONPATH expression indicating the location of the user objects of delegates of the current user in the expanded array.

directoriesPathstring

optional

JSONPATH expression indicating the location of directory objects in the expanded array.

managersPathstring

optional

JSONPATH expression indicating the location of the user objects that managed the current user in the expanded array.

rolesPathstring

optional

JSONPATH expression indicating the location of the roles of the current user in the expanded array.

useridstringcreatedAtstringdelegatedUserIdstringdeletedAtstringdepartmentstringdepartmentSourcesuniondirectoryIdsuniondirectoryStatusuniondirectoryStatusSourcesuniondisplayNamestringemailstringemailsunionemailSourcesunionemployeeIdsunionemployeeIdSourcesunionemploymentStatusstringemploymentStatusSourcesunionemploymentTypestringemploymentTypeSourcesunionjobTitlestringjobTitleSourcesunionmanagerIdsunionmanagerSourcesunionprofileRecord<string, unknown>roleIdsunionstatusuniontypeunionupdatedAtstringusernamestringusernamesunionusernameSourcesunionC1APIUserV1User

optional

The User object provides all of the details for an user, as well as some configuration.

nextPageTokenstring

optional

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.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const response = await client.search.createUsers();

console.log(response.expanded);

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "user": {
        "delegatedUserId": "delegatedUserId",
        "roleIds": [
          "string"
        ],
        "status": "UNKNOWN"
      }
    }
  ],
  "nextPageToken": "nextPageToken"
}