Skip to content
  • Auto
  • Light
  • Dark
Get Started

List

List
get/api/v1/catalogs

Get a list of request catalogs.

Query Parameters
page_sizenumber
optional

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

formatint32
page_tokenstring
optional

The page_token field for pagination.

Returns
expandedarray of object
optional

List of serialized related objects.

Hide ParametersShow Parameters
@typestring
optional

The type of the serialized message.

listarray of accessEntitlementsPathstringcreatedByUserPathstringmemberCountstringrequestCatalogRequestCatalogRequestCatalogView
optional

The list of request catalogs.

nextPageTokenstring
optional

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Request example cURL
curl https://{tenantDomain}.conductor.one/api/v1/catalogs \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"
200 Example
{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "accessEntitlementsPath": "accessEntitlementsPath",
      "createdByUserPath": "createdByUserPath",
      "memberCount": "memberCount",
      "requestCatalog": {
        "id": "id",
        "accessEntitlements": [
          {
            "alias": "alias",
            "appId": "appId",
            "appResourceId": "appResourceId",
            "appResourceTypeId": "appResourceTypeId",
            "certifyPolicyId": "certifyPolicyId",
            "complianceFrameworkValueIds": [
              "string"
            ],
            "defaultValuesApplied": true,
            "deprovisionerPolicy": {
              "connector": {
                "account": {
                  "config": {
                    "foo": "bar"
                  },
                  "connectorId": "connectorId",
                  "doNotSave": {},
                  "saveToVault": {
                    "vaultIds": [
                      "string"
                    ]
                  },
                  "schemaId": "schemaId"
                },
                "defaultBehavior": {
                  "connectorId": "connectorId"
                },
                "deleteAccount": {
                  "connectorId": "connectorId"
                }
              },
              "delegated": {
                "appId": "appId",
                "entitlementId": "entitlementId",
                "implicit": true
              },
              "externalTicket": {
                "appId": "appId",
                "connectorId": "connectorId",
                "externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
                "instructions": "instructions"
              },
              "manual": {
                "instructions": "instructions",
                "userIds": [
                  "string"
                ]
              },
              "unconfigured": {},
              "webhook": {
                "webhookId": "webhookId"
              }
            },
            "description": "description",
            "displayName": "displayName",
            "durationGrant": "durationGrant",
            "durationUnset": {},
            "emergencyGrantEnabled": true,
            "emergencyGrantPolicyId": "emergencyGrantPolicyId",
            "grantPolicyId": "grantPolicyId",
            "isManuallyManaged": true,
            "matchBatonId": "matchBatonId",
            "overrideAccessRequestsDefaults": true,
            "provisionerPolicy": {
              "connector": {
                "account": {
                  "config": {
                    "foo": "bar"
                  },
                  "connectorId": "connectorId",
                  "doNotSave": {},
                  "saveToVault": {
                    "vaultIds": [
                      "string"
                    ]
                  },
                  "schemaId": "schemaId"
                },
                "defaultBehavior": {
                  "connectorId": "connectorId"
                },
                "deleteAccount": {
                  "connectorId": "connectorId"
                }
              },
              "delegated": {
                "appId": "appId",
                "entitlementId": "entitlementId",
                "implicit": true
              },
              "externalTicket": {
                "appId": "appId",
                "connectorId": "connectorId",
                "externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
                "instructions": "instructions"
              },
              "manual": {
                "instructions": "instructions",
                "userIds": [
                  "string"
                ]
              },
              "unconfigured": {},
              "webhook": {
                "webhookId": "webhookId"
              }
            },
            "purpose": "APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED",
            "revokePolicyId": "revokePolicyId",
            "riskLevelValueId": "riskLevelValueId",
            "slug": "slug",
            "sourceConnectorIds": {
              "foo": "string"
            },
            "userEditedMask": "userEditedMask"
          }
        ],
        "createdByUserId": "createdByUserId",
        "description": "description",
        "displayName": "displayName",
        "enrollmentBehavior": "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED",
        "published": true,
        "requestBundle": true,
        "unenrollmentBehavior": "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_UNSPECIFIED",
        "unenrollmentEntitlementBehavior": "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED",
        "visibleToEveryone": true
      }
    }
  ],
  "nextPageToken": "nextPageToken"
}