Create App Users

Search

client.search.createAppUsers(SearchCreateAppUsersParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateAppUsersResponse

post/api/v1/search/app_users

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

Parameters

bodyappIdstringappUserDomainsunionappUserIdsunionappUserStatusDetailsunionappUserStatusesunionappUserTypesunionexcludeAppUserIdsunionexpandMaskC1APIAppV1AppUserExpandMaskpageSizenumberpageTokenstringquerystringrefsunionuserIdsunionSearchCreateAppUsersParams

Hide ParametersShow Parameters

appIdstring

optional

The app ID to restrict the search to.

appUserDomainsunion

optional

Array<"APP_USER_DOMAIN_UNSPECIFIED" | "APP_USER_DOMAIN_EXTERNAL" | "APP_USER_DOMAIN_TRUSTED"> | null

A list of account domains to restrict the search to.

Hide ParametersShow Parameters

"APP_USER_DOMAIN_UNSPECIFIED"

"APP_USER_DOMAIN_EXTERNAL"

"APP_USER_DOMAIN_TRUSTED"

appUserIdsunion

optional

Array<string> | null

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

appUserStatusDetailsunion

optional

Array<string> | null

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

appUserStatusesunion

optional

Array<"STATUS_UNSPECIFIED" | "STATUS_ENABLED" | "STATUS_DISABLED" | "STATUS_DELETED"> | null

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

Hide ParametersShow Parameters

"STATUS_UNSPECIFIED"

"STATUS_ENABLED"

"STATUS_DISABLED"

"STATUS_DELETED"

appUserTypesunion

optional

Array<"APP_USER_TYPE_UNSPECIFIED" | "APP_USER_TYPE_USER" | "APP_USER_TYPE_SERVICE_ACCOUNT" | "APP_USER_TYPE_SYSTEM_ACCOUNT"> | null

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

Hide ParametersShow Parameters

"APP_USER_TYPE_UNSPECIFIED"

"APP_USER_TYPE_USER"

"APP_USER_TYPE_SERVICE_ACCOUNT"

"APP_USER_TYPE_SYSTEM_ACCOUNT"

excludeAppUserIdsunion

optional

Array<string> | null

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

expandMaskpathsunionC1APIAppV1AppUserExpandMask

optional

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

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

refsunion

optional

Array<idstringappIdstringAppUserRef> | null

A list of app users to limit the search to.

Hide ParametersShow Parameters

idstring

optional

The ID of the app user.

appIdstring

optional

The ID of the application.

userIdsunion

optional

Array<string> | null

A list of user IDs to restrict the search by.

Returns

SearchCreateAppUsersResponse

The AppUserServiceSearchResponse 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<appPathstringappUserC1APIAppV1AppUseridentityUserPathstringlastUsagePathstringC1APIAppV1AppUserView> | null

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

Hide ParametersShow Parameters

appPathstring

optional

JSONPATH expression indicating where the app is expanded in expanded arrays indicated in the request.

appUseridstringappIdstringappUserTypeunioncreatedAtstringdeletedAtstringdisplayNamestringemailstringemailsunionemployeeIdsunionidentityUserIdstringisExternalbooleanprofileRecord<string, unknown>statusStatusupdatedAtstringusernamestringusernamesunionC1APIAppV1AppUser

optional

Application User that represents an account in the application.

identityUserPathstring

optional

JSONPATH expression indicating where the identity user is expanded in expanded arrays indicated in the request.

lastUsagePathstring

optional

JSONPATH expression indicating where the last usage information is expanded in expanded arrays indicated in the request.

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

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

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

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

console.log(response.expanded);

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appPath": "appPath",
      "appUser": {
        "appUserType": "APP_USER_TYPE_UNSPECIFIED",
        "status": {}
      },
      "identityUserPath": "identityUserPath",
      "lastUsagePath": "lastUsagePath"
    }
  ],
  "nextPageToken": "nextPageToken"
}