Skip to content
Okta Identity Governance
/
Management APIs
/
/
Update the entitlement

Update the entitlement

Request

OAuth 2.0 scope:
  • okta.governance.entitlements.manage
Admin roles:
  • APP_ADMIN

Updates an entitlement name, description or a particular value property. The values array in the response contains only the updated entitlement values. No entitlement values are returned if the name and description is updated or values are only removed in the update.

Path
entitlementIdstringrequired

Unique identifier for the entitlement

Bodyapplication/jsonrequired

The writable attributes of an entitlement.

Array [
opstring, non-empty(entitlement-value-patch-op)required

The operation to be performed for update.

Enum:"ADD""REMOVE""REPLACE"
pathstringrequired

The path of the property being updated. ex - /values/{id} for REMOVE, REPLACE and /values/- for ADD for entitlement value update.

valueobject
refTypestringrequired
Value:"ENTITLEMENT-VALUE"
Discriminator
]
PATCH
/governance/api/v1/entitlements/{entitlementId}
curl -i -X PATCH \
  'https://okta-subdomain.pixtulate.com/governance/api/v1/entitlements/{entitlementId}' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "ADD",
      "path": "/values/-",
      "value": {
        "name": "value1",
        "description": "description for value1",
        "externalValue": "value_1"
      },
      "refType": "ENTITLEMENT-VALUE"
    },
    {
      "op": "REMOVE",
      "path": "/values/ent148gF8aZoRfFsh0g4",
      "refType": "ENTITLEMENT-VALUE"
    },
    {
      "op": "REPLACE",
      "path": "/values/ent148gF8aZoRfFsh0g4",
      "value": {
        "name": "value1",
        "description": "replace description for value1"
      },
      "refType": "ENTITLEMENT-VALUE"
    },
    {
      "op": "ADD",
      "path": "/description",
      "value": "add description for entitlement",
      "refType": "ENTITLEMENT"
    },
    {
      "op": "REMOVE",
      "path": "/description",
      "refType": "ENTITLEMENT"
    },
    {
      "op": "REPLACE",
      "path": "/description",
      "value": "replace description for entitlement",
      "refType": "ENTITLEMENT"
    },
    {
      "op": "REPLACE",
      "path": "/name",
      "value": "replace name for entitlement",
      "refType": "ENTITLEMENT"
    }
  ]'

Responses

A successful entitlement update operation

Headers
X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60
X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60
X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200
Bodyapplication/json
idstring, = 20 characters(entitlement-property-id)required

The id property of an entitlement

namestring, [ 1 .. 255 ] characters(entitlement-property-display-name)required

The display name for an entitlement property

externalValuestring, [ 1 .. 255 ] characters(entitlement-property-value)required

The value of an entitlement property

descriptionstring, [ 1 .. 1000 ] characters(entitlement-property-description)

The description of an entitlement property

multiValueboolean(entitlement-property-multi-value)required

Indicates if the entitlement property can hold multiple values. If this property is true, then the dataType property is set to array.

requiredboolean(entitlement-property-required)

The property that determines if the entitlement property is a required attribute

dataTypestring(entitlement-property-datatype)required

The data type of the entitlement property

Enum ValueDescription
string

The entitlement property is a single value.

array

The entitlement property is multivalued.

createdBystring, (okta-user-id), [ 1 .. 20 ] characters(created-by)read-onlyrequired

The id of the Okta user who created the resource

createdstring, (date-time)(created)read-onlyrequired

The ISO 8601 formatted date and time when the resource was created

lastUpdatedstring, (date-time)(last-updated)read-onlyrequired

The ISO 8601 formatted date and time when the object was last updated

lastUpdatedBystring, (okta-user-id), [ 1 .. 20 ] characters(last-updated-by)read-onlyrequired

The id of the Okta user who last updated the object

parentResourceOrnstring, (okta-resource-orn)(resource-orn)required

The Okta resource in ORN format

See the ORN format for supported resources.

parentobject(target-resource)required

Representation of a resource

valuesArray of objects(entitlement-values-full)required

Collection of entitlement values

metadataobject(list-metadata)

Metadata for the list response

Response
Response for successful entitlement update
{
  "id": "esp2lr1lavoGDYw5U8g6",
  "name": "License Entitlement",
  "externalValue": "license_entitlement",
  "description": "Some license entitlement",
  "created": "2022-05-24T14:15:22Z",
  "createdBy": "00ub0oNGTSWTBKOLGLNR",
  "lastUpdated": "2022-05-24T14:15:22Z",
  "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR",
  "parentResourceOrn": "orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ",
  "parent": {
    "externalId": "0oafxqCAJWWGELFTYASJ",
    "type": "APPLICATION"
  },
  "multiValue": true,
  "dataType": "string",
  "required": false,
  "values": [
    { … },
    { … }
  ],
  "_links": {
    "self": { … },
    "values": { … }
  },
  "metadata": {
    "total": 2
  }
}