Skip to main content
POST
/
api
/
v1
/
catalogs
Create
package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.RequestCatalogManagement.Create(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.RequestCatalogManagementServiceGetResponse != nil {
        // handle response
    }
}
import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.requestCatalogManagement.create();

  console.log(result);
}

run();
curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/catalogs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "annotations": {},
  "description": "<string>",
  "expandMask": {
    "paths": [
      "<string>"
    ]
  },
  "published": true,
  "requestBundle": true,
  "visibleToEveryone": true
}
'
import requests

url = "https://{tenantDomain}.conductor.one/api/v1/catalogs"

payload = {
    "displayName": "<string>",
    "annotations": {},
    "description": "<string>",
    "expandMask": { "paths": ["<string>"] },
    "published": True,
    "requestBundle": True,
    "visibleToEveryone": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    annotations: {},
    description: '<string>',
    expandMask: {paths: ['<string>']},
    published: true,
    requestBundle: true,
    visibleToEveryone: true
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/catalogs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/catalogs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'annotations' => [
        
    ],
    'description' => '<string>',
    'expandMask' => [
        'paths' => [
                '<string>'
        ]
    ],
    'published' => true,
    'requestBundle' => true,
    'visibleToEveryone' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/catalogs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"annotations\": {},\n  \"description\": \"<string>\",\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"published\": true,\n  \"requestBundle\": true,\n  \"visibleToEveryone\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/catalogs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"annotations\": {},\n  \"description\": \"<string>\",\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"published\": true,\n  \"requestBundle\": true,\n  \"visibleToEveryone\": true\n}"

response = http.request(request)
puts response.read_body
{
  "expanded": [
    {
      "@type": "<string>"
    }
  ],
  "requestCatalogView": {
    "accessEntitlementsPath": "<string>",
    "createdByUserPath": "<string>",
    "memberCount": "<string>",
    "requestCatalog": {
      "accessEntitlements": [
        {
          "alias": "<string>",
          "annotations": {},
          "appId": "<string>",
          "appResourceId": "<string>",
          "appResourceTypeId": "<string>",
          "certifyPolicyId": "<string>",
          "complianceFrameworkValueIds": [
            "<string>"
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "defaultValuesApplied": true,
          "deletedAt": "2023-11-07T05:31:56Z",
          "deprovisionerPolicy": {
            "action": {
              "actionName": "<string>",
              "appId": "<string>",
              "connectorId": "<string>",
              "displayName": "<string>"
            },
            "connector": {
              "account": {
                "config": {},
                "connectorId": "<string>",
                "doNotSave": {},
                "saveToVault": {
                  "vaultIds": [
                    "<string>"
                  ]
                },
                "schemaId": "<string>"
              },
              "defaultBehavior": {
                "connectorId": "<string>"
              },
              "deleteAccount": {
                "connectorId": "<string>"
              }
            },
            "delegated": {
              "appId": "<string>",
              "entitlementId": "<string>",
              "implicit": true
            },
            "externalTicket": {
              "appId": "<string>",
              "connectorId": "<string>",
              "externalTicketProvisionerConfigId": "<string>",
              "instructions": "<string>"
            },
            "manual": {
              "assignee": {
                "appOwners": {
                  "allowReassignment": true,
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "entitlementOwners": {
                  "allowReassignment": true,
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "expression": {
                  "allowReassignment": true,
                  "expressions": [
                    "<string>"
                  ],
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "group": {
                  "allowReassignment": true,
                  "appGroupId": "<string>",
                  "appId": "<string>",
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "manager": {
                  "allowReassignment": true,
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "users": {
                  "allowReassignment": true,
                  "userIds": [
                    "<string>"
                  ]
                }
              },
              "instructions": "<string>",
              "userIds": [
                "<string>"
              ]
            },
            "multiStep": {
              "provisionSteps": "<array>"
            },
            "unconfigured": {},
            "webhook": {
              "webhookId": "<string>"
            }
          },
          "description": "<string>",
          "displayName": "<string>",
          "durationGrant": "<string>",
          "durationUnset": {},
          "emergencyGrantEnabled": true,
          "emergencyGrantPolicyId": "<string>",
          "externalId": "<string>",
          "grantCount": "<string>",
          "grantPolicyId": "<string>",
          "id": "<string>",
          "isAutomationEnabled": true,
          "isManuallyManaged": true,
          "matchBatonId": "<string>",
          "overrideAccessRequestsDefaults": true,
          "provisionerPolicy": {
            "action": {
              "actionName": "<string>",
              "appId": "<string>",
              "connectorId": "<string>",
              "displayName": "<string>"
            },
            "connector": {
              "account": {
                "config": {},
                "connectorId": "<string>",
                "doNotSave": {},
                "saveToVault": {
                  "vaultIds": [
                    "<string>"
                  ]
                },
                "schemaId": "<string>"
              },
              "defaultBehavior": {
                "connectorId": "<string>"
              },
              "deleteAccount": {
                "connectorId": "<string>"
              }
            },
            "delegated": {
              "appId": "<string>",
              "entitlementId": "<string>",
              "implicit": true
            },
            "externalTicket": {
              "appId": "<string>",
              "connectorId": "<string>",
              "externalTicketProvisionerConfigId": "<string>",
              "instructions": "<string>"
            },
            "manual": {
              "assignee": {
                "appOwners": {
                  "allowReassignment": true,
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "entitlementOwners": {
                  "allowReassignment": true,
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "expression": {
                  "allowReassignment": true,
                  "expressions": [
                    "<string>"
                  ],
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "group": {
                  "allowReassignment": true,
                  "appGroupId": "<string>",
                  "appId": "<string>",
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "manager": {
                  "allowReassignment": true,
                  "fallbackUserIds": [
                    "<string>"
                  ]
                },
                "users": {
                  "allowReassignment": true,
                  "userIds": [
                    "<string>"
                  ]
                }
              },
              "instructions": "<string>",
              "userIds": [
                "<string>"
              ]
            },
            "multiStep": {
              "provisionSteps": "<array>"
            },
            "unconfigured": {},
            "webhook": {
              "webhookId": "<string>"
            }
          },
          "requestSchemaId": "<string>",
          "revokePolicyId": "<string>",
          "riskLevelValueId": "<string>",
          "slug": "<string>",
          "sourceConnectorIds": {},
          "systemBuiltin": true,
          "updatedAt": "2023-11-07T05:31:56Z",
          "userEditedMask": "<string>"
        }
      ],
      "annotations": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "displayName": "<string>",
      "id": "<string>",
      "published": true,
      "requestBundle": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "visibleToEveryone": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

Create a request catalog.

​
displayName
string | null
required

The display name of the new request catalog.

​
annotations
object

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.

​
description
string | null

The description of the new request catalog.

​
enrollmentBehavior
enum<string> | null

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

Available options:
REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED,
REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_BYPASS_ENTITLEMENT_REQUEST_POLICY,
REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_ENFORCE_ENTITLEMENT_REQUEST_POLICY
​
expandMask
Request Catalog Expand Mask · object | null

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

​
published
boolean | null

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

​
requestBundle
boolean | null

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

​
unenrollmentBehavior
enum<string> | null

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

Available options:
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
​
unenrollmentEntitlementBehavior
enum<string> | null

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

Available options:
REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED,
REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_BYPASS,
REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_ENFORCE
​
visibleToEveryone
boolean | null

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

Response

200 - application/json

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.

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.

​
expanded
object[] | null

List of serialized related objects.

​
requestCatalogView
Request Catalog View · object | null

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