Catalogs

Catalogs

Catalogs

Create

post/api/v1/catalogs

Get

get/api/v1/catalogs/{id}

Update

post/api/v1/catalogs/{id}

List

get/api/v1/catalogs

Delete

delete/api/v1/catalogs/{id}

Add App Entitlements

post/api/v1/catalogs/{catalog_id}/requestable_entries

Add Access Entitlements

post/api/v1/catalogs/{catalog_id}/visibility_bindings

List Entitlements Per Catalog

get/api/v1/catalogs/{catalog_id}/requestable_entitlements

List Entitlements For Access

get/api/v1/catalogs/{catalog_id}/visibility_entitlements

Remove App Entitlements

delete/api/v1/catalogs/{catalog_id}/requestable_entries

Remove Access Entitlements

delete/api/v1/catalogs/{catalog_id}/visibility_bindings

Request Catalog

RequestCatalogobject

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

ShowShow

idstring

optional

The id of the request catalog.

accessEntitlementsarray of idstringaliasstringappIdstringappResourceIdstringappResourceTypeIdstringcertifyPolicyIdstringcomplianceFrameworkValueIdsarray of stringcreatedAtstringdefaultValuesAppliedbooleandeletedAtstringdeprovisionerPolicyC1APIPolicyV1ProvisionPolicydescriptionstringdisplayNamestringdurationGrantstringdurationUnsetunknownemergencyGrantEnabledbooleanemergencyGrantPolicyIdstringgrantCountstringgrantPolicyIdstringisAutomationEnabledbooleanisManuallyManagedbooleanmatchBatonIdstringoverrideAccessRequestsDefaultsbooleanprovisionerPolicyC1APIPolicyV1ProvisionPolicypurposeenumrevokePolicyIdstringriskLevelValueIdstringslugstringsourceConnectorIdsmapsystemBuiltinbooleanupdatedAtstringuserEditedMaskstringC1APIAppV1AppEntitlement

optional

An array of app entitlements that, if the user has, can view the contents of this catalog.

createdAtstring

optional

formatdate-time

createdByUserIdstring

optional

The id of the user this request catalog was created by.

deletedAtstring

optional

formatdate-time

descriptionstring

optional

The description of the request catalog.

displayNamestring

optional

The display name of the 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"

publishedboolean

optional

Whether or not this catalog is 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"

updatedAtstring

optional

formatdate-time

visibleToEveryoneboolean

optional

If this is true, the access entitlement requirement is ignored.

Request Catalog Expand Mask

RequestCatalogExpandMaskobject

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

ShowShow

pathsarray of string

optional

An array of paths to be expanded in the response. May be any combination of "*", "created_by_user_id", "app_ids", and "access_entitlements".

Request Catalog Management Service Get Response

RequestCatalogManagementServiceGetResponseobject

The request catalog management service get response returns a request catalog view with the expanded items in the expanded array indicated by the expand mask in the request.

ShowShow

expandedarray of object

optional

List of serialized related objects.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

requestCatalogViewaccessEntitlementsPathstringcreatedByUserPathstringmemberCountstringrequestCatalogRequestCatalogRequestCatalogView

optional

The request catalog view contains the serialized request catalog and paths to objects referenced by the request catalog.

Request Catalog View

RequestCatalogViewobject

The request catalog view contains the serialized request catalog and paths to objects referenced by the request catalog.

ShowShow

accessEntitlementsPathstring

optional

JSONPATH expression indicating the location of the access entitlement objects, that the request catalog allows users to request, in the array.

createdByUserPathstring

optional

JSONPATH expression indicating the location of the User object, that created the request catalog, in the array.

memberCountstring

optional

Total number of the members of the catalog

formatint64

requestCatalogidstringaccessEntitlementsarray of C1APIAppV1AppEntitlementcreatedAtstringcreatedByUserIdstringdeletedAtstringdescriptionstringdisplayNamestringenrollmentBehaviorenumpublishedbooleanrequestBundlebooleanunenrollmentBehaviorenumunenrollmentEntitlementBehaviorenumupdatedAtstringvisibleToEveryonebooleanRequestCatalog

optional

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

CatalogsBundle Automation

Create Bundle Automation

post/api/v1/catalogs/{request_catalog_id}/bundle_automation/create

Delete Bundle Automation

delete/api/v1/catalogs/{request_catalog_id}/bundle_automation

Get Bundle Automation

get/api/v1/catalogs/{request_catalog_id}/bundle_automation

Force Run Bundle Automation

post/api/v1/catalogs/{request_catalog_id}/bundle_automation/run

Set Bundle Automation

post/api/v1/catalogs/{request_catalog_id}/bundle_automation

Bundle Automation

BundleAutomationobject

The BundleAutomation message.

This message contains a oneof named conditions. Only a single field of the following list may be set at a time:

• entitlements

ShowShow

createdAtstring

optional

formatdate-time

createTasksboolean

optional

The createTasks field.

deletedAtstring

optional

formatdate-time

enabledboolean

optional

The enabled field.

entitlementsentitlementRefsarray of AppEntitlementRefBundleAutomationRuleEntitlement

optional

The BundleAutomationRuleEntitlement message.

requestCatalogIdstring

optional

The requestCatalogId field.

stateobject

optional

The BundleAutomationLastRunState message.

Hide ParametersShow Parameters

errorMessagestring

optional

The errorMessage field.

lastRunAtstring

optional

formatdate-time

statusenum

optional

"BUNDLE_AUTOMATION_RUN_STATUS_UNSPECIFIED" OR "BUNDLE_AUTOMATION_RUN_STATUS_SUCCESS" OR "BUNDLE_AUTOMATION_RUN_STATUS_FAILURE" OR "BUNDLE_AUTOMATION_RUN_STATUS_IN_PROGRESS"

The status field.

Hide ParametersShow Parameters

"BUNDLE_AUTOMATION_RUN_STATUS_UNSPECIFIED"

"BUNDLE_AUTOMATION_RUN_STATUS_SUCCESS"

"BUNDLE_AUTOMATION_RUN_STATUS_FAILURE"

"BUNDLE_AUTOMATION_RUN_STATUS_IN_PROGRESS"

tenantIdstring

optional

The tenantId field.

updatedAtstring

optional

formatdate-time

Bundle Automation Rule Entitlement

BundleAutomationRuleEntitlementobject

The BundleAutomationRuleEntitlement message.

ShowShow

entitlementRefsarray of idstringappIdstringAppEntitlementRef

optional

The entitlementRefs field.

CatalogsRequestable Entries

App Entitlement Ref

AppEntitlementRefobject

The AppEntitlementRef message.

ShowShow

idstring

optional

The id field.

appIdstring

optional

The appId field.