DataRobot APIのリソース > APIリファレンスドキュメント > DataRobot REST API > Administration > Entitlements

Entitlements¶

This page outlines the operations, endpoints, parameters, and example requests and responses for the Entitlements.

POST /api/v2/entitlements/evaluate/¶

Evaluate entitlements of the client requesting the API.

Code samples¶

curl -X POST https://app.datarobot.com/api/v2/entitlements/evaluate/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{EvaluateEntitlementsRequest}'

Body parameter¶

{
  "entitlements": [
    {
      "name": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	EvaluateEntitlementsRequest	false	none

Example responses¶

200 Response

{
  "entitlements": [
    {
      "name": "string",
      "value": true
    }
  ]
}

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

{
  "name": "string"
}

Properties¶

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

EntitlementEvaluateResult

{
  "name": "string",
  "value": true
}

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

{
  "entitlements": [
    {
      "name": "string"
    }
  ]
}

Properties¶

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

EvaluateEntitlementsResponse

{
  "entitlements": [
    {
      "name": "string",
      "value": true
    }
  ]
}

Properties¶

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