DataRobot API resources > API reference documentation > REST API > Administration > Entitlements

Entitlements¶

Use the endpoints described below to manage entitlements.

POST /api/v2/entitlements/evaluate/¶

Evaluate entitlements of the client requesting the API.

Body parameter¶

{
  "properties": {
    "entitlements": {
      "description": "Entitlements to evaluate",
      "items": {
        "properties": {
          "name": {
            "description": "Name of the entitlement to evaluate",
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 100,
      "type": "array"
    }
  },
  "required": [
    "entitlements"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}

Parameters

Name	In	Type	Required	Description
body	body	EvaluateEntitlementsRequest	false	none

Example responses¶

200 Response

{
  "properties": {
    "entitlements": {
      "description": "Results of evaluation",
      "items": {
        "properties": {
          "name": {
            "description": "Name of the entitlement to evaluate",
            "type": "string"
          },
          "value": {
            "description": "The result of an entitlement evaluation.",
            "oneOf": [
              {
                "type": "boolean"
              }
            ]
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 100,
      "type": "array"
    }
  },
  "required": [
    "entitlements"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Evaluation succeeded.	EvaluateEntitlementsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas¶

Entitlement

{
  "properties": {
    "name": {
      "description": "Name of the entitlement to evaluate",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true		Name of the entitlement to evaluate

EntitlementEvaluateResult

{
  "properties": {
    "name": {
      "description": "Name of the entitlement to evaluate",
      "type": "string"
    },
    "value": {
      "description": "The result of an entitlement evaluation.",
      "oneOf": [
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true		Name of the entitlement to evaluate
value	boolean	true		The result of an entitlement evaluation.

EvaluateEntitlementsRequest

{
  "properties": {
    "entitlements": {
      "description": "Entitlements to evaluate",
      "items": {
        "properties": {
          "name": {
            "description": "Name of the entitlement to evaluate",
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 100,
      "type": "array"
    }
  },
  "required": [
    "entitlements"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}

Properties¶

Name	Type	Required	Restrictions	Description
entitlements	[Entitlement]	true	maxItems: 100	Entitlements to evaluate

EvaluateEntitlementsResponse

{
  "properties": {
    "entitlements": {
      "description": "Results of evaluation",
      "items": {
        "properties": {
          "name": {
            "description": "Name of the entitlement to evaluate",
            "type": "string"
          },
          "value": {
            "description": "The result of an entitlement evaluation.",
            "oneOf": [
              {
                "type": "boolean"
              }
            ]
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 100,
      "type": "array"
    }
  },
  "required": [
    "entitlements"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}

Properties¶

Name	Type	Required	Restrictions	Description
entitlements	[EntitlementEvaluateResult]	true	maxItems: 100	Results of evaluation