COconductorone
Request Catalog

Create

Changed on

Creates a new request catalog.

post/api/v1/catalogs

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/catalogs
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

annotationsobject

Bounded key/value metadata bag for IaC marking and customer tags. See .rfcs/object-annotations.md §2. Limits: ≤16 entries; keys 1–128 chars matching ^[A-Za-z][A-Za-z0-9._/-]{0,127}$; values 0–256 chars matching URL-safe ASCII; total serialized ≤4096 bytes. Keys starting with c1/ are reserved for server-managed use and rejected on write.

Well-known keys: managed_by, iac_workspace, iac_resource_address, iac_tool_version.

descriptionstring

The description of the new request catalog.

displayNamestring required

The display name of the new request catalog.

enrollmentBehavior'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.

publishedboolean

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

requestBundleboolean

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

type'REQUEST_CATALOG_TYPE_UNSPECIFIED' | 'REQUEST_CATALOG_TYPE_CATALOG' | 'REQUEST_CATALOG_TYPE_PROFILE' | 'REQUEST_CATALOG_TYPE_CATALOG_AND_BUNDLE' | 'REQUEST_CATALOG_TYPE_BUNDLE'

The type of access profile to create. Leave unset for REQUEST_CATALOG_TYPE_CATALOG_AND_BUNDLE, which is what every profile created before this field existed is. Setting it requires the ACCESS_PROFILE_TYPES feature.

PROFILE is rejected rather than resolved: it is deprecated, has no stored counterpart, and shares wire number 2 with the stored BUNDLE, so honoring it would silently persist a type the caller did not ask for.

unenrollmentBehavior'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.

unenrollmentEntitlementBehavior'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.

visibleToEveryoneboolean

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

Response

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.

Changes

  • 918a4e749f56Revision changes
    • info

      the response optional property //// became not read-only for the status

  • f76d07868c0cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status