Create

Create

post/api/v1/catalogs

Creates a new request catalog.

Body Parameters

displayNamestring

The display name of the new request catalog.

descriptionstring

optional

The description of the new request catalog.

enrollmentBehaviorenum

optional

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED" OR "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_BYPASS_ENTITLEMENT_REQUEST_POLICY" OR "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_ENFORCE_ENTITLEMENT_REQUEST_POLICY"

Defines how to handle the request policies of the entitlements in the catalog during enrollment.

Hide ParametersShow Parameters

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED"

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_BYPASS_ENTITLEMENT_REQUEST_POLICY"

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_ENFORCE_ENTITLEMENT_REQUEST_POLICY"

expandMaskpathsarray of stringRequestCatalogExpandMask

optional

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

publishedboolean

optional

Whether or not the new catalog should be created as published.

requestBundleboolean

optional

Whether all the entitlements in the catalog can be requests at once. Your tenant must have the bundles feature to use this.

unenrollmentBehaviorenum

optional

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_UNSPECIFIED" OR "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_LEAVE_ACCESS_AS_IS" OR "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_ALL" OR "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_UNJUSTIFIED"

Defines how to handle the revocation of the entitlements in the catalog during unenrollment.

Hide ParametersShow Parameters

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_UNSPECIFIED"

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_LEAVE_ACCESS_AS_IS"

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_ALL"

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_UNJUSTIFIED"

unenrollmentEntitlementBehaviorenum

optional

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED" OR "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_BYPASS" OR "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_ENFORCE"

Defines how to handle the revoke policies of the entitlements in the catalog during unenrollment.

Hide ParametersShow Parameters

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED"

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_BYPASS"

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_ENFORCE"

visibleToEveryoneboolean

optional

Whether or not the new catalog is visible to everyone by default.

Returns

expandedarray of objectrequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse

Request example cURL

curl https://{tenantDomain}.conductor.one/api/v1/catalogs \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY" \
    -d '{
      "displayName": "displayName"
    }'

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