Retrieve

Get

client.apps.retrieve(stringid, RequestOptionsoptions?): appC1APIAppV1AppAppRetrieveResponse

get/api/v1/apps/{id}

Get an app by ID.

Parameters

idstring

The id field.

Returns

AppRetrieveResponse

The GetAppResponse message contains the details of the requested app in the app field.

Hide ParametersShow Parameters

appidstringappAccountIdstringappAccountNamestringappOwnersunioncertifyPolicyIdstringconnectorVersionnumbercreatedAtstringdefaultRequestCatalogIdstringdeletedAtstringdescriptionstringdisplayNamestringfieldMaskuniongrantPolicyIdstringiconUrlstringidentityMatchingunioninstructionsstringisDirectorybooleanisManuallyManagedbooleanlogoUristringmonthlyCostUsdnumberparentAppIdstringrevokePolicyIdstringstrictAccessEntitlementProvisioningbooleanupdatedAtstringuserCountstringC1APIAppV1App

optional

The App object provides all of the details for an app, as well as some configuration.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

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

const app = await client.apps.retrieve('id');

console.log(app.app);

200 Example

{
  "app": {
    "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
  }
}