Grant an entitlement.

POST

/api/admin/field-mapping/entitlements

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/entitlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "subjectId": "subject_123", "entitlementType": "permission", "entitlementKey": "reports:read" }'

Records an entitlement grant or assignment with source/manual/protected ownership and revocation policy metadata.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Request Body ^required

Media type application/json

object

subjectId

string

accountId

string

entitlementType

required

string

entitlementKey

required

string

sourceId

string | null

value

object | null

ownershipPolicy

string

Allowed values: source_owned manual protected

revokePolicy

string

Allowed values: auto review keep

protectedUntil

integer | null

key

additional properties

Example

{
  "subjectId": "subject_123",
  "entitlementType": "permission",
  "entitlementKey": "reports:read"
}

Responses

200

Entitlement grant response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

entitlementType

required

string

entitlementKey

required

string

lifecycleState

required

string

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "entitlementType": "example",
    "entitlementKey": "example",
    "lifecycleState": "example"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}