Create Users

Search

client.Search.NewUsers(ctx, body) (*ExpandedarrayListarrayNextPageTokenstringSearchNewUsersResponse, error)

post/api/v1/search/users

Search users based on filters specified in the request body.

Parameters

bodyEmailfieldExcludeIDsfieldExcludeTypesfieldExpandMaskfieldIDsfieldPageSizefieldPageTokenfieldQueryfieldRefsfieldRoleIDsfieldUserStatusesfieldSearchNewUsersParams

Hide ParametersShow Parameters

Emailfield

optional

param.Field[string]

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

ExcludeIDsfield

optional

param.Field[[]string]

An array of users IDs to exclude from the results.

ExcludeTypesfield

optional

param.Field[[]string]

An array of types to exclude from the results.

Hide ParametersShow Parameters

SearchNewUsersParamsExcludeTypeUserTypeUnspecifiedconst

SearchNewUsersParamsExcludeType

"USER_TYPE_UNSPECIFIED"

SearchNewUsersParamsExcludeTypeUserTypeSystemconst

SearchNewUsersParamsExcludeType

"USER_TYPE_SYSTEM"

SearchNewUsersParamsExcludeTypeUserTypeHumanconst

SearchNewUsersParamsExcludeType

"USER_TYPE_HUMAN"

SearchNewUsersParamsExcludeTypeUserTypeServiceconst

SearchNewUsersParamsExcludeType

"USER_TYPE_SERVICE"

SearchNewUsersParamsExcludeTypeUserTypeAgentconst

SearchNewUsersParamsExcludeType

"USER_TYPE_AGENT"

ExpandMaskfield

optional

param.Field[SearchNewUsersParamsExpandMask]

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

Pathsarray

optional

[]string

An array of paths to be expanded in the response.

IDsfield

optional

param.Field[[]string]

Deprecated. Use refs array instead.

PageSizefield

optional

param.Field[int64]

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

PageTokenfield

optional

param.Field[string]

The pageToken field.

Queryfield

optional

param.Field[string]

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

Refsfield

optional

param.Field[[]IDstringUserRef]

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

Hide ParametersShow Parameters

IDstring

optional

The id of the user.

RoleIDsfield

optional

param.Field[[]string]

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

UserStatusesfield

optional

param.Field[[]string]

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

Hide ParametersShow Parameters

SearchNewUsersParamsUserStatusUnknownconst

SearchNewUsersParamsUserStatus

"UNKNOWN"

SearchNewUsersParamsUserStatusEnabledconst

SearchNewUsersParamsUserStatus

"ENABLED"

SearchNewUsersParamsUserStatusDisabledconst

SearchNewUsersParamsUserStatus

"DISABLED"

SearchNewUsersParamsUserStatusDeletedconst

SearchNewUsersParamsUserStatus

"DELETED"

Returns

SearchNewUsersResponsestruct

The SearchUsersResponse message.

Hide ParametersShow Parameters

Expandedarray

optional

[]SearchNewUsersResponseExpanded

List of related objects

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Listarray

optional

[]DelegatedUserPathstringDirectoriesPathstringManagersPathstringRolesPathstringUserC1APIUserV1UserUserView

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.

UserIDstringCreatedAtTimeDelegatedUserIDstringDeletedAtTimeDepartmentstringDepartmentSourcesarrayDirectoryIDsarrayDirectoryStatusC1APIUserV1UserDirectoryStatusDirectoryStatusSourcesarrayDisplayNamestringEmailstringEmailsarrayEmailSourcesarrayEmployeeIDsarrayEmployeeIDSourcesarrayEmploymentStatusstringEmploymentStatusSourcesarrayEmploymentTypestringEmploymentTypeSourcesarrayJobTitlestringJobTitleSourcesarrayManagerIDsarrayManagerSourcesarrayProfilemapRoleIDsarrayStatusC1APIUserV1UserStatusTypeC1APIUserV1UserTypeUpdatedAtTimeUsernamestringUsernamesarrayUsernameSourcesarrayC1APIUserV1User

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 Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Search.NewUsers(context.TODO(), conductoronesdk.SearchNewUsersParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Expanded)
}

200 Example

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