Skip to content
  • Auto
  • Light
  • Dark
Get Started

Retrieve App Users

List App Users For User
client.Apps.Users.GetAppUsers(ctx, userID, params) (*ExpandedarrayListarrayNextPageTokenstringAppUserGetAppUsersResponse, error)
get/api/v1/apps/{app_id}/users/{user_id}/app_users

Invokes the c1.api.app.v1.AppUserService.ListAppUsersForUser method.

Parameters
userIDstring

The userId field.

paramsAppIDfieldPageSizefieldPageTokenfieldAppUserGetAppUsersParams
Hide ParametersShow Parameters
AppIDfield
param.Field[string]

Path param: The appId field.

PageSizefield
optional
param.Field[int64]

Query param: The pageSize field.

formatint32
PageTokenfield
optional
param.Field[string]

Query param: The pageToken field.

Returns
AppUserGetAppUsersResponsestruct

The AppUsersForUserServiceListResponse message.

Hide ParametersShow Parameters
Expandedarray
optional

The expanded field.

Hide ParametersShow Parameters
Typestring
optional

The type of the serialized message.

Listarray
optional
[]AppPathstringAppUserC1APIAppV1AppUserIdentityUserPathstringLastUsagePathstringC1APIAppV1AppUserView

The list field.

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

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.Apps.Users.GetAppUsers(
    context.TODO(),
    "user_id",
    conductoronesdk.AppUserGetAppUsersParams{
      AppID: "app_id",
    },
  )
  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"
}