Skip to main content
PUT
curl

Authorizations

Authorization
string
header
required

Plerion organization API key (plerion_oak_…), created by an organization admin in the Plerion app.

Path Parameters

groupId
string<uuid>
required

The user group id.

Query Parameters

tenantId
string<uuid>
required

The tenant the preference applies in. A PUT checks it belongs to the key's organization and answers 400 TenantNotFound otherwise; a GET or DELETE for a tenant outside the organization finds no row and answers 404 PreferenceNotFound.

Body

application/json
order
enum<string>[]
required

The sidebar arrangement. Entries not listed are appended by the Plerion app in catalog order.

Available options:
home,
alerts,
risks,
findings,
assets,
agent-security,
dspm,
cwpp,
compliance,
ciem,
threat-map,
code-security,
settings,
well-architected,
pinned-custom-reports
Example:
hidden
enum<string>[]
required

Entries from order to tuck away. Must be a subset of order.

Available options:
home,
alerts,
risks,
findings,
assets,
agent-security,
dspm,
cwpp,
compliance,
ciem,
threat-map,
code-security,
settings,
well-architected,
pinned-custom-reports
Example:

Response

The stored preference, after normalisation.

data
object