Create App Users

Search

client.Search.NewAppUsers(ctx, body) (*ExpandedarrayListarrayNextPageTokenstringSearchNewAppUsersResponse, error)

post/api/v1/search/app_users

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

Parameters

bodyAppIDfieldAppUserDomainsfieldAppUserIDsfieldAppUserStatusDetailsfieldAppUserStatusesfieldAppUserTypesfieldExcludeAppUserIDsfieldExpandMaskfieldPageSizefieldPageTokenfieldQueryfieldRefsfieldUserIDsfieldSearchNewAppUsersParams

Hide ParametersShow Parameters

AppIDfield

optional

param.Field[string]

The app ID to restrict the search to.

AppUserDomainsfield

optional

param.Field[[]string]

A list of account domains to restrict the search to.

Hide ParametersShow Parameters

SearchNewAppUsersParamsAppUserDomainAppUserDomainUnspecifiedconst

SearchNewAppUsersParamsAppUserDomain

"APP_USER_DOMAIN_UNSPECIFIED"

SearchNewAppUsersParamsAppUserDomainAppUserDomainExternalconst

SearchNewAppUsersParamsAppUserDomain

"APP_USER_DOMAIN_EXTERNAL"

SearchNewAppUsersParamsAppUserDomainAppUserDomainTrustedconst

SearchNewAppUsersParamsAppUserDomain

"APP_USER_DOMAIN_TRUSTED"

AppUserIDsfield

optional

param.Field[[]string]

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

AppUserStatusDetailsfield

optional

param.Field[[]string]

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

AppUserStatusesfield

optional

param.Field[[]string]

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

Hide ParametersShow Parameters

SearchNewAppUsersParamsAppUserStatusStatusUnspecifiedconst

SearchNewAppUsersParamsAppUserStatus

"STATUS_UNSPECIFIED"

SearchNewAppUsersParamsAppUserStatusStatusEnabledconst

SearchNewAppUsersParamsAppUserStatus

"STATUS_ENABLED"

SearchNewAppUsersParamsAppUserStatusStatusDisabledconst

SearchNewAppUsersParamsAppUserStatus

"STATUS_DISABLED"

SearchNewAppUsersParamsAppUserStatusStatusDeletedconst

SearchNewAppUsersParamsAppUserStatus

"STATUS_DELETED"

AppUserTypesfield

optional

param.Field[[]string]

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

Hide ParametersShow Parameters

SearchNewAppUsersParamsAppUserTypeAppUserTypeUnspecifiedconst

SearchNewAppUsersParamsAppUserType

"APP_USER_TYPE_UNSPECIFIED"

SearchNewAppUsersParamsAppUserTypeAppUserTypeUserconst

SearchNewAppUsersParamsAppUserType

"APP_USER_TYPE_USER"

SearchNewAppUsersParamsAppUserTypeAppUserTypeServiceAccountconst

SearchNewAppUsersParamsAppUserType

"APP_USER_TYPE_SERVICE_ACCOUNT"

SearchNewAppUsersParamsAppUserTypeAppUserTypeSystemAccountconst

SearchNewAppUsersParamsAppUserType

"APP_USER_TYPE_SYSTEM_ACCOUNT"

ExcludeAppUserIDsfield

optional

param.Field[[]string]

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

ExpandMaskfield

optional

param.Field[PathsarrayC1APIAppV1AppUserExpandMask]

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

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

Refsfield

optional

param.Field[[]IDstringAppIDstringAppUserRef]

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.

UserIDsfield

optional

param.Field[[]string]

A list of user IDs to restrict the search by.

Returns

SearchNewAppUsersResponsestruct

The AppUserServiceSearchResponse message.

Hide ParametersShow Parameters

Expandedarray

optional

[]SearchNewAppUsersResponseExpanded

List of related objects.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Listarray

optional

[]AppPathstringAppUserC1APIAppV1AppUserIdentityUserPathstringLastUsagePathstringC1APIAppV1AppUserView

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.

AppUserIDstringAppIDstringAppUserTypeC1APIAppV1AppUserAppUserTypeCreatedAtTimeDeletedAtTimeDisplayNamestringEmailstringEmailsarrayEmployeeIDsarrayIdentityUserIDstringIsExternalboolProfilemapStatusC1APIAppV1AppUserStatusUpdatedAtTimeUsernamestringUsernamesarrayC1APIAppV1AppUser

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 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.NewAppUsers(context.TODO(), conductoronesdk.SearchNewAppUsersParams{

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

200 Example

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