Catalogs

Create

client.catalogs.create(, ?):

post/api/v1/catalogs

Get

client.catalogs.retrieve(, ?):

get/api/v1/catalogs/{id}

Update

client.catalogs.update(, ?, ?):

post/api/v1/catalogs/{id}

List

client.catalogs.list(?, ?):

get/api/v1/catalogs

Delete

client.catalogs.delete(, ?, ?): CatalogDeleteResponse

delete/api/v1/catalogs/{id}

Add App Entitlements

client.catalogs.addRequestableEntries(, , ?): CatalogAddRequestableEntriesResponse

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

Add Access Entitlements

client.catalogs.addVisibilityBindings(, , ?): CatalogAddVisibilityBindingsResponse

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

List Entitlements Per Catalog

client.catalogs.listRequestableEntitlements(, ?, ?):

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

List Entitlements For Access

client.catalogs.listVisibilityEntitlements(, ?, ?):

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

Remove App Entitlements

client.catalogs.removeRequestableEntries(, ?, ?): CatalogRemoveRequestableEntriesResponse

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

Remove Access Entitlements

client.catalogs.removeVisibilityBindings(, ?, ?): CatalogRemoveVisibilityBindingsResponse

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

Request Catalog

RequestCatalog

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

ShowShow

idstring

optional

The id of the request catalog.

accessEntitlementsunion

optional

Array<> | null

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

Hide ParametersShow Parameters

idstring

optional

The unique ID for the App Entitlement.

aliasstring

optional

The alias of the app entitlement used by Cone. Also exact-match queryable.

appIdstring

optional

The ID of the app that is associated with the app entitlement.

appResourceIdstring

optional

The ID of the app resource that is associated with the app entitlement

appResourceTypeIdstring

optional

The ID of the app resource type that is associated with the app entitlement

certifyPolicyIdstring

optional

The ID of the policy that will be used for certify tickets related to the app entitlement.

complianceFrameworkValueIdsunion

optional

Array<string> | null

The IDs of different compliance frameworks associated with this app entitlement ex (SOX, HIPAA, PCI, etc.)

createdAtstring

optional

formatdate-time

defaultValuesAppliedboolean

optional

Flag to indicate if app-level access request defaults have been applied to the entitlement

deletedAtstring

optional

formatdate-time

deprovisionerPolicy

optional

ProvisionPolicy is a oneOf that indicates how a provision step should be processed.

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

connector
manual
delegated
webhook
multiStep
externalTicket
unconfigured

descriptionstring

optional

The description of the app entitlement.

displayNamestring

optional

The display name of the app entitlement.

durationGrantstring

optional

formatduration

durationUnsetunknown

optional

emergencyGrantEnabledboolean

optional

This enables tasks to be created in an emergency and use a selected emergency access policy.

emergencyGrantPolicyIdstring

optional

The ID of the policy that will be used for emergency access grant tasks.

grantCountstring

optional

The amount of grants open for this entitlement

formatint64

grantPolicyIdstring

optional

The ID of the policy that will be used for grant tickets related to the app entitlement.

isAutomationEnabledboolean

optional

Flag to indicate whether automation (for adding users to entitlement based on rules) has been enabled.

isManuallyManagedboolean

optional

Flag to indicate if the app entitlement is manually managed.

matchBatonIdstring

optional

The matchBatonId field.

overrideAccessRequestsDefaultsboolean

optional

Flag to indicate if the app-level access request settings have been overridden for the entitlement

provisionerPolicy

optional

ProvisionPolicy is a oneOf that indicates how a provision step should be processed.

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

connector
manual
delegated
webhook
multiStep
externalTicket
unconfigured

purposeunion

optional

"APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED" | "APP_ENTITLEMENT_PURPOSE_VALUE_ASSIGNMENT" | "APP_ENTITLEMENT_PURPOSE_VALUE_PERMISSION"

The purpose field.

Hide ParametersShow Parameters

"APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED"

"APP_ENTITLEMENT_PURPOSE_VALUE_ASSIGNMENT"

"APP_ENTITLEMENT_PURPOSE_VALUE_PERMISSION"

revokePolicyIdstring

optional

The ID of the policy that will be used for revoke tickets related to the app entitlement

riskLevelValueIdstring

optional

The riskLevelValueId field.

slugstring

optional

The slug is displayed as an oval next to the name in the frontend of C1, it tells you what permission the entitlement grants. See https://www.conductorone.com/docs/product/admin/entitlements/

sourceConnectorIdsRecord<string, string>

optional

Map to tell us which connector the entitlement came from.

systemBuiltinboolean

optional

This field indicates if this is a system builtin entitlement.

updatedAtstring

optional

formatdate-time

userEditedMaskunion

optional

string | null

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.

enrollmentBehaviorunion

optional

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED" | "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_BYPASS_ENTITLEMENT_REQUEST_POLICY" | "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.

unenrollmentBehaviorunion

optional

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

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"

unenrollmentEntitlementBehaviorunion

optional

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED" | "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_BYPASS" | "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

RequestCatalogExpandMask

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

ShowShow

pathsunion

optional

Array<string> | null

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

RequestCatalogManagementServiceGetResponse

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

expandedunion

optional

Array<Expanded> | null

List of serialized related objects.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

requestCatalogView

optional

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

Request Catalog View

RequestCatalogView

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

requestCatalog

optional

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

CatalogsBundle Automation

Create Bundle Automation

client.catalogs.bundleAutomation.create(, ?, ?):

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

Delete Bundle Automation

client.catalogs.bundleAutomation.delete(, ?, ?): BundleAutomationDeleteResponse

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

Get Bundle Automation

client.catalogs.bundleAutomation.get(, ?):

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

Force Run Bundle Automation

client.catalogs.bundleAutomation.run(, ?, ?): BundleAutomationRunResponse

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

Set Bundle Automation

client.catalogs.bundleAutomation.set(, ?, ?):

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

Bundle Automation

BundleAutomation

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.

entitlementsunion

optional

| null

The BundleAutomationRuleEntitlement message.

requestCatalogIdstring

optional

The requestCatalogId field.

state

optional

The BundleAutomationLastRunState message.

Hide ParametersShow Parameters

errorMessagestring

optional

The errorMessage field.

lastRunAtstring

optional

formatdate-time

statusunion

optional

"BUNDLE_AUTOMATION_RUN_STATUS_UNSPECIFIED" | "BUNDLE_AUTOMATION_RUN_STATUS_SUCCESS" | "BUNDLE_AUTOMATION_RUN_STATUS_FAILURE" | "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

BundleAutomationRuleEntitlement

The BundleAutomationRuleEntitlement message.

ShowShow

entitlementRefsunion

optional

Array<> | null

The entitlementRefs field.

Hide ParametersShow Parameters

idstring

optional

The id field.

appIdstring

optional

The appId field.

CatalogsRequestable Entries

App Entitlement Ref

AppEntitlementRef

The AppEntitlementRef message.

ShowShow

idstring

optional

The id field.

appIdstring

optional

The appId field.