Skip to content
  • Auto
  • Light
  • Dark
Get Started

List

List
client.apps.list(AppListParamsquery?, RequestOptionsoptions?): listunionnextPageTokenstringAppListResponse
get/api/v1/apps

List all apps.

Parameters
querypage_sizenumberpage_tokenstringAppListParams
Hide ParametersShow Parameters
page_sizenumber
optional

The pageSize field.

formatint32
page_tokenstring
optional

The pageToken field.

Returns
AppListResponse

The ListAppsResponse message contains a list of results and a nextPageToken if applicable.

Hide ParametersShow Parameters
listunion
optional
Array<idstringappAccountIdstringappAccountNamestringappOwnersunioncertifyPolicyIdstringconnectorVersionnumbercreatedAtstringdefaultRequestCatalogIdstringdeletedAtstringdescriptionstringdisplayNamestringfieldMaskuniongrantPolicyIdstringiconUrlstringidentityMatchingunioninstructionsstringisDirectorybooleanisManuallyManagedbooleanlogoUristringmonthlyCostUsdnumberparentAppIdstringrevokePolicyIdstringstrictAccessEntitlementProvisioningbooleanupdatedAtstringuserCountstringC1APIAppV1App> | null

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

Hide ParametersShow Parameters
idstring
optional

The ID of the app.

appAccountIdstring
optional

The ID of the Account named by AccountName.

appAccountNamestring
optional

The AccountName of the app. For example, AWS is AccountID, Github is Org Name, and Okta is Okta Subdomain.

appOwnersunion
optional
Array<idstringcreatedAtstringdelegatedUserIdstringdeletedAtstringdepartmentstringdepartmentSourcesuniondirectoryIdsuniondirectoryStatusuniondirectoryStatusSourcesuniondisplayNamestringemailstringemailsunionemailSourcesunionemployeeIdsunionemployeeIdSourcesunionemploymentStatusstringemploymentStatusSourcesunionemploymentTypestringemploymentTypeSourcesunionjobTitlestringjobTitleSourcesunionmanagerIdsunionmanagerSourcesunionprofileRecord<string, unknown>roleIdsunionstatusuniontypeunionupdatedAtstringusernamestringusernamesunionusernameSourcesunionC1APIUserV1User> | null

The owners of the app.

Hide ParametersShow Parameters
idstring
optional

A unique identifier of the user.

createdAtstring
optional
formatdate-time
delegatedUserIdstring
optional

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

deletedAtstring
optional
formatdate-time
departmentstring
optional

The department which the user belongs to in the organization.

departmentSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

directoryIdsunion
optional
Array<string> | null

A list of unique ids that represent different directories.

directoryStatusunion
optional
"UNKNOWN" | "ENABLED" | "DISABLED" | "DELETED"

The status of the user in the directory.

Hide ParametersShow Parameters
"UNKNOWN"
"ENABLED"
"DISABLED"
"DELETED"
directoryStatusSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

emailsunion
optional
Array<string> | null

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

emailSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

employeeIdsunion
optional
Array<string> | null

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

employeeIdSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

employmentStatusSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

employmentTypeSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

jobTitleSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

managerIdsunion
optional
Array<string> | null

A list of ids of the user's managers.

managerSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

profileRecord<string, unknown>
optional
roleIdsunion
optional
Array<string> | null

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.

statusunion
optional
"UNKNOWN" | "ENABLED" | "DISABLED" | "DELETED"

The status of the user in the system.

Hide ParametersShow Parameters
"UNKNOWN"
"ENABLED"
"DISABLED"
"DELETED"
typeunion
optional
"USER_TYPE_UNSPECIFIED" | "USER_TYPE_SYSTEM" | "USER_TYPE_HUMAN" | 2 more

The type of the user.

Hide ParametersShow Parameters
"USER_TYPE_UNSPECIFIED"
"USER_TYPE_SYSTEM"
"USER_TYPE_HUMAN"
"USER_TYPE_SERVICE"
"USER_TYPE_AGENT"
updatedAtstring
optional
formatdate-time
usernamestring
optional

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

usernamesunion
optional
Array<string> | null

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

usernameSourcesunion
optional
Array<appIdstringappUserIdstringappUserProfileAttributeKeystringuserAttributeMappingIdstringvaluestringC1APIUserV1UserAttributeMappingSource> | null

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.

certifyPolicyIdstring
optional

The ID of the Certify Policy associated with this App.

connectorVersionnumber
optional

The connectorVersion field.

formatuint32
createdAtstring
optional
formatdate-time
defaultRequestCatalogIdstring
optional

The ID for the default request catalog for this app.

deletedAtstring
optional
formatdate-time
descriptionstring
optional

The app's description.

displayNamestring
optional

The app's display name.

fieldMaskunion
optional
string | null
grantPolicyIdstring
optional

The ID of the Grant Policy associated with this App.

iconUrlstring
optional

The URL of an icon to display for the app.

identityMatchingunion
optional
"APP_USER_IDENTITY_MATCHING_UNSPECIFIED" | "APP_USER_IDENTITY_MATCHING_STRICT" | "APP_USER_IDENTITY_MATCHING_DISPLAY_NAME"

The identityMatching field.

Hide ParametersShow Parameters
"APP_USER_IDENTITY_MATCHING_UNSPECIFIED"
"APP_USER_IDENTITY_MATCHING_STRICT"
"APP_USER_IDENTITY_MATCHING_DISPLAY_NAME"
instructionsstring
optional

If you add instructions here, they will be shown to users in the access request form when requesting access for this app.

isDirectoryboolean
optional

Specifies if the app is a directory.

isManuallyManagedboolean
optional

The isManuallyManaged field.

logoUristring
optional

The URL of a logo to display for the app.

monthlyCostUsdnumber
optional

The cost of an app per-seat, so that total cost can be calculated by the grant count.

formatint32
parentAppIdstring
optional

The ID of the app that created this app, if any.

revokePolicyIdstring
optional

The ID of the Revoke Policy associated with this App.

strictAccessEntitlementProvisioningboolean
optional

The strictAccessEntitlementProvisioning field.

updatedAtstring
optional
formatdate-time
userCountstring
optional

The number of users with grants to this app.

formatint64
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 TypeScript
import ConductoroneSDK from 'conductorone-sdk';

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

const apps = await client.apps.list();

console.log(apps.list);
200 Example
{
  "list": [
    {
      "certifyPolicyId": "certifyPolicyId",
      "connectorVersion": 0,
      "defaultRequestCatalogId": "defaultRequestCatalogId",
      "description": "description",
      "displayName": "displayName",
      "grantPolicyId": "grantPolicyId",
      "iconUrl": "iconUrl",
      "identityMatching": "APP_USER_IDENTITY_MATCHING_UNSPECIFIED",
      "instructions": "instructions",
      "isManuallyManaged": true,
      "monthlyCostUsd": 0,
      "revokePolicyId": "revokePolicyId",
      "strictAccessEntitlementProvisioning": true
    }
  ],
  "nextPageToken": "nextPageToken"
}