Skip to content
  • Auto
  • Light
  • Dark
Get Started

Update

Update
post/api/v1/catalogs/{id}

Update a catalog.

Path Parameters
idstring

The id of the request catalog.

Body Parameters
catalogidstringaccessEntitlementsarray of C1APIAppV1AppEntitlementcreatedAtstringcreatedByUserIdstringdeletedAtstringdescriptionstringdisplayNamestringenrollmentBehaviorenumpublishedbooleanrequestBundlebooleanunenrollmentBehaviorenumunenrollmentEntitlementBehaviorenumupdatedAtstringvisibleToEveryonebooleanRequestCatalog
optional

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

expandMaskpathsarray of stringRequestCatalogExpandMask
optional

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

updateMaskstring
optional
Returns
expandedarray of objectrequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse
Request example cURL
curl https://{tenantDomain}.conductor.one/api/v1/catalogs/$ID \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"
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
    }
  }
}