Retrieve

Get

client.Apps.Entitlements.Get(ctx, id, query) (*AppEntitlementViewC1APIAppV1AppEntitlementViewExpandedarrayAppEntitlementGetResponse, error)

get/api/v1/apps/{app_id}/entitlements/{id}

Get an app entitlement by ID.

Parameters

idstring

The id field.

queryAppIDfieldAppEntitlementGetParams

Hide ParametersShow Parameters

AppIDfield

param.Field[string]

The appId field.

Returns

AppEntitlementGetResponsestruct

The get app entitlement response returns an entitlement view containing paths in the expanded array for the objects expanded as indicated by the expand mask in the request.

Hide ParametersShow Parameters

AppEntitlementViewAppEntitlementC1APIAppV1AppEntitlementAppPathstringAppResourcePathstringAppResourceTypePathstringC1APIAppV1AppEntitlementView

optional

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

Expandedarray

optional

[]AppEntitlementGetResponseExpanded

List of serialized related objects.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

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"),
  )
  entitlement, err := client.Apps.Entitlements.Get(
    context.TODO(),
    "id",
    conductoronesdk.AppEntitlementGetParams{
      AppID: "app_id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", entitlement.AppEntitlementView)
}

200 Example

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