List All App Resource Entitlements

GET

app-resource-entitlements

curl --request GET \
  --url https://public.api.serval.com/v2/app-resource-entitlements \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "resourceId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "provisioningMethod": "<string>",
      "requestsEnabled": true,
      "accessPolicyId": "<string>",
      "linkedEntitlementIds": [
        "<string>"
      ],
      "manualProvisioningAssignees": [
        {
          "assigneeId": "<string>",
          "assigneeType": "MANUAL_PROVISIONING_ASSIGNEE_TYPE_UNSPECIFIED"
        }
      ],
      "provisioningStrategy": {
        "builtinWorkflow": {},
        "customWorkflow": {
          "provisionWorkflowId": "<string>",
          "deprovisionWorkflowId": "<string>"
        },
        "linkedEntitlements": {
          "linkedEntitlementIds": [
            "<string>"
          ]
        },
        "manual": {
          "assignees": [
            {
              "assigneeId": "<string>",
              "assigneeType": "MANUAL_PROVISIONING_ASSIGNEE_TYPE_UNSPECIFIED"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

resourceIds

string[]

Filter by multiple resource IDs.

teamId

string

Filter by team ID. Lists all entitlements for the specified team. Can be used alone or with resource_ids.

Response

Success

data

Entitlement · object[]

The list of entitlements.

Show child attributes

data.id

string

The ID of the entitlement.

data.resourceId

string

The ID of the resource that the entitlement belongs to.

data.name

string

The name of the entitlement.

data.description

string

A description of the entitlement.

data.provisioningMethod

string

deprecated

The provisioning method for the entitlement.

data.requestsEnabled

boolean

Whether requests are enabled for the entitlement.

data.accessPolicyId

string | null

The default access policy for the entitlement.

data.linkedEntitlementIds

string[]

deprecated

The IDs of entitlements that must be provisioned before this entitlement can be provisioned (prerequisite entitlements).

data.manualProvisioningAssignees

ManualProvisioningAssignee · object[]

deprecated

The manual provisioning assignees (users and groups) for this entitlement.

Show child attributes

data.manualProvisioningAssignees.assigneeId

string

The ID of the user or group.

data.manualProvisioningAssignees.assigneeType

enum<string>

The type of assignee.

Available options:

MANUAL_PROVISIONING_ASSIGNEE_TYPE_UNSPECIFIED,

MANUAL_PROVISIONING_ASSIGNEE_TYPE_USER,

MANUAL_PROVISIONING_ASSIGNEE_TYPE_GROUP

data.provisioningStrategy

provisioning_strategy · object

Preferred provisioning configuration. Exactly one strategy should be set.

Show child attributes

data.provisioningStrategy.builtinWorkflow

builtin_workflow · object

Option: builtin_workflow

data.provisioningStrategy.customWorkflow

custom_workflow · object

Option: custom_workflow

Show child attributes

data.provisioningStrategy.customWorkflow.provisionWorkflowId

string

The workflow ID to provision access.

data.provisioningStrategy.customWorkflow.deprovisionWorkflowId

string

The workflow ID to deprovision access.

data.provisioningStrategy.linkedEntitlements

linked_entitlements · object

Option: linked_entitlements

Show child attributes

data.provisioningStrategy.linkedEntitlements.linkedEntitlementIds

string[]

The IDs of prerequisite entitlements.

data.provisioningStrategy.manual

manual · object

Option: manual

Show child attributes

data.provisioningStrategy.manual.assignees

ManualProvisioningAssignee · object[]

Users and groups that should be assigned/notified for manual provisioning.

Show child attributes

data.provisioningStrategy.manual.assignees.assigneeId

string

The ID of the user or group.

data.provisioningStrategy.manual.assignees.assigneeType

enum<string>

The type of assignee.

Available options:

MANUAL_PROVISIONING_ASSIGNEE_TYPE_UNSPECIFIED,

MANUAL_PROVISIONING_ASSIGNEE_TYPE_USER,

MANUAL_PROVISIONING_ASSIGNEE_TYPE_GROUP

Create App Resource EntitlementCreate a new app resource entitlement for a resource.

⌘I

List All App Resource Entitlements

curl --request GET \
  --url https://public.api.serval.com/v2/app-resource-entitlements \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "resourceId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "provisioningMethod": "<string>",
      "requestsEnabled": true,
      "accessPolicyId": "<string>",
      "linkedEntitlementIds": [
        "<string>"
      ],
      "manualProvisioningAssignees": [
        {
          "assigneeId": "<string>",
          "assigneeType": "MANUAL_PROVISIONING_ASSIGNEE_TYPE_UNSPECIFIED"
        }
      ],
      "provisioningStrategy": {
        "builtinWorkflow": {},
        "customWorkflow": {
          "provisionWorkflowId": "<string>",
          "deprovisionWorkflowId": "<string>"
        },
        "linkedEntitlements": {
          "linkedEntitlementIds": [
            "<string>"
          ]
        },
        "manual": {
          "assignees": [
            {
              "assigneeId": "<string>",
              "assigneeType": "MANUAL_PROVISIONING_ASSIGNEE_TYPE_UNSPECIFIED"
            }
          ]
        }
      }
    }
  ]
}

Authentication

Endpoints

Development

Authorizations

Query Parameters

Response