Skip to content
  • Auto
  • Light
  • Dark
Get Started

Create

Create
client.apps.create(AppCreateParamsbody, RequestOptionsoptions?): appC1APIAppV1AppAppCreateResponse
post/api/v1/apps

Create a new manual app without a connector.

Parameters
bodydisplayNamestringcertifyPolicyIdstringdescriptionstringgrantPolicyIdstringidentityMatchingunionmonthlyCostUsdnumberownersunionrevokePolicyIdstringstrictAccessEntitlementProvisioningbooleanAppCreateParams
Hide ParametersShow Parameters
displayNamestring

Creates the app with this display name.

certifyPolicyIdstring
optional

Creates the app with this certify policy.

descriptionstring
optional

Creates the app with this description.

grantPolicyIdstring
optional

Creates the app with this grant policy.

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

Define the app user identity matching strategy for this app.

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

Creates the app with this monthly cost per seat.

formatint32
ownersunion
optional
Array<string> | null

Creates the app with this array of owners.

revokePolicyIdstring
optional

Creates the app with this revoke policy.

strictAccessEntitlementProvisioningboolean
optional

This flag enforces a provisioning mode where the access entitlement is always included in the provisioning flow, if the app user doesn't exist

Returns
AppCreateResponse

Returns the new app's 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.create({ displayName: 'displayName' });

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