Update Entitlement AppStore Settings

curl --request PATCH \
  --url https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowed_requester_group_uuids_override": [
    "4d5e6f70-8192-0123-def0-234567890123"
  ],
  "time_based_access_override": {
    "options": [
      "7 days",
      "30 days"
    ]
  },
  "visible_in_appstore": true
}
'

import requests

url = "https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings"

payload = {
    "allowed_requester_group_uuids_override": ["4d5e6f70-8192-0123-def0-234567890123"],
    "time_based_access_override": { "options": ["7 days", "30 days"] },
    "visible_in_appstore": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowed_requester_group_uuids_override: ['4d5e6f70-8192-0123-def0-234567890123'],
    time_based_access_override: {options: ['7 days', '30 days']},
    visible_in_appstore: true
  })
};

fetch('https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'allowed_requester_group_uuids_override' => [
        '4d5e6f70-8192-0123-def0-234567890123'
    ],
    'time_based_access_override' => [
        'options' => [
                '7 days',
                '30 days'
        ]
    ],
    'visible_in_appstore' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings"

	payload := strings.NewReader("{\n  \"allowed_requester_group_uuids_override\": [\n    \"4d5e6f70-8192-0123-def0-234567890123\"\n  ],\n  \"time_based_access_override\": {\n    \"options\": [\n      \"7 days\",\n      \"30 days\"\n    ]\n  },\n  \"visible_in_appstore\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowed_requester_group_uuids_override\": [\n    \"4d5e6f70-8192-0123-def0-234567890123\"\n  ],\n  \"time_based_access_override\": {\n    \"options\": [\n      \"7 days\",\n      \"30 days\"\n    ]\n  },\n  \"visible_in_appstore\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowed_requester_group_uuids_override\": [\n    \"4d5e6f70-8192-0123-def0-234567890123\"\n  ],\n  \"time_based_access_override\": {\n    \"options\": [\n      \"7 days\",\n      \"30 days\"\n    ]\n  },\n  \"visible_in_appstore\": true\n}"

response = http.request(request)
puts response.read_body

{
  "visible_in_appstore": true,
  "allowed_requester_group_uuids_override": [
    "<string>"
  ],
  "time_based_access_override": {
    "options": [
      {
        "label": "<string>",
        "value_seconds": 123
      }
    ]
  },
  "request_validation_webhook_uuid": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

PATCH

entitlements

{entitlement_uuid}

appstore-settings

Update Entitlement AppStore Settings

curl --request PATCH \
  --url https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowed_requester_group_uuids_override": [
    "4d5e6f70-8192-0123-def0-234567890123"
  ],
  "time_based_access_override": {
    "options": [
      "7 days",
      "30 days"
    ]
  },
  "visible_in_appstore": true
}
'

import requests

url = "https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings"

payload = {
    "allowed_requester_group_uuids_override": ["4d5e6f70-8192-0123-def0-234567890123"],
    "time_based_access_override": { "options": ["7 days", "30 days"] },
    "visible_in_appstore": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowed_requester_group_uuids_override: ['4d5e6f70-8192-0123-def0-234567890123'],
    time_based_access_override: {options: ['7 days', '30 days']},
    visible_in_appstore: true
  })
};

fetch('https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'allowed_requester_group_uuids_override' => [
        '4d5e6f70-8192-0123-def0-234567890123'
    ],
    'time_based_access_override' => [
        'options' => [
                '7 days',
                '30 days'
        ]
    ],
    'visible_in_appstore' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings"

	payload := strings.NewReader("{\n  \"allowed_requester_group_uuids_override\": [\n    \"4d5e6f70-8192-0123-def0-234567890123\"\n  ],\n  \"time_based_access_override\": {\n    \"options\": [\n      \"7 days\",\n      \"30 days\"\n    ]\n  },\n  \"visible_in_appstore\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowed_requester_group_uuids_override\": [\n    \"4d5e6f70-8192-0123-def0-234567890123\"\n  ],\n  \"time_based_access_override\": {\n    \"options\": [\n      \"7 days\",\n      \"30 days\"\n    ]\n  },\n  \"visible_in_appstore\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/entitlements/{entitlement_uuid}/appstore-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowed_requester_group_uuids_override\": [\n    \"4d5e6f70-8192-0123-def0-234567890123\"\n  ],\n  \"time_based_access_override\": {\n    \"options\": [\n      \"7 days\",\n      \"30 days\"\n    ]\n  },\n  \"visible_in_appstore\": true\n}"

response = http.request(request)
puts response.read_body

{
  "visible_in_appstore": true,
  "allowed_requester_group_uuids_override": [
    "<string>"
  ],
  "time_based_access_override": {
    "options": [
      {
        "label": "<string>",
        "value_seconds": 123
      }
    ]
  },
  "request_validation_webhook_uuid": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entitlement_uuid

string

required

The entitlement's ID, which GET /v1/entitlements and GET /v1/apps/{app_uuid}/entitlements return as id.

Body

application/json

Request body for PATCH /v1/entitlements/{entitlement_uuid}/appstore-settings.

Merge-patch semantics: a field omitted from the request body is left unchanged. For the override fields (allowed_requester_group_uuids_override, time_based_access_override), an explicit null turns the override off so the entitlement inherits the app's setting. visible_in_appstore has no such "unset" state -- it's always a concrete bool on the entitlement, so null there is equivalent to omitting the field.

visible_in_appstore

boolean | null

Whether this entitlement is visible in the AppStore catalog.

allowed_requester_group_uuids_override

string[] | null

UUIDs of groups whose members may request this entitlement, overriding the app's allowed requester groups. null clears the override so this entitlement inherits the app's allowed requester groups. An empty list turns the override on with no group restriction: anyone can request this entitlement, even if the app restricts requesters.

time_based_access_override

EntitlementTimeBasedAccessOverridePatchInput · object | null

This entitlement's own time-based access options, overriding the app's. Null clears the override so this entitlement inherits the app's time-based access options.

Show child attributes

request_validation_webhook_uuid

string | null

UUID of the inline webhook to call to validate access requests for this entitlement. Null removes this entitlement's webhook. Nothing is inherited from the app. When a request names entitlements, only the webhooks set on those entitlements run.

Response

Successful Response

visible_in_appstore

boolean

required

Whether this entitlement is visible in the AppStore catalog.

allowed_requester_group_uuids_override

string[] | null

UUIDs of groups whose members may request this entitlement, overriding the app's allowed requester groups. null means this entitlement inherits the app's allowed requester groups. An empty list means the override is on with no group restriction: anyone can request this entitlement, even if the app restricts requesters.

time_based_access_override

TimeBasedAccessOverride · object | null

This entitlement's own time-based access options. Null means this entitlement inherits the app's time-based access options.

Show child attributes

request_validation_webhook_uuid

string | null

UUID of the inline webhook called to validate access requests for this entitlement. null means no webhook is set on this entitlement. Nothing is inherited from the app.

Quick Start

Lumos API

API Reference

Guides

Migrate from v0

Lumos Connectors

Webhooks

Tools

Update Entitlement AppStore Settings

Authorizations

Path Parameters

Body

Response