ApiTokenPolicyFamilyDto
ApiTokenPolicyFamilyDto
One route family and its current mode
JSON Example
{
"key": "string",
"label": "string",
"description": "string",
"mode": "string",
"defaultMode": "string",
"allowedModes": [
"string"
],
"sensitive": false,
"routes": [
"string"
]
}
string
key
Required
Stable family key, for example groups or vcenter-connections
string
label
Required
Display name
string
description
Required
What the family covers
mode
Required
What a bearer token may do on one route family.
OFF: The family is denied to every tokenREAD: A token may read the family (GET and HEAD)READ_WRITE: A token may also write the family, only with Full access and within its owner's role
Enumeration:
OFF,
READ,
READ_WRITE
defaultMode
Required
What a bearer token may do on one route family.
OFF: The family is denied to every tokenREAD: A token may read the family (GET and HEAD)READ_WRITE: A token may also write the family, only with Full access and within its owner's role
Enumeration:
OFF,
READ,
READ_WRITE
boolean
sensitive
Required
True when enabling the family exposes credentials, host registration or configuration
array of
string
routes
Required
Path patterns the family covers