Create

Create

client.Catalogs.New(ctx, body) (*ExpandedarrayRequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse, error)

post/api/v1/catalogs

Creates a new request catalog.

Parameters

bodyDisplayNamefieldDescriptionfieldEnrollmentBehaviorfieldExpandMaskfieldPublishedfieldRequestBundlefieldUnenrollmentBehaviorfieldUnenrollmentEntitlementBehaviorfieldVisibleToEveryonefieldCatalogNewParams

Hide ParametersShow Parameters

DisplayNamefield

param.Field[string]

The display name of the new request catalog.

Descriptionfield

optional

param.Field[string]

The description of the new request catalog.

EnrollmentBehaviorfield

optional

param.Field[CatalogNewParamsEnrollmentBehavior]

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

Hide ParametersShow Parameters

CatalogNewParamsEnrollmentBehaviorRequestCatalogEnrollmentBehaviorUnspecifiedconst

CatalogNewParamsEnrollmentBehavior

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED"

CatalogNewParamsEnrollmentBehaviorRequestCatalogEnrollmentBehaviorBypassEntitlementRequestPolicyconst

CatalogNewParamsEnrollmentBehavior

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_BYPASS_ENTITLEMENT_REQUEST_POLICY"

CatalogNewParamsEnrollmentBehaviorRequestCatalogEnrollmentBehaviorEnforceEntitlementRequestPolicyconst

CatalogNewParamsEnrollmentBehavior

"REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_ENFORCE_ENTITLEMENT_REQUEST_POLICY"

ExpandMaskfield

optional

param.Field[PathsarrayRequestCatalogExpandMask]

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

Publishedfield

optional

param.Field[bool]

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

RequestBundlefield

optional

param.Field[bool]

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

UnenrollmentBehaviorfield

optional

param.Field[CatalogNewParamsUnenrollmentBehavior]

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

Hide ParametersShow Parameters

CatalogNewParamsUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecifiedconst

CatalogNewParamsUnenrollmentBehavior

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_UNSPECIFIED"

CatalogNewParamsUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIsconst

CatalogNewParamsUnenrollmentBehavior

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_LEAVE_ACCESS_AS_IS"

CatalogNewParamsUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAllconst

CatalogNewParamsUnenrollmentBehavior

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_ALL"

CatalogNewParamsUnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustifiedconst

CatalogNewParamsUnenrollmentBehavior

"REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_UNJUSTIFIED"

UnenrollmentEntitlementBehaviorfield

optional

param.Field[CatalogNewParamsUnenrollmentEntitlementBehavior]

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

Hide ParametersShow Parameters

CatalogNewParamsUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUnspecifiedconst

CatalogNewParamsUnenrollmentEntitlementBehavior

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED"

CatalogNewParamsUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorBypassconst

CatalogNewParamsUnenrollmentEntitlementBehavior

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_BYPASS"

CatalogNewParamsUnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorEnforceconst

CatalogNewParamsUnenrollmentEntitlementBehavior

"REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_ENFORCE"

VisibleToEveryonefield

optional

param.Field[bool]

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

Returns

ExpandedarrayRequestCatalogViewRequestCatalogViewRequestCatalogManagementServiceGetResponse

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  requestCatalogManagementServiceGetResponse, err := client.Catalogs.New(context.TODO(), conductoronesdk.CatalogNewParams{
    DisplayName: "displayName",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", requestCatalogManagementServiceGetResponse.Expanded)
}

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "requestCatalogView": {
    "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
    }
  }
}