Skip to Content
veriom

Update access policy

Replace the access policy; an allowlist that excludes the caller needs confirmation.

PUT
/v1/workspaces/{workspace_id}/access-policy

Replace the access policy; an allowlist that excludes the caller needs confirmation.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
confirm_lockout?Confirm Lockout

Save an allowlist that excludes the caller's own address. Without it the request is refused with 409 ip_allowlist_excludes_caller.

Defaultfalse
expected_version*Expected Version
Range0 <= value
idle_timeout_minutes?integer|null
ip_allowlist?array<string>

IP addresses or CIDR blocks. Entries are normalized and de-duplicated; at most 100 distinct blocks.

Itemsitems <= 200
require_two_factor?Require Two Factor
Defaultfalse

Response Body

Successful Response

application/json
  1. response
client_address*|

The address this request came from, as the API sees it. It is the address the IP allowlist checks; see the trust caveats in the API guide.

client_address_allowed*Client Address Allowed

Whether the saved allowlist admits client_address.

entitlements*
idle_timeout_minutes*|

Minutes a browser session may go without a request before it must sign in again.

idle_timeout_options*array<integer>
ip_allowlist*array<string>

CIDR blocks members may connect from. Empty allows every address.

require_two_factor*Require Two Factor
updated_at*|null
updated_by*|null
version*Version

0 until the policy is first saved.

workspace_id*Workspace Id
Formatuuid
Example Request
curl -X PUT 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/access-policy' \  -H 'Content-Type: application/json' \  -d '{  "expected_version": 0}'
Example Response
{  "client_address": "string",  "client_address_allowed": true,  "entitlements": {    "plan": "trial",    "require_two_factor": true  },  "idle_timeout_minutes": 0,  "idle_timeout_options": [    0  ],  "ip_allowlist": [    "string"  ],  "require_two_factor": true,  "updated_at": "2019-08-24T14:15:22Z",  "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",  "version": 0,  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"}