Create an entitlement | Atomicwork

curl -X POST https://{tenant}.atomicwork.com/api/v1/iga/entitlements \
     -H "X-Workspace-Id: {{workspace_id}}" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Engineering Team Access",
  "app_id": 12345,
  "description": "Entitlement granting access to the Engineering team resources and tools.",
  "status": "UNPUBLISHED",
  "provisioning_config": {
    "provider": "OKTA",
    "type": "OKTA_GROUP_PROVISIONING",
    "value": {
      "label": "Engineering Team Group",
      "icon": {
        "name": "engineering",
        "type": "svg",
        "url": "https://okta.com/icons/engineering.svg"
      },
      "value": "00g1a2b3c4d5e6f7g8h9"
    }
  },
  "deprovisioning_config": {
    "provider": "OKTA",
    "type": "OKTA_GROUP_DEPROVISIONING",
    "value": {
      "value": "00g1a2b3c4d5e6f7g8h9",
      "label": "Engineering Team Group",
      "icon": {
        "name": "engineering",
        "type": "svg",
        "url": "https://okta.com/icons/engineering.svg"
      }
    }
  }
}'

Create a new identity entitlement. Requires app_id and type. The entitlement can then be associated with policies and granted to users.

Authentication

X-Api-Keystring

API Key authentication via header

Headers

X-Workspace-IdstringOptional

Request

Request body for creating an entitlement via the public API

namestringRequired<=255 characters

Name of the entitlement

app_idlongRequired

ID of the identity resource app this entitlement belongs to

descriptionstringOptional<=1000 characters

Description of the entitlement

statusenumOptional

Status of the entitlement. Defaults to UNPUBLISHED if not specified.

Allowed values:

provisioning_configobjectOptional

deprovisioning_configobjectOptional

Response

Successful response