Search

Search app users based on filters specified in the request body.

POST /api/v1/search/app_users

Search

Go

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.AppUser.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.AppUserServiceSearchResponse != nil {
        // handle response
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.appUser.search();

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/search/app_users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": "<string>",
  "appIds": [
    "<string>"
  ],
  "appUserDomains": [],
  "appUserIds": [
    "<string>"
  ],
  "appUserStatusDetails": [
    "<string>"
  ],
  "appUserStatuses": [],
  "appUserTypes": [],
  "excludeAppUserIds": [
    "<string>"
  ],
  "excludeDeletedApps": true,
  "expandMask": {
    "paths": [
      "<string>"
    ]
  },
  "pageSize": 123,
  "pageToken": "<string>",
  "query": "<string>",
  "refs": [
    {
      "appId": "<string>",
      "id": "<string>"
    }
  ],
  "userIds": [
    "<string>"
  ],
  "withOpenFindings": true,
  "withoutResponsibleParty": true
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/search/app_users"

payload = {
    "appId": "<string>",
    "appIds": ["<string>"],
    "appUserDomains": [],
    "appUserIds": ["<string>"],
    "appUserStatusDetails": ["<string>"],
    "appUserStatuses": [],
    "appUserTypes": [],
    "excludeAppUserIds": ["<string>"],
    "excludeDeletedApps": True,
    "expandMask": { "paths": ["<string>"] },
    "pageSize": 123,
    "pageToken": "<string>",
    "query": "<string>",
    "refs": [
        {
            "appId": "<string>",
            "id": "<string>"
        }
    ],
    "userIds": ["<string>"],
    "withOpenFindings": True,
    "withoutResponsibleParty": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    appId: '<string>',
    appIds: ['<string>'],
    appUserDomains: [],
    appUserIds: ['<string>'],
    appUserStatusDetails: ['<string>'],
    appUserStatuses: [],
    appUserTypes: [],
    excludeAppUserIds: ['<string>'],
    excludeDeletedApps: true,
    expandMask: {paths: ['<string>']},
    pageSize: 123,
    pageToken: '<string>',
    query: '<string>',
    refs: [{appId: '<string>', id: '<string>'}],
    userIds: ['<string>'],
    withOpenFindings: true,
    withoutResponsibleParty: true
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/search/app_users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/search/app_users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'appId' => '<string>',
    'appIds' => [
        '<string>'
    ],
    'appUserDomains' => [
        
    ],
    'appUserIds' => [
        '<string>'
    ],
    'appUserStatusDetails' => [
        '<string>'
    ],
    'appUserStatuses' => [
        
    ],
    'appUserTypes' => [
        
    ],
    'excludeAppUserIds' => [
        '<string>'
    ],
    'excludeDeletedApps' => true,
    'expandMask' => [
        'paths' => [
                '<string>'
        ]
    ],
    'pageSize' => 123,
    'pageToken' => '<string>',
    'query' => '<string>',
    'refs' => [
        [
                'appId' => '<string>',
                'id' => '<string>'
        ]
    ],
    'userIds' => [
        '<string>'
    ],
    'withOpenFindings' => true,
    'withoutResponsibleParty' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/search/app_users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appId\": \"<string>\",\n  \"appIds\": [\n    \"<string>\"\n  ],\n  \"appUserDomains\": [],\n  \"appUserIds\": [\n    \"<string>\"\n  ],\n  \"appUserStatusDetails\": [\n    \"<string>\"\n  ],\n  \"appUserStatuses\": [],\n  \"appUserTypes\": [],\n  \"excludeAppUserIds\": [\n    \"<string>\"\n  ],\n  \"excludeDeletedApps\": true,\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"appId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"withOpenFindings\": true,\n  \"withoutResponsibleParty\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/search/app_users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"appId\": \"<string>\",\n  \"appIds\": [\n    \"<string>\"\n  ],\n  \"appUserDomains\": [],\n  \"appUserIds\": [\n    \"<string>\"\n  ],\n  \"appUserStatusDetails\": [\n    \"<string>\"\n  ],\n  \"appUserStatuses\": [],\n  \"appUserTypes\": [],\n  \"excludeAppUserIds\": [\n    \"<string>\"\n  ],\n  \"excludeDeletedApps\": true,\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"appId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"withOpenFindings\": true,\n  \"withoutResponsibleParty\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "expanded": [
    {
      "@type": "<string>"
    }
  ],
  "list": [
    {
      "appPath": "<string>",
      "appUser": {
        "appId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "displayName": "<string>",
        "email": "<string>",
        "emails": [
          "<string>"
        ],
        "employeeIds": [
          "<string>"
        ],
        "id": "<string>",
        "identityUserId": "<string>",
        "isExternal": true,
        "profile": {},
        "status": {
          "details": "<string>"
        },
        "updatedAt": "2023-11-07T05:31:56Z",
        "username": "<string>",
        "usernames": [
          "<string>"
        ]
      },
      "identityUserPath": "<string>",
      "lastUsagePath": "<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 App users based on filters specified in the request body

appId · string

The app ID to restrict the search to.

appIds · string[] | null

A list of app IDs to restrict the search to.

appUserDomains · enum<string>[] | null

A list of account domains to restrict the search to.

Available options: APP_USER_DOMAIN_UNSPECIFIED, APP_USER_DOMAIN_EXTERNAL, APP_USER_DOMAIN_TRUSTED

appUserIds · string[] | null

A list of app user IDs to restrict the search to.

appUserStatusDetails · string[] | null

A list of app user status details to restrict the search to.

appUserStatuses · enum<string>[] | null

A list of app user statuses to restrict the search to.

Available options: STATUS_UNSPECIFIED, STATUS_ENABLED, STATUS_DISABLED, STATUS_DELETED

appUserTypes · enum<string>[] | null

A list of app user types to restrict the search to.

Available options: APP_USER_TYPE_UNSPECIFIED, APP_USER_TYPE_USER, APP_USER_TYPE_SERVICE_ACCOUNT, APP_USER_TYPE_SYSTEM_ACCOUNT

excludeAppUserIds · string[] | null

A list of app user IDs to remove from the results.

excludeDeletedApps · boolean

When true, excludes app users belonging to soft-deleted apps.

expandMask · App User Expand Mask · object | null

The AppUserExpandMask message contains a list of paths to expand in the response.

Show child attributes

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 description.

refs · App User Ref · object[] | null

A list of app users to limit the search to.

Show child attributes

sortBy · enum<string>

Ordering of the results. Defaults to display-name ordering.

Available options: APP_USER_SEARCH_SORT_BY_UNSPECIFIED, APP_USER_SEARCH_SORT_BY_APP

userIds · string[] | null

A list of user IDs to restrict the search by.

withOpenFindings · boolean

When true, restrict results to app users that have at least one open finding (index-backed EXISTS semi-join). When false/unset, results are unfiltered.

withoutResponsibleParty · boolean

When true, restrict results to app users with no responsible party (identity_user_id empty) — i.e. unowned, for any app-user type.

Response

200 - application/json

Successful response

The AppUserServiceSearchResponse message.

expanded · object[] | null

List of related objects.

Show child attributes

list · App User View · object[] | null

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

Show child attributes

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 retrieved. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.