Skip to main content
POST
/
api
/
v1
/
search
/
users
Search
package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.UserSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SearchUsersResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}
{
  "expanded": [
    {
      "@type": "<string>"
    }
  ],
  "list": [
    {
      "delegatedUserPath": "<string>",
      "directoriesPath": "<string>",
      "managersPath": "<string>",
      "rolesPath": "<string>",
      "user": {
        "createdAt": "2023-11-07T05:31:56Z",
        "delegatedUserId": "<string>",
        "deletedAt": "2023-11-07T05:31:56Z",
        "department": "<string>",
        "departmentSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "directoryIds": [
          "<string>"
        ],
        "directoryStatus": "UNKNOWN",
        "directoryStatusSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "displayName": "<string>",
        "email": "<string>",
        "emailSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "emails": [
          "<string>"
        ],
        "employeeIdSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "employeeIds": [
          "<string>"
        ],
        "employmentStatus": "<string>",
        "employmentStatusSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "employmentType": "<string>",
        "employmentTypeSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "id": "<string>",
        "jobTitle": "<string>",
        "jobTitleSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "managerIds": [
          "<string>"
        ],
        "managerSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "profile": {},
        "roleIds": [
          "<string>"
        ],
        "status": "UNKNOWN",
        "type": "USER_TYPE_UNSPECIFIED",
        "updatedAt": "2023-11-07T05:31:56Z",
        "username": "<string>",
        "usernameSources": [
          {
            "appId": "<string>",
            "appUserId": "<string>",
            "appUserProfileAttributeKey": "<string>",
            "userAttributeMappingId": "<string>",
            "value": "<string>"
          }
        ],
        "usernames": [
          "<string>"
        ]
      }
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

Search for users based on some filters.

​
departments
string[] | null

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

​
email
string

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

​
excludeIds
string[] | null

An array of users IDs to exclude from the results.

​
excludeTypes
enum<string>[] | null

An array of types to exclude from the results.

Available options:
USER_TYPE_UNSPECIFIED,
USER_TYPE_SYSTEM,
USER_TYPE_HUMAN,
USER_TYPE_SERVICE,
USER_TYPE_AGENT
​
expandMask
User Expand Mask · object

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 '*'.

​
ids
string[] | null

Deprecated. Use refs array instead.

​
jobTitles
string[] | null

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

​
managerIds
string[] | null

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

​
pageSize
integer<int32>

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

​
pageToken
string

The pageToken field.

​
query
string

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

​
refs
User Ref · object[] | null

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

​
roleIds
string[] | null

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

​
userStatuses
enum<string>[] | null

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

Available options:
UNKNOWN,
ENABLED,
DISABLED,
DELETED

Response

200 - application/json

Successful response

The SearchUsersResponse message.

​
expanded
object[] | null

List of related objects

​
list
User View · object[] | null

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

​
nextPageToken
string

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.