Skip to content
ConductorOne Docs
  • Auto
  • Light
  • Dark
Get Started

Catalogs

Catalogs

Catalogs

Create
client.Catalogs.New(ctx, body) (*ExpandedarrayRequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse, error)
post/api/v1/catalogs
Get
client.Catalogs.Get(ctx, id) (*ExpandedarrayRequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse, error)
get/api/v1/catalogs/{id}
Update
client.Catalogs.Update(ctx, id, body) (*ExpandedarrayRequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse, error)
post/api/v1/catalogs/{id}
List
client.Catalogs.List(ctx, query) (*ExpandedarrayListarrayNextPageTokenstringCatalogListResponse, error)
get/api/v1/catalogs
Delete
client.Catalogs.Delete(ctx, id, body) (*CatalogDeleteResponse, error)
delete/api/v1/catalogs/{id}
Add App Entitlements
client.Catalogs.AddRequestableEntries(ctx, catalogID, body) (*CatalogAddRequestableEntriesResponse, error)
post/api/v1/catalogs/{catalog_id}/requestable_entries
Add Access Entitlements
client.Catalogs.AddVisibilityBindings(ctx, catalogID, body) (*CatalogAddVisibilityBindingsResponse, error)
post/api/v1/catalogs/{catalog_id}/visibility_bindings
List Entitlements Per Catalog
client.Catalogs.ListRequestableEntitlements(ctx, catalogID, query) (*ExpandedarrayListarrayNextPageTokenstringCatalogListRequestableEntitlementsResponse, error)
get/api/v1/catalogs/{catalog_id}/requestable_entitlements
List Entitlements For Access
client.Catalogs.ListVisibilityEntitlements(ctx, catalogID, query) (*ExpandedarrayListarrayNextPageTokenstringCatalogListVisibilityEntitlementsResponse, error)
get/api/v1/catalogs/{catalog_id}/visibility_entitlements
Remove App Entitlements
client.Catalogs.RemoveRequestableEntries(ctx, catalogID, body) (*CatalogRemoveRequestableEntriesResponse, error)
delete/api/v1/catalogs/{catalog_id}/requestable_entries
Remove Access Entitlements
client.Catalogs.RemoveVisibilityBindings(ctx, catalogID, body) (*CatalogRemoveVisibilityBindingsResponse, error)
delete/api/v1/catalogs/{catalog_id}/visibility_bindings
Request Catalog
RequestCatalogstruct

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
optional
[]IDstringAliasstringAppIDstringAppResourceIDstringAppResourceTypeIDstringCertifyPolicyIDstringComplianceFrameworkValueIDsarrayCreatedAtTimeDefaultValuesAppliedboolDeletedAtTimeDeprovisionerPolicyC1APIPolicyV1ProvisionPolicyDescriptionstringDisplayNamestringDurationGrantstringDurationUnsetanyEmergencyGrantEnabledboolEmergencyGrantPolicyIDstringGrantCountstringGrantPolicyIDstringIsAutomationEnabledboolIsManuallyManagedboolMatchBatonIDstringOverrideAccessRequestsDefaultsboolProvisionerPolicyC1APIPolicyV1ProvisionPolicyPurposeC1APIAppV1AppEntitlementPurposeRevokePolicyIDstringRiskLevelValueIDstringSlugstringSourceConnectorIDsmapSystemBuiltinboolUpdatedAtTimeUserEditedMaskstringC1APIAppV1AppEntitlement

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.

ComplianceFrameworkValueIDsarray
optional
[]string

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

CreatedAtTime
optional
formatdate-time
DefaultValuesAppliedbool
optional

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

DeletedAtTime
optional
formatdate-time
DeprovisionerPolicyConnectorC1APIPolicyV1ProvisionPolicyConnectorDelegatedC1APIPolicyV1ProvisionPolicyDelegatedExternalTicketC1APIPolicyV1ProvisionPolicyExternalTicketManualC1APIPolicyV1ProvisionPolicyManualUnconfiguredanyWebhookC1APIPolicyV1ProvisionPolicyWebhookC1APIPolicyV1ProvisionPolicy
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
DurationUnsetany
optional
EmergencyGrantEnabledbool
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.

IsAutomationEnabledbool
optional

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

IsManuallyManagedbool
optional

Flag to indicate if the app entitlement is manually managed.

MatchBatonIDstring
optional

The matchBatonId field.

OverrideAccessRequestsDefaultsbool
optional

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

ProvisionerPolicyConnectorC1APIPolicyV1ProvisionPolicyConnectorDelegatedC1APIPolicyV1ProvisionPolicyDelegatedExternalTicketC1APIPolicyV1ProvisionPolicyExternalTicketManualC1APIPolicyV1ProvisionPolicyManualUnconfiguredanyWebhookC1APIPolicyV1ProvisionPolicyWebhookC1APIPolicyV1ProvisionPolicy
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
PurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose
optional

The purpose field.

Hide ParametersShow Parameters
C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedconst
C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose
"APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED"
C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentconst
C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose
"APP_ENTITLEMENT_PURPOSE_VALUE_ASSIGNMENT"
C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionconst
C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose
"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/

SourceConnectorIDsmap
optional
map[string, string]

Map to tell us which connector the entitlement came from.

SystemBuiltinbool
optional

This field indicates if this is a system builtin entitlement.

UpdatedAtTime
optional
formatdate-time
UserEditedMaskstring
optional
CreatedAtTime
optional
formatdate-time
CreatedByUserIDstring
optional

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

DeletedAtTime
optional
formatdate-time
Descriptionstring
optional

The description of the request catalog.

DisplayNamestring
optional

The display name of the request catalog.

EnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorUnspecifiedRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorBypassEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorEnforceEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehavior
optional

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

Hide ParametersShow Parameters
RequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorUnspecifiedconst
RequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorUnspecifiedRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorBypassEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorEnforceEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehavior
"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED"
RequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorBypassEntitlementRequestPolicyconst
RequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorUnspecifiedRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorBypassEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorEnforceEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehavior
"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_BYPASS_ENTITLEMENT_REQUEST_POLICY"
RequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorEnforceEntitlementRequestPolicyconst
RequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorUnspecifiedRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorBypassEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehaviorEnforceEntitlementRequestPolicyRequestCatalogEnrollmentBehaviorRequestCatalogEnrollmentBehavior
"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_ENFORCE_ENTITLEMENT_REQUEST_POLICY"
Publishedbool
optional

Whether or not this catalog is published.

RequestBundlebool
optional

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

UnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIsRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAllRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehavior
optional

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

Hide ParametersShow Parameters
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecifiedconst
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIsRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAllRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehavior
"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_UNSPECIFIED"
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIsconst
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIsRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAllRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehavior
"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_LEAVE_ACCESS_AS_IS"
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAllconst
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIsRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAllRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehavior
"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_ALL"
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustifiedconst
RequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIsRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAllRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustifiedRequestCatalogUnenrollmentBehaviorRequestCatalogUnenrollmentBehavior
"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_UNJUSTIFIED"
UnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUnspecifiedRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorBypassRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorEnforceRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehavior
optional

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

Hide ParametersShow Parameters
RequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUnspecifiedconst
RequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUnspecifiedRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorBypassRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorEnforceRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehavior
"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED"
RequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorBypassconst
RequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUnspecifiedRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorBypassRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorEnforceRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehavior
"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_BYPASS"
RequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorEnforceconst
RequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUnspecifiedRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorBypassRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorEnforceRequestCatalogUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehavior
"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_ENFORCE"
UpdatedAtTime
optional
formatdate-time
VisibleToEveryonebool
optional

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

Request Catalog Expand Mask
RequestCatalogExpandMaskstruct

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

ShowShow
Pathsarray
optional
[]string

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
RequestCatalogManagementServiceGetResponsestruct

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
optional
[]RequestCatalogManagementServiceGetResponseExpanded

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
RequestCatalogViewstruct

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
RequestCatalogIDstringAccessEntitlementsarrayCreatedAtTimeCreatedByUserIDstringDeletedAtTimeDescriptionstringDisplayNamestringEnrollmentBehaviorRequestCatalogEnrollmentBehaviorPublishedboolRequestBundleboolUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUpdatedAtTimeVisibleToEveryoneboolRequestCatalog
optional

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

CatalogsBundle Automation

Create Bundle Automation
client.Catalogs.BundleAutomation.New(ctx, requestCatalogID, body) (*CreatedAtTimeCreateTasksboolDeletedAtTimeEnabledboolEntitlementsBundleAutomationRuleEntitlementRequestCatalogIDstringStateBundleAutomationStateTenantIDstringUpdatedAtTimeBundleAutomation, error)
post/api/v1/catalogs/{request_catalog_id}/bundle_automation/create
Delete Bundle Automation
client.Catalogs.BundleAutomation.Delete(ctx, requestCatalogID, body) (*CatalogBundleAutomationDeleteResponse, error)
delete/api/v1/catalogs/{request_catalog_id}/bundle_automation
Get Bundle Automation
client.Catalogs.BundleAutomation.Get(ctx, requestCatalogID) (*CreatedAtTimeCreateTasksboolDeletedAtTimeEnabledboolEntitlementsBundleAutomationRuleEntitlementRequestCatalogIDstringStateBundleAutomationStateTenantIDstringUpdatedAtTimeBundleAutomation, error)
get/api/v1/catalogs/{request_catalog_id}/bundle_automation
Force Run Bundle Automation
client.Catalogs.BundleAutomation.Run(ctx, requestCatalogID, body) (*CatalogBundleAutomationRunResponse, error)
post/api/v1/catalogs/{request_catalog_id}/bundle_automation/run
Set Bundle Automation
client.Catalogs.BundleAutomation.Set(ctx, requestCatalogID, body) (*CreatedAtTimeCreateTasksboolDeletedAtTimeEnabledboolEntitlementsBundleAutomationRuleEntitlementRequestCatalogIDstringStateBundleAutomationStateTenantIDstringUpdatedAtTimeBundleAutomation, error)
post/api/v1/catalogs/{request_catalog_id}/bundle_automation
Bundle Automation
BundleAutomationstruct

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
CreatedAtTime
optional
formatdate-time
CreateTasksbool
optional

The createTasks field.

DeletedAtTime
optional
formatdate-time
Enabledbool
optional

The enabled field.

EntitlementsEntitlementRefsarrayBundleAutomationRuleEntitlement
optional

The BundleAutomationRuleEntitlement message.

RequestCatalogIDstring
optional

The requestCatalogId field.

StateErrorMessagestringLastRunAtTimeStatusstringBundleAutomationState
optional

The BundleAutomationLastRunState message.

Hide ParametersShow Parameters
ErrorMessagestring
optional

The errorMessage field.

LastRunAtTime
optional
formatdate-time
Statusstring
optional

The status field.

Hide ParametersShow Parameters
BundleAutomationStateStatusBundleAutomationRunStatusUnspecifiedconst
BundleAutomationStateStatusBundleAutomationRunStatusUnspecifiedBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusSuccessBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusFailureBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusInProgressBundleAutomationStateStatusBundleAutomationStateStatus
"BUNDLE_AUTOMATION_RUN_STATUS_UNSPECIFIED"
BundleAutomationStateStatusBundleAutomationRunStatusSuccessconst
BundleAutomationStateStatusBundleAutomationRunStatusUnspecifiedBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusSuccessBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusFailureBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusInProgressBundleAutomationStateStatusBundleAutomationStateStatus
"BUNDLE_AUTOMATION_RUN_STATUS_SUCCESS"
BundleAutomationStateStatusBundleAutomationRunStatusFailureconst
BundleAutomationStateStatusBundleAutomationRunStatusUnspecifiedBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusSuccessBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusFailureBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusInProgressBundleAutomationStateStatusBundleAutomationStateStatus
"BUNDLE_AUTOMATION_RUN_STATUS_FAILURE"
BundleAutomationStateStatusBundleAutomationRunStatusInProgressconst
BundleAutomationStateStatusBundleAutomationRunStatusUnspecifiedBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusSuccessBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusFailureBundleAutomationStateStatusBundleAutomationStateStatusBundleAutomationRunStatusInProgressBundleAutomationStateStatusBundleAutomationStateStatus
"BUNDLE_AUTOMATION_RUN_STATUS_IN_PROGRESS"
TenantIDstring
optional

The tenantId field.

UpdatedAtTime
optional
formatdate-time
Bundle Automation Rule Entitlement
BundleAutomationRuleEntitlementstruct

The BundleAutomationRuleEntitlement message.

ShowShow
EntitlementRefsarray
optional
[]IDstringAppIDstringAppEntitlementRef

The entitlementRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

CatalogsRequestable Entries

App Entitlement Ref
AppEntitlementRefstruct

The AppEntitlementRef message.

ShowShow
IDstring
optional

The id field.

AppIDstring
optional

The appId field.