Update

Update

client.catalogs.update(stringid, CatalogUpdateParamsbody?, RequestOptionsoptions?): expandedunionrequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse

post/api/v1/catalogs/{id}

Update a catalog.

Parameters

idstring

The id of the request catalog.

bodycatalogRequestCatalogexpandMaskRequestCatalogExpandMaskupdateMaskunionCatalogUpdateParams

Hide ParametersShow Parameters

catalogidstringaccessEntitlementsunioncreatedAtstringcreatedByUserIdstringdeletedAtstringdescriptionstringdisplayNamestringenrollmentBehaviorunionpublishedbooleanrequestBundlebooleanunenrollmentBehaviorunionunenrollmentEntitlementBehaviorunionupdatedAtstringvisibleToEveryonebooleanRequestCatalog

optional

The RequestCatalog is used for managing which entitlements are requestable, and who can request them.

expandMaskpathsunionRequestCatalogExpandMask

optional

The RequestCatalogExpandMask includes the paths in the catalog view to expand in the return value of this call.

updateMaskunion

optional

string | null

Returns

expandedunionrequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

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

const requestCatalogManagementServiceGetResponse = await client.catalogs.update('id');

console.log(requestCatalogManagementServiceGetResponse.expanded);

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "requestCatalogView": {
    "accessEntitlementsPath": "accessEntitlementsPath",
    "createdByUserPath": "createdByUserPath",
    "memberCount": "memberCount",
    "requestCatalog": {
      "id": "id",
      "accessEntitlements": [
        {
          "alias": "alias",
          "appId": "appId",
          "appResourceId": "appResourceId",
          "appResourceTypeId": "appResourceTypeId",
          "certifyPolicyId": "certifyPolicyId",
          "complianceFrameworkValueIds": [
            "string"
          ],
          "defaultValuesApplied": true,
          "deprovisionerPolicy": {
            "connector": {
              "account": {
                "config": {
                  "foo": "bar"
                },
                "connectorId": "connectorId",
                "doNotSave": {},
                "saveToVault": {
                  "vaultIds": [
                    "string"
                  ]
                },
                "schemaId": "schemaId"
              },
              "defaultBehavior": {
                "connectorId": "connectorId"
              },
              "deleteAccount": {
                "connectorId": "connectorId"
              }
            },
            "delegated": {
              "appId": "appId",
              "entitlementId": "entitlementId",
              "implicit": true
            },
            "externalTicket": {
              "appId": "appId",
              "connectorId": "connectorId",
              "externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
              "instructions": "instructions"
            },
            "manual": {
              "instructions": "instructions",
              "userIds": [
                "string"
              ]
            },
            "unconfigured": {},
            "webhook": {
              "webhookId": "webhookId"
            }
          },
          "description": "description",
          "displayName": "displayName",
          "durationGrant": "durationGrant",
          "durationUnset": {},
          "emergencyGrantEnabled": true,
          "emergencyGrantPolicyId": "emergencyGrantPolicyId",
          "grantPolicyId": "grantPolicyId",
          "isManuallyManaged": true,
          "matchBatonId": "matchBatonId",
          "overrideAccessRequestsDefaults": true,
          "provisionerPolicy": {
            "connector": {
              "account": {
                "config": {
                  "foo": "bar"
                },
                "connectorId": "connectorId",
                "doNotSave": {},
                "saveToVault": {
                  "vaultIds": [
                    "string"
                  ]
                },
                "schemaId": "schemaId"
              },
              "defaultBehavior": {
                "connectorId": "connectorId"
              },
              "deleteAccount": {
                "connectorId": "connectorId"
              }
            },
            "delegated": {
              "appId": "appId",
              "entitlementId": "entitlementId",
              "implicit": true
            },
            "externalTicket": {
              "appId": "appId",
              "connectorId": "connectorId",
              "externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
              "instructions": "instructions"
            },
            "manual": {
              "instructions": "instructions",
              "userIds": [
                "string"
              ]
            },
            "unconfigured": {},
            "webhook": {
              "webhookId": "webhookId"
            }
          },
          "purpose": "APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED",
          "revokePolicyId": "revokePolicyId",
          "riskLevelValueId": "riskLevelValueId",
          "slug": "slug",
          "sourceConnectorIds": {
            "foo": "string"
          },
          "userEditedMask": "userEditedMask"
        }
      ],
      "createdByUserId": "createdByUserId",
      "description": "description",
      "displayName": "displayName",
      "enrollmentBehavior": "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED",
      "published": true,
      "requestBundle": true,
      "unenrollmentBehavior": "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_UNSPECIFIED",
      "unenrollmentEntitlementBehavior": "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED",
      "visibleToEveryone": true
    }
  }
}