403 Forbidden

Not allowed

Code: forbidden
Status: 403 Forbidden
Type: https://errors.clavian.io/forbidden

What it means

The caller is signed in, but its role does not give it the permission this action needs at this scope: the Platform, an organisation or a venue.

What to do

Do not retry, because the answer changes only when the role does. Say the action is not allowed, and hide it where the client reads the caller’s permissions from GET /v1/me/access.

Example

The API answers with status 403 and this body, as application/problem+json. A detail may be added, saying what went wrong this time; it is for people, and changes.

{
  "type": "https://errors.clavian.io/forbidden",
  "title": "Not allowed",
  "status": 403,
  "code": "forbidden",
  "requestId": "req_01k5znw4hmfay8vvr14d2pf2db"
}

Endpoints that return it

74 endpoints in the OpenAPI document name it among their answers.

All 74 endpoints

GET /v1/files/{fileId}Fetch a private file through its signed URL
GET /v1/hq/auditThe platform audit log
POST /v1/hq/audit/exportExport the platform audit log as CSV
GET /v1/hq/brandRead the brand configuration, as HQ edits it
PUT /v1/hq/brandChange the brand values HQ sets
GET /v1/hq/organizationsEvery organisation on the Platform, newest first
POST /v1/hq/organizationsCreate an organisation, and invite its owner
GET /v1/hq/organizations/{organizationId}Read one organisation’s record
POST /v1/hq/organizations/{organizationId}/owner-invitationsInvite an owner to an organisation that has none
GET /v1/hq/organizations/{organizationId}/settingsRead one organisation’s settings, as HQ
PUT /v1/hq/organizations/{organizationId}/settingsSet, lock or unlock an organisation’s settings, as HQ
PATCH /v1/hq/organizations/{organizationId}/venues/{venueId}/listingSet a venue’s discovery flags
GET /v1/hq/playersSearch every player on the Platform
GET /v1/hq/players/{playerId}One player’s platform record
POST /v1/hq/players/{playerId}/banBan a person from the Platform
POST /v1/hq/players/{playerId}/unbanLift a person’s platform ban
GET /v1/hq/settingsRead the platform defaults and locks
PUT /v1/hq/settingsChange platform defaults and locks
GET /v1/hq/venuesEvery venue on the Platform
GET /v1/organizations/{organizationId}/auditThe organisation’s audit log
POST /v1/organizations/{organizationId}/audit/exportExport the organisation’s audit log as CSV
POST /v1/organizations/{organizationId}/filesStart an upload
GET /v1/organizations/{organizationId}/files/{fileId}Read a file
POST /v1/organizations/{organizationId}/files/{fileId}/completeFinish an upload
GET /v1/organizations/{organizationId}/invitationsInvitations sent, newest first
POST /v1/organizations/{organizationId}/invitationsInvite someone to the staff, by phone or by email
DELETE /v1/organizations/{organizationId}/invitations/{invitationId}Withdraw an invitation
GET /v1/organizations/{organizationId}/membersThe organisation’s staff
POST /v1/organizations/{organizationId}/members/shared-deviceTurn this device into a shared counter device
GET /v1/organizations/{organizationId}/members/{memberId}One member of the staff
DELETE /v1/organizations/{organizationId}/members/{memberId}Take someone off the staff
DELETE /v1/organizations/{organizationId}/members/{memberId}/pinReset a member’s staff PIN at a venue
PUT /v1/organizations/{organizationId}/members/{memberId}/roleGive a member a different role
PUT /v1/organizations/{organizationId}/members/{memberId}/statusSuspend a member, or reinstate one
PUT /v1/organizations/{organizationId}/members/{memberId}/venuesChange which venues a member works at
GET /v1/organizations/{organizationId}/playersSearch the organisation’s players
GET /v1/organizations/{organizationId}/players/{playerId}One player, as this organisation sees them
PATCH /v1/organizations/{organizationId}/players/{playerId}Add, edit or remove notes and tags
POST /v1/organizations/{organizationId}/players/{playerId}/banBan a player from every venue of the organisation
GET /v1/organizations/{organizationId}/players/{playerId}/bansA player’s bans in this organisation, reasons included
GET /v1/organizations/{organizationId}/players/{playerId}/id-checksA player’s ID checks at this organisation
POST /v1/organizations/{organizationId}/players/{playerId}/id-checksRecord a staff document ID check
GET /v1/organizations/{organizationId}/players/{playerId}/id-checks/{idCheckId}/photoView an ID check’s photo
GET /v1/organizations/{organizationId}/players/{playerId}/ordersThe player’s orders here
GET /v1/organizations/{organizationId}/players/{playerId}/passesThe player’s passes here
GET /v1/organizations/{organizationId}/players/{playerId}/pointsThe points the player earned here
GET /v1/organizations/{organizationId}/players/{playerId}/sessionsThe player’s sessions here
POST /v1/organizations/{organizationId}/players/{playerId}/unbanLift a player’s organisation ban
GET /v1/organizations/{organizationId}/players/{playerId}/walletThe player’s wallet statement here
GET /v1/organizations/{organizationId}/rolesEvery role: the built-in ones and the custom ones
POST /v1/organizations/{organizationId}/rolesMake a custom role
GET /v1/organizations/{organizationId}/roles/{role}One role: its permissions and its limits
PUT /v1/organizations/{organizationId}/roles/{role}Change a custom role’s permissions
DELETE /v1/organizations/{organizationId}/roles/{role}Delete a custom role
PUT /v1/organizations/{organizationId}/roles/{role}/limitsSet the limits a role carries
GET /v1/organizations/{organizationId}/settingsRead the organisation’s settings screen
PUT /v1/organizations/{organizationId}/settingsChange the organisation’s settings
GET /v1/organizations/{organizationId}/venuesList the organisation's venues
POST /v1/organizations/{organizationId}/venuesCreate a venue
GET /v1/organizations/{organizationId}/venues/{venueId}Read a venue
PATCH /v1/organizations/{organizationId}/venues/{venueId}Edit a venue
POST /v1/organizations/{organizationId}/venues/{venueId}/archiveClose a venue for good
GET /v1/organizations/{organizationId}/venues/{venueId}/floor-planRead one floor’s plan
PUT /v1/organizations/{organizationId}/venues/{venueId}/floor-planSave one floor’s plan
POST /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/banBan a player from one venue
POST /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/unbanLift a player’s ban at one venue
GET /v1/organizations/{organizationId}/venues/{venueId}/settingsRead a venue’s settings screen
PUT /v1/organizations/{organizationId}/venues/{venueId}/settingsChange a venue’s settings
GET /v1/organizations/{organizationId}/venues/{venueId}/station-classesList a venue's station classes
POST /v1/organizations/{organizationId}/venues/{venueId}/station-classesCreate a station class
PATCH /v1/organizations/{organizationId}/venues/{venueId}/station-classes/{classId}Edit a station class
GET /v1/organizations/{organizationId}/venues/{venueId}/zonesList a venue's zones
POST /v1/organizations/{organizationId}/venues/{venueId}/zonesCreate a zone
PATCH /v1/organizations/{organizationId}/venues/{venueId}/zones/{zoneId}Rename or recolour a zone