Skip to content
  • Auto
  • Light
  • Dark
Get Started

Create Entitlements

Search Entitlements
client.Search.RequestCatalog.NewEntitlements(ctx, body) (*ExpandedarrayListarrayNextPageTokenstringSearchRequestCatalogNewEntitlementsResponse, error)
post/api/v1/search/request_catalog/entitlements

Search request catalogs based on filters specified in the request body.

Parameters
bodyAppDisplayNamefieldEntitlementAliasfieldExpandMaskfieldGrantedStatusfieldIncludeDeletedfieldPageSizefieldPageTokenfieldQueryfieldSearchRequestCatalogNewEntitlementsParams
Hide ParametersShow Parameters
AppDisplayNamefield
optional
param.Field[string]

Search entitlements that belong to this app name (exact match).

EntitlementAliasfield
optional
param.Field[string]

Search for entitlements with this alias (exact match).

ExpandMaskfield
optional
param.Field[PathsarrayC1APIAppV1AppEntitlementExpandMask]

The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.

GrantedStatusfield
optional

Search entitlements with this granted status for your signed in user.

Hide ParametersShow Parameters
SearchRequestCatalogNewEntitlementsParamsGrantedStatusUnspecifiedconst
"UNSPECIFIED"
SearchRequestCatalogNewEntitlementsParamsGrantedStatusAllconst
"ALL"
SearchRequestCatalogNewEntitlementsParamsGrantedStatusGrantedconst
"GRANTED"
SearchRequestCatalogNewEntitlementsParamsGrantedStatusNotGrantedconst
"NOT_GRANTED"
IncludeDeletedfield
optional
param.Field[bool]

Include deleted entitlements

PageSizefield
optional
param.Field[int64]

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
PageTokenfield
optional
param.Field[string]

The pageToken field.

Queryfield
optional
param.Field[string]

Fuzzy search the display name of resource types.

Returns
SearchRequestCatalogNewEntitlementsResponsestruct

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

Hide ParametersShow Parameters
Expandedarray
optional

List of serialized related objects.

Hide ParametersShow Parameters
Typestring
optional

The type of the serialized message.

Listarray
optional

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

Hide ParametersShow Parameters
AppEntitlementUserBindingsarray
optional
[]AppEntitlementIDstringAppIDstringAppUserIDstringCreatedAtTimeDeletedAtTimeDeprovisionAtTimeGrantSourcesarrayC1APIAppV1AppEntitlementUserBinding

An array of AppEntitlementUserBinding objects which represent the relationships that give app users access to the specific app entitlement.

Hide ParametersShow Parameters
AppEntitlementIDstring
optional

The ID of the app entitlement that the app user has access to

AppIDstring
optional

The ID of the app associated with the app entitlement

AppUserIDstring
optional

The ID of the app user that has access to the app entitlement

CreatedAtTime
optional
formatdate-time
DeletedAtTime
optional
formatdate-time
DeprovisionAtTime
optional
formatdate-time
GrantSourcesarray
optional
[]IDstringAppIDstringAppEntitlementRef

The grantSources field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

EntitlementAppEntitlementC1APIAppV1AppEntitlementAppPathstringAppResourcePathstringAppResourceTypePathstringC1APIAppV1AppEntitlementView
optional

The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.

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.Search.RequestCatalog.NewEntitlements(context.TODO(), conductoronesdk.SearchRequestCatalogNewEntitlementsParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Expanded)
}
200 Example
{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appEntitlementUserBindings": [
        {
          "appEntitlementId": "appEntitlementId",
          "appId": "appId",
          "appUserId": "appUserId",
          "grantSources": [
            {
              "id": "id",
              "appId": "appId"
            }
          ]
        }
      ],
      "entitlement": {
        "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"
}