List Requestable Entitlements

List Entitlements Per Catalog

client.Catalogs.ListRequestableEntitlements(ctx, catalogID, query) (*ExpandedarrayListarrayNextPageTokenstringCatalogListRequestableEntitlementsResponse, error)

get/api/v1/catalogs/{catalog_id}/requestable_entitlements

List entitlements in a catalog that are requestable.

Parameters

catalogIDstring

The catalogId field.

queryPageSizefieldPageTokenfieldCatalogListRequestableEntitlementsParams

Hide ParametersShow Parameters

PageSizefield

optional

param.Field[int64]

The pageSize field.

formatint32

PageTokenfield

optional

param.Field[string]

The pageToken field.

Returns

CatalogListRequestableEntitlementsResponsestruct

The RequestCatalogManagementServiceListEntitlementsPerCatalogResponse message contains a list of results and a nextPageToken if applicable.

Hide ParametersShow Parameters

Expandedarray

optional

[]CatalogListRequestableEntitlementsResponseExpanded

List of serialized related objects.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Listarray

optional

[]AppEntitlementC1APIAppV1AppEntitlementAppPathstringAppResourcePathstringAppResourceTypePathstringC1APIAppV1AppEntitlementView

The list of results containing up to X results, where X is the page size defined in the request.

Hide ParametersShow Parameters

AppEntitlementIDstringAliasstringAppIDstringAppResourceIDstringAppResourceTypeIDstringCertifyPolicyIDstringComplianceFrameworkValueIDsarrayCreatedAtTimeDefaultValuesAppliedboolDeletedAtTimeDeprovisionerPolicyC1APIPolicyV1ProvisionPolicyDescriptionstringDisplayNamestringDurationGrantstringDurationUnsetanyEmergencyGrantEnabledboolEmergencyGrantPolicyIDstringGrantCountstringGrantPolicyIDstringIsAutomationEnabledboolIsManuallyManagedboolMatchBatonIDstringOverrideAccessRequestsDefaultsboolProvisionerPolicyC1APIPolicyV1ProvisionPolicyPurposeC1APIAppV1AppEntitlementPurposeRevokePolicyIDstringRiskLevelValueIDstringSlugstringSourceConnectorIDsmapSystemBuiltinboolUpdatedAtTimeUserEditedMaskstringC1APIAppV1AppEntitlement

optional

The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write.

This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:

• durationUnset
• durationGrant

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the array.

AppResourcePathstring

optional

JSONPATH expression indicating the location of the App Resource Type object in the expanded array.

AppResourceTypePathstring

optional

JSONPATH expression indicating the location of the App Resource object in the array.

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 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"),
  )
  response, err := client.Catalogs.ListRequestableEntitlements(
    context.TODO(),
    "catalog_id",
    conductoronesdk.CatalogListRequestableEntitlementsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Expanded)
}

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appEntitlement": {
        "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"
      },
      "appPath": "appPath",
      "appResourcePath": "appResourcePath",
      "appResourceTypePath": "appResourceTypePath"
    }
  ],
  "nextPageToken": "nextPageToken"
}