Skip to content
  • Auto
  • Light
  • Dark
Get Started

Update

Update
client.apps.update(stringid, AppUpdateParamsbody?, RequestOptionsoptions?): appC1APIAppV1AppAppUpdateResponse
post/api/v1/apps/{id}

Update an existing app.

Parameters
idstring

The ID of the app.

bodyappC1APIAppV1AppupdateMaskunionAppUpdateParams
Hide ParametersShow Parameters
appidstringappAccountIdstringappAccountNamestringappOwnersunioncertifyPolicyIdstringconnectorVersionnumbercreatedAtstringdefaultRequestCatalogIdstringdeletedAtstringdescriptionstringdisplayNamestringfieldMaskuniongrantPolicyIdstringiconUrlstringidentityMatchingunioninstructionsstringisDirectorybooleanisManuallyManagedbooleanlogoUristringmonthlyCostUsdnumberparentAppIdstringrevokePolicyIdstringstrictAccessEntitlementProvisioningbooleanupdatedAtstringuserCountstringC1APIAppV1App
optional

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

updateMaskunion
optional
string | null
Returns
AppUpdateResponse

Returns the updated app's new values.

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.update('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
  }
}