Skip to content
  • Auto
  • Light
  • Dark
Get Started

List

List
client.Apps.Owners.List(ctx, appID, query) (*ListarrayNextPageTokenstringAppOwnerListResponse, error)
get/api/v1/apps/{app_id}/owners

List owners of an app.

Parameters
appIDstring

The appId field.

queryPageSizefieldPageTokenfieldAppOwnerListParams
Hide ParametersShow Parameters
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.

Returns
AppOwnerListResponsestruct

The ListAppOwnersResponse message.

Hide ParametersShow Parameters
Listarray
optional
[]IDstringCreatedAtTimeDelegatedUserIDstringDeletedAtTimeDepartmentstringDepartmentSourcesarrayDirectoryIDsarrayDirectoryStatusC1APIUserV1UserDirectoryStatusDirectoryStatusSourcesarrayDisplayNamestringEmailstringEmailsarrayEmailSourcesarrayEmployeeIDsarrayEmployeeIDSourcesarrayEmploymentStatusstringEmploymentStatusSourcesarrayEmploymentTypestringEmploymentTypeSourcesarrayJobTitlestringJobTitleSourcesarrayManagerIDsarrayManagerSourcesarrayProfilemapRoleIDsarrayStatusC1APIUserV1UserStatusTypeC1APIUserV1UserTypeUpdatedAtTimeUsernamestringUsernamesarrayUsernameSourcesarrayC1APIUserV1User

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

Hide ParametersShow Parameters
IDstring
optional

A unique identifier of the user.

CreatedAtTime
optional
formatdate-time
DelegatedUserIDstring
optional

The id of the user to whom tasks will be automatically reassigned to.

DeletedAtTime
optional
formatdate-time
Departmentstring
optional

The department which the user belongs to in the organization.

DepartmentSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on department attribute mappings configured in the system.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

DirectoryIDsarray
optional
[]string

A list of unique ids that represent different directories.

DirectoryStatusC1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus
optional

The status of the user in the directory.

Hide ParametersShow Parameters
C1APIUserV1UserDirectoryStatusUnknownconst
C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus
"UNKNOWN"
C1APIUserV1UserDirectoryStatusEnabledconst
C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus
"ENABLED"
C1APIUserV1UserDirectoryStatusDisabledconst
C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus
"DISABLED"
C1APIUserV1UserDirectoryStatusDeletedconst
C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus
"DELETED"
DirectoryStatusSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on directoryStatus attribute mappings configured in the system.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

DisplayNamestring
optional

The display name of the user.

Emailstring
optional

This is the user's email.

Emailsarray
optional
[]string

This is a list of all of the user's emails from app users.

EmailSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the email attribute.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

EmployeeIDsarray
optional
[]string

This is a list of all of the user's employee IDs from app users.

EmployeeIDSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the employee IDs attribute.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

EmploymentStatusstring
optional

The users employment status.

EmploymentStatusSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on employmentStatus attribute mappings configured in the system.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

EmploymentTypestring
optional

The employment type of the user.

EmploymentTypeSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on employmentType attribute mappings configured in the system.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

JobTitlestring
optional

The job title of the user.

JobTitleSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on jobTitle attribute mappings configured in the system.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

ManagerIDsarray
optional
[]string

A list of ids of the user's managers.

ManagerSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on managerId attribute mappings configured in the system.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

Profilemap
optional
map[string, any]
RoleIDsarray
optional
[]string

A list of unique identifiers that maps to ConductorOne's user roles let you assign users permissions tailored to the work they do in the software.

StatusC1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus
optional

The status of the user in the system.

Hide ParametersShow Parameters
C1APIUserV1UserStatusUnknownconst
C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus
"UNKNOWN"
C1APIUserV1UserStatusEnabledconst
C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus
"ENABLED"
C1APIUserV1UserStatusDisabledconst
C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus
"DISABLED"
C1APIUserV1UserStatusDeletedconst
C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus
"DELETED"
TypeC1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType
optional

The type of the user.

Hide ParametersShow Parameters
C1APIUserV1UserTypeUserTypeUnspecifiedconst
C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType
"USER_TYPE_UNSPECIFIED"
C1APIUserV1UserTypeUserTypeSystemconst
C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType
"USER_TYPE_SYSTEM"
C1APIUserV1UserTypeUserTypeHumanconst
C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType
"USER_TYPE_HUMAN"
C1APIUserV1UserTypeUserTypeServiceconst
C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType
"USER_TYPE_SERVICE"
C1APIUserV1UserTypeUserTypeAgentconst
C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType
"USER_TYPE_AGENT"
UpdatedAtTime
optional
formatdate-time
Usernamestring
optional

This is the user's primary username. Typically sourced from the primary directory.

Usernamesarray
optional
[]string

This is a list of all of the user's usernames from app users.

UsernameSourcesarray
optional
[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the usernames attribute.

Hide ParametersShow Parameters
AppIDstring
optional

The appId field.

AppUserIDstring
optional

The appUserId field.

AppUserProfileAttributeKeystring
optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring
optional

The userAttributeMappingId field.

Valuestring
optional

The value field.

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

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"),
  )
  owners, err := client.Apps.Owners.List(
    context.TODO(),
    "app_id",
    conductoronesdk.AppOwnerListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", owners.List)
}
200 Example
{
  "list": [
    {
      "delegatedUserId": "delegatedUserId",
      "roleIds": [
        "string"
      ],
      "status": "UNKNOWN"
    }
  ],
  "nextPageToken": "nextPageToken"
}