This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.
Every answer is checked against the model shown here before it is sent, and no answer carries a member its model does not list. A member shown as any JSON is one whose shape belongs to somebody else, and says whose. .{key} is a key that is data, and [] an element of a list.
A refusal
Unless an operation below says otherwise, any status it does not list answers this:
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | ||
status |
integer | ||
why |
string |
GET /admin-api/xacml
getXacml
The Policy Decision Point settings and current status
The Settings tab on /admin/xacml, as JSON.
THIS IS THE ONLY FAMILY ON THIS SERVICE THAT ANSWERS A QUESTION ABOUT SOMEBODY ELSE’S BOUNDARY. Every other protocol here authenticates or provisions a person; this one is handed a subject who was authenticated somewhere else and asked whether they may.
Mirrors GET /admin/xacml on the admin console.
The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The PDP, its repository and its PIP.
| Member | Type | Required | What it is |
|---|---|---|---|
enabled |
boolean | ||
enabledPolicies |
integer | ||
message |
string | ||
pipAvailable |
boolean | ||
policies |
integer | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list, or string | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
root |
string, or null | ||
settings |
object | ||
settings.context |
object | ||
settings.context.configFile |
string, or null | ||
settings.context.defaultsFile |
string, or null | ||
settings.context.inRealm |
boolean | ||
settings.context.persistenceMode |
string | ||
settings.context.persistsAppconfig |
boolean | ||
settings.context.persistsRealms |
boolean | ||
settings.context.realmId |
string | ||
settings.editableCount |
integer | ||
settings.groups |
list | ||
settings.groups[].group |
string | ||
settings.groups[].settings |
list | ||
settings.groups[].settings[].appconfigPath |
string | ||
settings.groups[].settings[].csvValueNotes |
map | ||
settings.groups[].settings[].csvValueNotes.{key} |
string | ||
settings.groups[].settings[].csvValues |
list | ||
settings.groups[].settings[].csvValues[] |
string | ||
settings.groups[].settings[].default |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].default[] |
string, or number, or boolean, or null | ||
settings.groups[].settings[].description |
string | ||
settings.groups[].settings[].editRefusal |
string, or null | ||
settings.groups[].settings[].editable |
boolean | ||
settings.groups[].settings[].enumValues |
list | ||
settings.groups[].settings[].enumValues[] |
string | ||
settings.groups[].settings[].env |
list, or string, or null | ||
settings.groups[].settings[].env[] |
string | ||
settings.groups[].settings[].group |
string | ||
settings.groups[].settings[].key |
string | ||
settings.groups[].settings[].label |
string | ||
settings.groups[].settings[].legacyEnv |
list, or string, or null | ||
settings.groups[].settings[].legacyEnv[] |
string | ||
settings.groups[].settings[].masked |
boolean | ||
settings.groups[].settings[].max |
number | ||
settings.groups[].settings[].min |
number | ||
settings.groups[].settings[].ordered |
boolean | ||
settings.groups[].settings[].overridden |
boolean | ||
settings.groups[].settings[].realmSettable |
boolean | ||
settings.groups[].settings[].restartReason |
string, or null | ||
settings.groups[].settings[].selectAll |
object | ||
settings.groups[].settings[].selectAll.aloneWhileOn |
list | ||
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn |
list | ||
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].source |
string | ||
settings.groups[].settings[].step |
number | ||
settings.groups[].settings[].text |
string, or number, or boolean, or null | ||
settings.groups[].settings[].type |
string | ||
settings.groups[].settings[].value |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].value[] |
string, or number, or boolean, or null | ||
settings.overridden |
list | ||
settings.overridden[] |
string | ||
settings.page |
string | ||
settings.setWith |
string | ||
settings.settingCount |
integer | ||
settings.sharedWith |
map | ||
settings.sharedWith.{key} |
list | ||
settings.sharedWith.{key}[].label |
string, or null | ||
settings.sharedWith.{key}[].path |
string | ||
xacml |
boolean |
POST /admin-api/xacml/add-allof
addXacmlAlternative
Add an alternative to a Target clause
ANY of a clause’s alternatives matching satisfies it — they are ORed. Within one alternative every Match must hold.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | The attribute to read. A bare name or the urn:sts:xacml:attribute: prefix reaches the directory through the PIP; anything else must be in the request. |
|
category |
string | The attribute category. Defaults to access-subject. | |
matchId |
string | The match function. Defaults to string-equal. THE DATATYPE FOLLOWS IT on both sides, so choosing the function settles the literal’s type and the designator’s together. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
value |
string | The literal to test against. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-argument
addXacmlArgument
Add an argument to a function call
Offered only on an <Apply> — every other expression is a leaf and may only be REPLACED, which the four set-expression actions already do. The argument arrives as a literal of the type the function expects in that position.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-assignment
addXacmlAssignment
Add an attribute assignment to an obligation or advice
A value handed to the PEP along with the obligation — what to log, whom to notify, which record to stamp. Its expression takes any of the four shapes the set-expression actions produce.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-condition
addXacmlCondition
Add a Condition to a rule
A boolean expression evaluated AFTER the Target matches. At most one per rule — the schema allows exactly one, and the editor stops offering this on a rule that has one rather than offering it and then refusing, because an option that is offered and refused teaches a caller that the menu is not to be trusted.
It must evaluate to EXACTLY ONE BOOLEAN. A condition returning a bag, or an integer, is a static type error and the policy is refused at write time rather than going Indeterminate on every request.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-match
addXacmlMatch
Add a Match to an alternative
One attribute tested against one value. It arrives COMPLETE AND VALID — a function, a literal and a designator — because an editor that produced half-built elements would hold a document that cannot be saved, and a document that cannot be saved cannot be evaluated, which is when you most want to look at it. Use edit-match to change any of the three.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | The attribute to read. A bare name or the urn:sts:xacml:attribute: prefix reaches the directory through the PIP; anything else must be in the request. |
|
category |
string | The attribute category. Defaults to access-subject. | |
matchId |
string | The match function. Defaults to string-equal. THE DATATYPE FOLLOWS IT on both sides, so choosing the function settles the literal’s type and the designator’s together. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
value |
string | The literal to test against. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-policy
addXacmlPolicyToSet
Add a Policy inside a PolicySet
A PolicySet holds POLICIES; a Policy holds RULES. They are not two spellings of one thing, and asking for a rule on a policy set is refused rather than written somewhere it will not be read.
The new policy arrives with deny-unless-permit and no rules, which decides Deny. That is deliberate: this editor is LIVE, so a child added to the running root takes effect on the next request, and one that began permissive would be a hole opened by pressing Add.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-policy-advice
addXacmlPolicyAdvice
Add advice to a policy
On the policy’s decision rather than on one rule’s. See addXacmlRuleAdvice for why advice and an obligation are not the same thing.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
on |
one of Permit, Deny |
Permit or Deny. Defaults to Permit. | |
path |
string | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. | |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-policy-obligation
addXacmlPolicyObligation
Add an obligation to a policy
Fires on the POLICY’s decision rather than on one rule’s. Same binding force — see addXacmlRuleObligation.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
on |
one of Permit, Deny |
Permit or Deny. Defaults to Permit. | |
path |
string | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. | |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-policy-reference
addXacmlPolicyReference
Reference a policy stored separately in the repository
THIS IS HOW A PDP REACHES MORE THAN ONE DOCUMENT. Evaluation starts at the root policy and a PolicyIdReference is resolved against the repository WHEN A DECISION IS MADE, not when the document is loaded — so referencing a policy that has not been written yet is allowed and is not an error. An unresolved reference is reported on the decision instead, which is what keeps the order two policies are authored in from mattering.
The ref is the PolicyId INSIDE the other document, not its directory entry name.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
ref |
string | The PolicyId being referenced. Any URI. | |
version |
string | An optional version constraint. Omit for no constraint. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-policyset
addXacmlPolicySetToSet
Add a nested PolicySet inside a PolicySet
There is no depth limit. It arrives with deny-unless-permit — the POLICY-combining spelling, which is a different URI from the rule-combining one of the same name.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-policyset-reference
addXacmlPolicySetReference
Reference a policy SET stored separately
The same as add-policy-reference, naming a PolicySetId. The element name says which kind of document is being named, so the two are separate actions rather than one with a flag.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
ref |
string | The PolicySetId being referenced. | |
version |
string | An optional version constraint. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-rule
addXacmlRule
Add a rule to a policy
Every element this editor adds arrives COMPLETE AND VALID — a new rule has a Target, an Effect and an id. An editor that produced half-built elements would hold a document that could not be saved, and a document that cannot be saved cannot be evaluated, which is when you most want to look at it.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
effect |
one of Permit, Deny |
Permit or Deny. Defaults to Permit. | |
path |
string | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. | |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-rule-advice
addXacmlRuleAdvice
Add advice to a rule
Something the PEP MAY do. It is allowed to ignore this, and that is the whole difference from an obligation — advice a PEP drops is a PEP behaving correctly, where an obligation it drops is half a policy enforced and reported as success.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
on |
one of Permit, Deny |
Permit or Deny. Defaults to Permit. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-rule-obligation
addXacmlRuleObligation
Add an obligation to a rule
Fires when this RULE’s Effect is the decision. An obligation is the half of a decision that says “yes, AND you must also do this”, and section 7.2 makes it binding: a PEP that cannot discharge one MUST NOT grant the access. The remote PEP container implements that, and /admin/xacml/decide shows it — and it is the part implementations skip.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
on |
one of Permit, Deny |
Permit or Deny — the effect this fires on. Defaults to Permit. An obligation attached to the wrong effect is silently never discharged. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-target-anyof
addXacmlTargetClause
Add a Target clause to a policy, a rule or a Target
A <Target> is a list of clauses and every one of them must match — they are ANDed. Inside a clause the alternatives are ORed and inside an alternative the Matches are ANDed again, so the quantifier flips at each of the three levels.
That is why the element names read backwards from what they do: AnyOf holds AllOf holds Match, and the AnyOfs themselves are ANDed. Getting it wrong produces a policy that applies to more or less than was meant and never an error.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | The attribute to read. A bare name or the urn:sts:xacml:attribute: prefix reaches the directory through the PIP; anything else must be in the request. |
|
category |
string | The attribute category. Defaults to access-subject. | |
matchId |
string | The match function. Defaults to string-equal. THE DATATYPE FOLLOWS IT on both sides, so choosing the function settles the literal’s type and the designator’s together. | |
path |
string | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. | |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
value |
string | The literal to test against. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/add-variable
addXacmlVariable
Add a VariableDefinition to a policy
Names an expression so several rules can share it — and so it is evaluated ONCE per request rather than once per use.
ITS SCOPE IS THE POLICY IT IS ON. A sibling policy in the same set cannot name it (section 5.24), which is why GET /admin-api/xacml/editor is the only reliable source of what a VariableReference at a given path may legally name.
It arrives holding a designator, because a VariableDefinition with no expression is a document that will not load. Replace it with any of the set-expression actions.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
variableId |
string | The name. Defaults to the next free v<n>. A duplicate is refused — the reader rejects a document defining one id twice, so allowing it here would write a policy this service cannot load back. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
GET /admin-api/xacml/authzen
getXacmlAuthzen
The AuthZEN API: its settings, attribute catalogue and callers
Everything the AuthZEN tab on /admin/xacml draws: whether /access/v1 answers in this realm, how its callers authenticate (authzen.callerAuthentication), the AuthZEN settings, the attribute catalogue on the sts-authzen-api object with the vocabulary a row may use, and the members of roles.authzenPepGroup with the applications each may ask about and the access request callback URLs registered for it, and the realm’s AuthZEN access requests (#1180). ?caller=<name or DN> looks one caller up, in the group or not.
Mirrors GET /admin/xacml on the admin console.
The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
caller |
query | string | Looks one caller up by name or DN, in the group or not. | |
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: enabled, callerAuthentication, settings, catalogue (rows, problems, and the choices), callers, looked, accessRequests.
| Member | Type | Required | What it is |
|---|---|---|---|
accessRequests |
object | ||
accessRequests.enabled |
boolean | ||
accessRequests.maxCallbacks |
integer | ||
accessRequests.rows |
list | ||
accessRequests.rows[].action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
accessRequests.rows[].application |
string, or null | ||
accessRequests.rows[].approval |
object | ||
accessRequests.rows[].approval.approvedAt |
number | ||
accessRequests.rows[].approval.approvedUntil |
number | ||
accessRequests.rows[].approval.approver |
string | ||
accessRequests.rows[].approval.id |
string | ||
accessRequests.rows[].approval.revoked |
boolean | ||
accessRequests.rows[].approvers |
object | ||
accessRequests.rows[].approvers.groups |
list | ||
accessRequests.rows[].approvers.groups[] |
string | ||
accessRequests.rows[].approvers.owners |
boolean | ||
accessRequests.rows[].approvers.roles |
list | ||
accessRequests.rows[].approvers.roles[] |
string | ||
accessRequests.rows[].client |
object | ||
accessRequests.rows[].client.id |
string | ||
accessRequests.rows[].client.name |
string | ||
accessRequests.rows[].context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
accessRequests.rows[].createdAt |
number | ||
accessRequests.rows[].decidedBy |
string | ||
accessRequests.rows[].emergency |
boolean | ||
accessRequests.rows[].expiresAt |
number | ||
accessRequests.rows[].finishedAt |
number | ||
accessRequests.rows[].id |
string | ||
accessRequests.rows[].justification |
string | ||
accessRequests.rows[].requester |
string | ||
accessRequests.rows[].resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
accessRequests.rows[].status |
string | ||
accessRequests.rows[].subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
apiObject |
boolean | ||
audience |
list | ||
audience[] |
string | ||
callerAuthentication |
string | ||
callers |
list | ||
callers[].applications |
list | ||
callers[].applications[] |
string | ||
callers[].callbacks |
list | ||
callers[].callbacks[] |
string | ||
callers[].dn |
string | ||
callers[].kind |
string | ||
callers[].member |
boolean | ||
callers[].name |
string | ||
callersTotal |
integer | ||
catalogue |
object | ||
catalogue.categories |
list | ||
catalogue.categories[] |
string | ||
catalogue.dataTypes |
list | ||
catalogue.dataTypes[] |
string | ||
catalogue.multiplicities |
list | ||
catalogue.multiplicities[] |
string | ||
catalogue.objects |
list | ||
catalogue.objects[] |
string | ||
catalogue.problems |
list | ||
catalogue.problems[] |
string | ||
catalogue.reservedContext |
list | ||
catalogue.reservedContext[] |
string | ||
catalogue.reservedPrefix |
string | ||
catalogue.rows |
list | ||
catalogue.rows[].attributeId |
string | ||
catalogue.rows[].category |
string | ||
catalogue.rows[].dataType |
string | ||
catalogue.rows[].description |
string | ||
catalogue.rows[].key |
string | ||
catalogue.rows[].multiplicity |
string | ||
catalogue.rows[].object |
string | ||
catalogue.rows[].property |
string | ||
doors |
list | ||
doors[] |
string | ||
enabled |
boolean | ||
group |
string | ||
looked |
object | ||
looked.applications |
list | ||
looked.applications[] |
string | ||
looked.callbacks |
list | ||
looked.callbacks[] |
string | ||
looked.dn |
string | ||
looked.kind |
string | ||
looked.member |
boolean | ||
looked.name |
string | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list, or string | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
realm |
string | ||
role |
string | ||
scope |
string | ||
settings |
object | ||
settings.context |
object | ||
settings.context.configFile |
string, or null | ||
settings.context.defaultsFile |
string, or null | ||
settings.context.inRealm |
boolean | ||
settings.context.persistenceMode |
string | ||
settings.context.persistsAppconfig |
boolean | ||
settings.context.persistsRealms |
boolean | ||
settings.context.realmId |
string | ||
settings.editableCount |
integer | ||
settings.groups |
list | ||
settings.groups[].group |
string | ||
settings.groups[].settings |
list | ||
settings.groups[].settings[].appconfigPath |
string | ||
settings.groups[].settings[].csvValueNotes |
map | ||
settings.groups[].settings[].csvValueNotes.{key} |
string | ||
settings.groups[].settings[].csvValues |
list | ||
settings.groups[].settings[].csvValues[] |
string | ||
settings.groups[].settings[].default |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].default[] |
string, or number, or boolean, or null | ||
settings.groups[].settings[].description |
string | ||
settings.groups[].settings[].editRefusal |
string, or null | ||
settings.groups[].settings[].editable |
boolean | ||
settings.groups[].settings[].enumValues |
list | ||
settings.groups[].settings[].enumValues[] |
string | ||
settings.groups[].settings[].env |
list, or string, or null | ||
settings.groups[].settings[].env[] |
string | ||
settings.groups[].settings[].group |
string | ||
settings.groups[].settings[].key |
string | ||
settings.groups[].settings[].label |
string | ||
settings.groups[].settings[].legacyEnv |
list, or string, or null | ||
settings.groups[].settings[].legacyEnv[] |
string | ||
settings.groups[].settings[].masked |
boolean | ||
settings.groups[].settings[].max |
number | ||
settings.groups[].settings[].min |
number | ||
settings.groups[].settings[].ordered |
boolean | ||
settings.groups[].settings[].overridden |
boolean | ||
settings.groups[].settings[].realmSettable |
boolean | ||
settings.groups[].settings[].restartReason |
string, or null | ||
settings.groups[].settings[].selectAll |
object | ||
settings.groups[].settings[].selectAll.aloneWhileOn |
list | ||
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn |
list | ||
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].source |
string | ||
settings.groups[].settings[].step |
number | ||
settings.groups[].settings[].text |
string, or number, or boolean, or null | ||
settings.groups[].settings[].type |
string | ||
settings.groups[].settings[].value |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].value[] |
string, or number, or boolean, or null | ||
settings.overridden |
list | ||
settings.overridden[] |
string | ||
settings.page |
string | ||
settings.setWith |
string | ||
settings.settingCount |
integer | ||
settings.sharedWith |
map | ||
settings.sharedWith.{key} |
list | ||
settings.sharedWith.{key}[].label |
string, or null | ||
settings.sharedWith.{key}[].path |
string | ||
xacmlEnabled |
boolean |
POST /admin-api/xacml/authzen/approve-access-request
approveAuthzenAccessRequest
Approve an AuthZEN access request
Approves a pending access request (#1180) as the caller, after the access-control policy (action approve-access-request on resource authzen-access-request) permitted it — refused, among others, for the request’s own subject. The approval is handed to the PEP, whose next evaluation the realm’s policy decides afresh. Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
request |
string | yes | The access request’s id (arq_…). |
200: The access request as it now is.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
POST /admin-api/xacml/authzen/cancel-access-request
cancelAuthzenAccessRequest
Cancel an AuthZEN access request
Cancels a pending access request (#1180) as an administrator; its callback, if it asked for one, is sent. Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
request |
string | yes | The access request’s id (arq_…). |
200: The access request as it now is.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
POST /admin-api/xacml/authzen/deny-access-request
denyAuthzenAccessRequest
Deny an AuthZEN access request
Denies a pending access request (#1180) as the caller, asked of the access-control policy as an approval is. Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
request |
string | yes | The access request’s id (arq_…). |
200: The access request as it now is.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
POST /admin-api/xacml/authzen/remove-attribute
removeAuthzenAttribute
Remove one row of the AuthZEN attribute catalogue
Takes the row for an object and property off. A request carrying that property is refused from then on, as an undeclared property is. Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
object |
one of subject, resource, action, context |
yes | The AuthZEN object the property is on. |
property |
string | yes | The property’s name, or a dotted path into a nested object (owner.country). For context, the member’s name; context.application is reserved. |
200: What was removed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
string | ||
replaced |
boolean | ||
row |
object | ||
row.attributeId |
string | ||
row.category |
string | ||
row.dataType |
string | ||
row.description |
string | ||
row.key |
string | ||
row.multiplicity |
string | ||
row.object |
string | ||
row.property |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
string | ||
replaced |
boolean | ||
row |
object | ||
row.attributeId |
string | ||
row.category |
string | ||
row.dataType |
string | ||
row.description |
string | ||
row.key |
string | ||
row.multiplicity |
string | ||
row.object |
string | ||
row.property |
string |
POST /admin-api/xacml/authzen/revoke-access-request
revokeAuthzenAccessRequest
Revoke an AuthZEN access request’s approval
Revokes the approval of an approved access request (#1180), asked of the access-control policy as an approval is: a re-evaluation carrying it is not approved from then on (approval_expired). Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
request |
string | yes | The access request’s id (arq_…). |
200: The access request as it now is.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
task |
object | ||
task.action |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.application |
string, or null | ||
task.approval |
object | ||
task.approval.approvedAt |
number | ||
task.approval.approvedUntil |
number | ||
task.approval.approver |
string | ||
task.approval.id |
string | ||
task.approval.revoked |
boolean | ||
task.approvers |
object | ||
task.approvers.groups |
list | ||
task.approvers.groups[] |
string | ||
task.approvers.owners |
boolean | ||
task.approvers.roles |
list | ||
task.approvers.roles[] |
string | ||
task.client |
object | ||
task.client.id |
string | ||
task.client.name |
string | ||
task.context |
any JSON | The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. The members of the caller’s AuthZEN context that the policy’s advice named, each as the request carried it: a policy names them and a caller fills them, so neither key nor value is this service’s vocabulary. | |
task.createdAt |
number | ||
task.decidedBy |
string | ||
task.emergency |
boolean | ||
task.expiresAt |
number | ||
task.finishedAt |
number | ||
task.id |
string | ||
task.justification |
string | ||
task.requester |
string | ||
task.resource |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. | |
task.status |
string | ||
task.subject |
any JSON | What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. What the AuthZEN caller sent at the denial, bound and relayed: the subject, resource and action objects carry properties of the caller’s own naming, and this service states only that it kept them. |
POST /admin-api/xacml/authzen/set-attribute
setAuthzenAttribute
Add or replace one row of the AuthZEN attribute catalogue
Writes one authzenAttribute value on the realm’s sts-authzen-api object, replacing the row for the same object and property. Refused for a row the catalogue’s grammar refuses (STS-AUTHZEN-0010) and for one mapping onto a reserved identifier (STS-AUTHZEN-0011, 0012): a request-supplied attribute suppresses the PIP. Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | yes | The XACML attribute it is sent as. Never urn:sts:xacml:*, subject-id, resource-id or action-id, nor a bare directory name in a subject category. |
category |
string | access-subject, resource, action, environment (or another XACML category, or its URI); the object’s own when empty. | |
dataType |
string | string, boolean, integer, double, date, dateTime, time, anyURI, dayTimeDuration, yearMonthDuration, hexBinary, base64Binary, rfc822Name, x500Name, dnsName, ipAddress, or the type’s URI; string when empty. | |
description |
string | Free text for administrators. | |
multiplicity |
one of single, bag |
single (one value) or bag (a JSON array); single when left out. | |
object |
one of subject, resource, action, context |
yes | The AuthZEN object the property is on. |
property |
string | yes | The property’s name, or a dotted path into a nested object (owner.country). For context, the member’s name; context.application is reserved. |
200: The row as stored.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
string | ||
replaced |
boolean | ||
row |
object | ||
row.attributeId |
string | ||
row.category |
string | ||
row.dataType |
string | ||
row.description |
string | ||
row.key |
string | ||
row.multiplicity |
string | ||
row.object |
string | ||
row.property |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
string | ||
replaced |
boolean | ||
row |
object | ||
row.attributeId |
string | ||
row.category |
string | ||
row.dataType |
string | ||
row.description |
string | ||
row.key |
string | ||
row.multiplicity |
string | ||
row.object |
string | ||
row.property |
string |
POST /admin-api/xacml/authzen/set-callbacks
setAuthzenCallbacks
Set the access request callback URLs of an AuthZEN caller
Replaces the callback URLs registered for a caller (#1180): stsAuthzenCallbackUri on a person’s or service account’s entry, appAuthzenCallbackUri on an application. An access request’s callback.endpoint must be one of them exactly; this service never dials a callback URL taken from a request alone. https only, at most eight. Empty clears them. Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
callbacks |
list, or string | ||
callbacks[] |
string | ||
caller |
string | yes | A username, an application identifier, or a DN. |
200: The caller and its callbacks as they now are.
| Member | Type | Required | What it is |
|---|---|---|---|
caller |
object | ||
caller.applications |
list | ||
caller.applications[] |
string | ||
caller.callbacks |
list | ||
caller.callbacks[] |
string | ||
caller.dn |
string | ||
caller.kind |
string | ||
caller.member |
boolean | ||
caller.name |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
caller |
object | ||
caller.applications |
list | ||
caller.applications[] |
string | ||
caller.callbacks |
list | ||
caller.callbacks[] |
string | ||
caller.dn |
string | ||
caller.kind |
string | ||
caller.member |
boolean | ||
caller.name |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/xacml/authzen/set-scope
setAuthzenScope
Set the applications an AuthZEN caller may ask about
Replaces a caller’s application scope: stsAuthzenApplication on a person’s or service account’s entry, appAuthzenApplication on an application. Empty clears it. Set by an administrator only; a caller never sets its own. Audited.
Mirrors POST /admin/xacml#xacml-tab-authzen on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
applications |
list, or string | ||
applications[] |
string | ||
caller |
string | yes | A username, an application identifier, or a DN. |
200: The caller and its scope as it now is.
| Member | Type | Required | What it is |
|---|---|---|---|
caller |
object | ||
caller.applications |
list | ||
caller.applications[] |
string | ||
caller.callbacks |
list | ||
caller.callbacks[] |
string | ||
caller.dn |
string | ||
caller.kind |
string | ||
caller.member |
boolean | ||
caller.name |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
caller |
object | ||
caller.applications |
list | ||
caller.applications[] |
string | ||
caller.callbacks |
list | ||
caller.callbacks[] |
string | ||
caller.dn |
string | ||
caller.kind |
string | ||
caller.member |
boolean | ||
caller.name |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/xacml/create-from-template
createXacmlPolicy
Create a policy from a template
A template is a working, valid, evaluable policy in a shape people actually write — the first twenty clicks of the editor already made. template names one (see GET /admin-api/xacml/policies), name names the directory entry, and each parameter is sent as p_<name>; anything omitted takes the template’s own default, so a call with only template produces the documented example.
blank is the one template that is not an example: it builds an EMPTY Policy, or an empty PolicySet with p_kind=policyset — which is the only way to create one of those without ALFA. An empty deny-unless-permit document DENIES rather than answering NotApplicable, so build it before making it the root.
A template BUILDS THE MODEL and the writer serializes it, rather than substituting into XML text — so a role called a"b cannot produce a document that will not parse.
The FIRST policy in an empty repository becomes the root, because a repository with a policy and no root decides nothing.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | Names the DIRECTORY ENTRY. The PolicyId inside the document is a separate identifier and may be any URI. | |
template |
string | yes | Which template. GET /admin-api/xacml/policies lists them with the parameters each takes. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
GET /admin-api/xacml/decide
getXacmlDecision
Ask the PDP about somebody and see the decision, which policies applied, and what the embedded PEP would do with it
Everything the Try a decision tab on /admin/xacml draws. subject, action and resource are query parameters; with none of them it answers asked: false rather than deciding about nobody.
THE DECISION AND THE ENFORCEMENT ARE TWO DIFFERENT ANSWERS and both are here, which is the whole point of the page: the PDP says Permit, Deny, NotApplicable or Indeterminate, and the PEP then applies its bias and the obligation rule to get to allowed or refused. When a policy “is not working” it is nearly always because only one of those was being looked at.
This is NOT POST /xacml/pdp. That endpoint takes a JSON Profile request and is what a PEP calls; this builds a three-category request out of three parameters and is what a person asks.
Mirrors GET /admin/xacml on the admin console.
The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
subject |
query | string | Who the decision is asked about. | |
action |
query | string | What they would do. | |
resource |
query | string | What they would do it to. | |
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The decision, what applied, and what the embedded PEP would do.
| Member | Type | Required | What it is |
|---|---|---|---|
action |
string | ||
advice |
list | ||
advice[] |
string | ||
applicablePolicies |
list | ||
applicablePolicies[] |
object, or string | ||
applicablePolicies[].id |
string | ||
applicablePolicies[].kind |
string | ||
applicablePolicies[].version |
string | ||
asked |
boolean | ||
decision |
string | ||
enforcement |
object | ||
enforcement.allowed |
boolean | ||
enforcement.bias |
string | ||
enforcement.why |
string, or null | ||
enforcements |
list | ||
enforcements[].allowed |
boolean | ||
enforcements[].bias |
string | ||
enforcements[].why |
string, or null | ||
message |
string | ||
obligations |
list | ||
obligations[] |
string | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list, or string | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
resource |
string, or null | ||
status |
object | ||
status.code |
string | ||
status.detail |
object | ||
status.detail.attributeId |
string | ||
status.detail.category |
string | ||
status.detail.dataType |
string | ||
status.detail.errors |
list | ||
status.detail.errors[] |
string | ||
status.detail.lexical |
string | ||
status.detail.problems |
list | ||
status.detail.problems[] |
string | ||
status.detail.type |
string | ||
status.message |
string, or null | ||
subject |
string | ||
xacml |
boolean |
POST /admin-api/xacml/delete
deleteXacmlPolicy
Remove a policy from the repository
Deleting the ROOT leaves the repository deciding nothing, and the reply says so rather than letting it be discovered by a Deny.
AN APPLICATION’S FINE-GRAINED POLICY (#564) is deleted only when no application names it in appFgaPolicy — an orphan of a deleted application (applicationPolicies on GET /admin-api/xacml/policies marks which). The one an application still names is refused (STS-FGA-0022); reset it with POST /admin-api/applications/fga-reset-policy instead.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | yes | The policy’s directory entry name. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/disable
disableXacmlPolicy
Take a policy out of the decision without deleting it
The point of having this separate from delete: a disabled policy is still there to be read, edited and put back, which is what you want while working on it — the editor is LIVE, so a policy being edited is a policy the PDP is deciding with unless it is off.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | yes | The policy’s directory entry name. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/disable-pep
disableXacmlPep
Stop nudging a registered remote PEP
IT DOES NOT STOP IT ENFORCING, and the reply says so rather than letting that be discovered. A remote PEP holds its own copy of the engine and its own copy of the policy; nothing in this API reaches into another process. What changes is that this service no longer dials it when the repository changes, so it converges only on its own polling interval.
Named with a -pep suffix rather than reusing disable because this endpoint dispatches on the action name across the whole family, and a second disable would be ambiguous between a policy and a PEP.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | yes | The registered PEP’s name. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-apply
editXacmlApply
Change which function a call applies
THE ARGUMENTS ARE RESHAPED TO THE NEW SIGNATURE. A function taking two strings changed for one taking two integers cannot keep its arguments, and leaving them would hold a document that does not typecheck and therefore cannot be saved.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
functionId |
string | The function to apply instead. The arguments are reshaped to the new signature. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-assignment
editXacmlAssignment
Change an attribute assignment’s id, category or issuer
The three attributes of an AttributeAssignmentExpression. Its VALUE is the expression underneath it, edited with the set-expression and edit-value actions at the ...assignments.<n>.expression path.
Category and Issuer are OPTIONAL and empty means absent, not empty: an assignment with no category is a plain named value handed to the PEP.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | The name the PEP receives it under. | |
category |
string | An optional category. Empty removes it. | |
issuer |
string | An optional issuer. Empty removes it. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-designator
editXacmlDesignator
Change an attribute reference
Its category, attribute id, datatype and MustBePresent. MustBePresent is the one that surprises people: with it false an absent attribute is an empty bag, and with it true the whole expression is Indeterminate — which the combining algorithms then treat quite differently from a Deny.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | A new attribute id. | |
category |
string | A new category. | |
dataType |
string | A new datatype URI. | |
mustBePresent |
boolean | False makes an absent attribute an empty bag; true makes the whole expression Indeterminate, which the combining algorithms treat quite differently from a Deny. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-function
editXacmlFunctionReference
Change which function a Function reference names
The whole content of the element is which function it names, so this is its only field.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
functionId |
string | Any identifier in the function library. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-match
editXacmlMatch
Change a Match’s function, value or attribute
THE DATATYPE FOLLOWS THE FUNCTION. A Match whose literal is a string and whose designator is an integer does not type-check, so choosing the function sets both sides rather than letting them be picked independently and refused later.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | The attribute to read. A bare name or the urn:sts:xacml:attribute: prefix reaches the directory through the PIP; anything else must be in the request. |
|
category |
string | The attribute category. Defaults to access-subject. | |
contextSelectorId |
string | A selector’s ContextSelectorId. | |
issuer |
string | A designator’s Issuer; empty clears it. | |
matchId |
string | The match function. Defaults to string-equal. THE DATATYPE FOLLOWS IT on both sides, so choosing the function settles the literal’s type and the designator’s together. | |
mustBePresent |
boolean | Whether an absent attribute is an empty bag (false) or makes the whole expression Indeterminate (true). | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
referenceKind |
one of designator, selector |
Whether the Match names its attribute by an AttributeDesignator (the default) or reads it with an AttributeSelector’s XPath path. |
|
value |
string | The literal to test against. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-obligation
editXacmlObligation
Change an obligation’s or advice’s id, or when it fires
The FULFILL-ON is the consequential field: an obligation set to fire on Permit contributes nothing to a Deny, and one attached to the wrong effect is silently never discharged.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
id |
string | A new obligation or advice identifier. | |
on |
one of Permit, Deny |
Permit or Deny — the effect it fires on. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-policy
editXacmlPolicy
Change a policy’s id, description or combining algorithm
The combining algorithm is the single most consequential line in a policy, which is why it is here rather than only in the document.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
combiningAlgId |
string | One of the rule-combining algorithms this editor offers; anything else is refused rather than written. THE SINGLE MOST CONSEQUENTIAL LINE IN A POLICY. | |
description |
string | The document’s own <Description>. | |
id |
string | A new PolicySetId or PolicyId. Any URI. | |
maxDelegationDepth |
string | The document’s <MaxDelegationDepth>: a non-negative integer, or empty for none. | |
path |
string | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. | |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
version |
string | The document’s Version: dot-separated numbers, “1” or “1.0”. Empty leaves it as it is. | |
xpathVersion |
string | The document’s <XPathVersion> in its defaults, a URI; empty removes it. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-reference
editXacmlReference
Change what a policy reference names
An empty version means NO version constraint, which is a different document from one naming a version — so it is written as absent rather than as an empty string.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
ref |
string | The PolicyId or PolicySetId to name. | |
version |
string | A version constraint, or empty for none. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-rule
editXacmlRule
Change a rule’s id, effect or description
The EFFECT is the consequential one: it is what this rule contributes to the combining algorithm when its Target and Condition hold, and flipping it between Permit and Deny changes what the policy decides without changing anything a reader is looking at.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
description |
string | The rule’s own description. | |
effect |
one of Permit, Deny |
Permit or Deny. | |
id |
string | A new RuleId. | |
path |
string | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. | |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-selector
editXacmlSelector
Change an AttributeSelector’s path, category or bindings
ONE NAMESPACE BINDING AT A TIME, because the console this mirrors has no JavaScript and cannot grow a row: send namespacePrefix with namespaceUri to add or change one, and namespacePrefix with an empty namespaceUri to remove it.
ContextSelectorId names an attribute holding the node the path starts from; absent means the whole content.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
category |
string | The category whose content is selected. | |
contextSelectorId |
string | An attribute naming the starting node, or empty for the whole content. | |
dataType |
string | The datatype of the bag it returns. | |
mustBePresent |
string | “true” or “false”. Absent KEEPS the current value rather than clearing it. | |
namespacePrefix |
string | A prefix to bind, rebind or remove. | |
namespaceUri |
string | What to bind it to. Empty removes it. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
path_xpath |
string | Sent as path collides with the node address; this operation reads the XPath from path ONLY when it is not the address — see the console form, which posts them separately. |
|
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-value
editXacmlValue
Change a literal’s datatype or lexical form
The lexical form is parsed against the datatype, so a value that is not of its type is refused here rather than at decision time.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
lexical |
string | A new lexical form, parsed against that datatype. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
type |
string | A new datatype URI. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/edit-variable
renameXacmlVariable
Rename a variable, and every reference with it
EVERY VariableReference NAMING IT IS REWRITTEN. The alternative — refusing to rename one that is used — is safe and useless, since a variable nobody references is the only one nobody wants to rename; and a rename that left the references behind would produce a document that does not load, so the write would be refused and nothing would change. The reply says how many references moved.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
variableId |
string | The new name. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
GET /admin-api/xacml/editor
getXacmlEditor
One policy as an editable tree, with what may legally be added at each node
Everything the Policy editor tab on /admin/xacml draws. ?policy=<name> chooses one; without it, the root.
Each node in tree carries options.additions — the elements XACML allows AT THAT POINT, computed against the real function library by the same code that validates the result. That is what makes this usable as an API and not only as a page: a caller can walk the tree, read the legal moves, and POST one, without a second copy of the grammar.
Mirrors GET /admin/xacml on the admin console.
The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
policy |
query | string | The name of one policy. Without it, the root. | |
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The policy as a tree of editable nodes, with the stored XML and the same policy rendered as ALFA.
| Member | Type | Required | What it is |
|---|---|---|---|
alfa |
string, or null | ||
document |
string | ||
menus |
object | ||
menus.categories |
list | ||
menus.categories[].label |
string | ||
menus.categories[].value |
string | ||
menus.functions |
list | ||
menus.functions[].label |
string | ||
menus.functions[].value |
string | ||
menus.matchFunctions |
list | ||
menus.matchFunctions[].label |
string | ||
menus.matchFunctions[].value |
string | ||
menus.resourceCategory |
string | ||
menus.types |
list | ||
menus.types[].label |
string | ||
menus.types[].value |
string | ||
menus.xpathType |
string | ||
message |
string | ||
policies |
list | ||
policies[] |
string | ||
policy |
object | ||
policy.combiningAlgId |
string, or null | ||
policy.description |
string, or null | ||
policy.enabled |
boolean | ||
policy.isRoot |
boolean | ||
policy.kind |
string, or null | ||
policy.name |
string | ||
policy.policyId |
string, or null | ||
policy.version |
string, or null | ||
problem |
string, or null | ||
problems |
list | ||
problems[] |
string, or null | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list, or string | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
serviceOwn |
list | ||
serviceOwn[].asked |
string | ||
serviceOwn[].builtIn |
boolean | ||
serviceOwn[].decides |
string | ||
serviceOwn[].effect |
string | ||
serviceOwn[].enabled |
boolean, or null | ||
serviceOwn[].entry |
boolean | ||
serviceOwn[].key |
string | ||
serviceOwn[].label |
string | ||
serviceOwn[].name |
string | ||
serviceOwn[].ok |
boolean | ||
serviceOwn[].readsRisk |
boolean | ||
serviceOwn[].remote |
boolean | ||
serviceOwn[].setting |
string | ||
serviceOwn[].template |
string | ||
serviceOwn[].why |
string | ||
tree |
list | ||
tree[].depth |
integer | ||
tree[].detail |
string | ||
tree[].edit |
object | ||
tree[].edit.algorithms |
list | ||
tree[].edit.algorithms[].label |
string | ||
tree[].edit.algorithms[].uri |
string | ||
tree[].edit.algorithms[].what |
string | ||
tree[].edit.node |
object | ||
tree[].edit.node.attributeId |
string | ||
tree[].edit.node.category |
string, or null | ||
tree[].edit.node.combiningAlgId |
string | ||
tree[].edit.node.condition |
null | ||
tree[].edit.node.contextSelectorId |
string, or null | ||
tree[].edit.node.dataType |
string | ||
tree[].edit.node.description |
string, or null | ||
tree[].edit.node.effect |
string | ||
tree[].edit.node.functionId |
string | ||
tree[].edit.node.id |
string | ||
tree[].edit.node.issuer |
string, or null | ||
tree[].edit.node.kind |
string | ||
tree[].edit.node.lexical |
string | ||
tree[].edit.node.matchId |
string | ||
tree[].edit.node.maxDelegationDepth |
string, or number, or null | ||
tree[].edit.node.mustBePresent |
boolean | ||
tree[].edit.node.name |
string | ||
tree[].edit.node.namespaces |
map | ||
tree[].edit.node.namespaces.{key} |
string, or null | ||
tree[].edit.node.on |
string | ||
tree[].edit.node.path |
string | ||
tree[].edit.node.ref |
string | ||
tree[].edit.node.reference |
object | ||
tree[].edit.node.reference.attributeId |
string | ||
tree[].edit.node.reference.category |
string, or null | ||
tree[].edit.node.reference.contextSelectorId |
string, or null | ||
tree[].edit.node.reference.dataType |
string | ||
tree[].edit.node.reference.description |
string, or null | ||
tree[].edit.node.reference.functionId |
string | ||
tree[].edit.node.reference.issuer |
string, or null | ||
tree[].edit.node.reference.kind |
string | ||
tree[].edit.node.reference.lexical |
string | ||
tree[].edit.node.reference.mustBePresent |
boolean | ||
tree[].edit.node.reference.namespaces |
map | ||
tree[].edit.node.reference.namespaces.{key} |
string, or null | ||
tree[].edit.node.reference.path |
string | ||
tree[].edit.node.reference.type |
string | ||
tree[].edit.node.reference.variableId |
string | ||
tree[].edit.node.reference.xpathCategory |
string, or null | ||
tree[].edit.node.target |
null | ||
tree[].edit.node.type |
string | ||
tree[].edit.node.value |
object | ||
tree[].edit.node.value.attributeId |
string | ||
tree[].edit.node.value.category |
string, or null | ||
tree[].edit.node.value.contextSelectorId |
string, or null | ||
tree[].edit.node.value.dataType |
string | ||
tree[].edit.node.value.description |
string, or null | ||
tree[].edit.node.value.functionId |
string | ||
tree[].edit.node.value.issuer |
string, or null | ||
tree[].edit.node.value.kind |
string | ||
tree[].edit.node.value.lexical |
string | ||
tree[].edit.node.value.mustBePresent |
boolean | ||
tree[].edit.node.value.namespaces |
map | ||
tree[].edit.node.value.namespaces.{key} |
string, or null | ||
tree[].edit.node.value.path |
string | ||
tree[].edit.node.value.type |
string | ||
tree[].edit.node.value.variableId |
string | ||
tree[].edit.node.value.xpathCategory |
string, or null | ||
tree[].edit.node.variableId |
string | ||
tree[].edit.node.version |
string, or null | ||
tree[].edit.node.xpathCategory |
string, or null | ||
tree[].edit.node.xpathVersion |
string, or null | ||
tree[].edit.scope |
list | ||
tree[].edit.scope[].detail |
string | ||
tree[].edit.scope[].id |
string | ||
tree[].edit.valueShortType |
string, or null | ||
tree[].kind |
string | ||
tree[].label |
string | ||
tree[].options |
object | ||
tree[].options.additions |
list | ||
tree[].options.additions[].action |
string | ||
tree[].options.additions[].help |
string | ||
tree[].options.additions[].label |
string | ||
tree[].options.kind |
string | ||
tree[].options.removable |
boolean | ||
tree[].path |
string | ||
xacml |
boolean | ||
xpathVersionGaps |
list | ||
xpathVersionGaps[] |
string, or null |
POST /admin-api/xacml/enable
enableXacmlPolicy
Put a policy back into the decision
Sets xacmlEnabled on its directory entry.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | yes | The policy’s directory entry name. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/enable-pep
enableXacmlPep
Nudge a registered remote PEP again
Puts it back into the set this service dials when the repository changes. A PEP that re-registers does NOT clear this by itself — a component an administrator stopped nudging must not be able to undo that by reconnecting.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | yes | The registered PEP’s name, which is the one its client certificate gave it. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/forget-pep
forgetXacmlPep
Remove a remote PEP from the register
Removes the row in ou=peps. THE PROCESS IS UNAFFECTED: it may still be pulling and enforcing, and the next time it registers it simply appears again. Use it for a PEP that is genuinely gone; use disable-pep for one that is not.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | yes | The registered PEP’s name. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/import-alfa
importXacmlAlfa
Create a policy from ALFA
ALFA — the Abbreviated Language For Authorization — is the readable syntax for XACML: forty lines of XML are eight of ALFA. Send it as alfa and a name as name.
IT IS PARSED, CONVERTED AND STORED AS XACML XML. The repository holds ONE representation, because two would be two documents that could disagree — GET /admin-api/xacml/editor renders the ALFA back from the model whenever you want to read it.
EVERY ATTRIBUTE MUST BE DECLARED BEFORE IT IS USED. That is ALFA’s own rule and it is the most useful refusal in the parser: a typo in an attribute name is otherwise a policy that quietly matches nothing, which looks exactly like a policy that is working and denying you.
ALFA IS AN OASIS COMMITTEE SPECIFICATION DRAFT, not a ratified standard — no conformance suite, no schema, no second implementation to disagree with. The contract offered is the one that can be kept: anything this service EMITS as ALFA it reads back, and the policy decides identically either way.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
alfa |
string | yes | The ALFA source. Parsed, converted and stored as XACML XML — the repository holds ONE representation. |
name |
string | yes | Names the directory entry. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/issue-pep-certificate
issueXacmlPepCertificate
Issue a remote PEP the certificate and private key for its HTTPS listener
Generates a key pair and certifies it from the Remote PEP listeners (pep-tls) Issuing CA of THE REALM THE PEP REGISTERED TO — the realm this call is made in, because ou=peps is per realm — so a client that installed this service’s Root CA verifies the PEP, and the chain says which realm vouched for it. A realm whose branch was built before that Issuing CA existed gets it added under its existing Intermediate; nothing already issued is replaced.
The PEP must be REGISTERED: its row is the one record that it exists in this realm. That is not a permission check on the PEP — registering is still not what lets it pull or enforce.
THE CERTIFICATE NAMES the PEP’s registered name (where that is a DNS name) and the host of its notify URL, plus any dnsNames and ipAddresses sent. It certifies serverAuth and nothing else.
THE PRIVATE KEY IS IN THIS REPLY AND NOWHERE ELSE. This service records the certificate — its issuer’s CRL and OCSP responder answer for it — and keeps no copy of the key, so nothing can read it back. To put the pair in the container, write fullChainPem (the leaf followed by its Issuing CA, the realm Intermediate and, since #1064, the service Root) and privateKeyPem to the files PEP_HTTPS_CERT and PEP_HTTPS_KEY name; the PEP picks up a pair written after it started. anchorPem is the service Root a client of that listener installs.
Issuing again REPLACES: the certificate it replaces goes on its issuer’s revocation list as superseded (replacedSerialHex).
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
days |
integer | The lifetime. Defaults to pki.leafLifetimeDays, and is shortened to the Issuing CA’s own expiry. |
|
dnsNames |
list, or string | ||
dnsNames[] |
string | ||
ipAddresses |
list, or string | ||
ipAddresses[] |
string | ||
keyAlg |
one of ec-p256, ec-p384, ec-p521, rsa-2048, rsa-3072, rsa-4096 |
The key algorithm. Defaults to ec-p256. Only the RSA and NIST-curve ECDSA keys a TLS stack serves are offered. |
|
name |
string | yes | The registered PEP’s name, as GET /admin-api/xacml/peps lists it. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
anchorPem |
string | ||
certificatePem |
string | ||
chainPem |
list | ||
chainPem[] |
string | ||
dnsNames |
list | ||
dnsNames[] |
string | ||
errors |
list | ||
errors[] |
string | ||
fullChainPem |
string | ||
ipAddresses |
list | ||
ipAddresses[] |
string | ||
message |
string | ||
notAfter |
string | ||
notBefore |
string | ||
ok |
boolean | yes | |
pep |
string | ||
privateKeyPem |
string | ||
problems |
list | ||
problems[] |
string | ||
realm |
string | ||
replacedSerialHex |
string, or null | ||
serialHex |
string | ||
subject |
string | ||
thumbprint |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
anchorPem |
string | ||
certificatePem |
string | ||
chainPem |
list | ||
chainPem[] |
string | ||
dnsNames |
list | ||
dnsNames[] |
string | ||
errors |
list | ||
errors[] |
string | ||
fullChainPem |
string | ||
ipAddresses |
list | ||
ipAddresses[] |
string | ||
message |
string | ||
notAfter |
string | ||
notBefore |
string | ||
ok |
boolean | yes | |
pep |
string | ||
privateKeyPem |
string | ||
problems |
list | ||
problems[] |
string | ||
realm |
string | ||
replacedSerialHex |
string, or null | ||
serialHex |
string | ||
subject |
string | ||
thumbprint |
string | ||
what |
string | ||
why |
string |
GET /admin-api/xacml/monitor
getXacmlMonitor
How many authorization decisions are being made, by which enforcement point, and how many are refusals
Everything /admin/xacml/monitor draws: the global figures — policies, enforcement points, decisions, allows, declines — and then every PEP with its own counts, EMBEDDED and REMOTE in one list.
A DECISION IS NOT AN ENFORCEMENT. XACML has four decisions (Permit, Deny, NotApplicable, Indeterminate) and a PEP has two outcomes, and what maps between them is the PEP’s BIAS: a deny-biased PEP refuses a NotApplicable that a permit-biased one allows, from the same decision on the same request. An obligation the PEP cannot discharge also turns a Permit into a refusal (section 7.2) — the one enforcement outcome that looks like a bug from the client side and is the specification working. So allowed is not permit, and both are reported.
WHAT THIS SERVICE SAW IS NOT WHAT IT WAS TOLD. decisions.here was counted by this process as it happened; decisions.remote is what registered PEPs REPORT on their heartbeats, cumulative in their own memory, and a PEP that restarts makes it go down. decisions.combined adds the two, which is the figure a deployment wants and is arithmetic over two kinds of evidence rather than a measurement.
THE EMBEDDED PEPS ARE NOT “REGISTERED” AND CANNOT BE. They are compiled into this process, so their existence is a fact about the build. A remote PEP registers because it has no other way to be known about — and even that is not a permission: an unregistered PEP can pull GET /xacml/pep/policies and enforce perfectly, and appears here nowhere. This is every enforcement point the service KNOWS ABOUT, which is a smaller claim than every one that exists.
The counters are IN MEMORY, start with the process (since) and are per trust realm. The durable record of a refusal is GET /admin-api/audit, which has the reason as well as the count.
Mirrors GET /admin/xacml/monitor on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The global figures, and one row per enforcement point.
| Member | Type | Required | What it is |
|---|---|---|---|
decisions |
object | ||
decisions.combined |
object | ||
decisions.combined.allowed |
integer | ||
decisions.combined.decisions |
integer | ||
decisions.combined.refused |
integer | ||
decisions.combined.undischargeable |
integer | ||
decisions.combined.unenforced |
integer | ||
decisions.here |
object | ||
decisions.here.allowed |
integer | ||
decisions.here.decisions |
integer | ||
decisions.here.refused |
integer | ||
decisions.here.undischargeable |
integer | ||
decisions.here.unenforced |
integer | ||
decisions.remote |
object | ||
decisions.remote.allowed |
integer | ||
decisions.remote.decisions |
integer | ||
decisions.remote.refused |
integer | ||
decisions.remote.undischargeable |
integer | ||
decisions.remote.unenforced |
integer | ||
elsewhere |
list | ||
elsewhere[].count |
integer | ||
elsewhere[].id |
string | ||
elsewhere[].name |
string, or null | ||
enabled |
boolean | ||
message |
string | ||
peps |
object | ||
peps.embedded |
integer | ||
peps.remote |
integer | ||
peps.total |
integer | ||
policies |
object | ||
policies.enabled |
integer | ||
policies.root |
string, or null | ||
policies.total |
integer | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
realm |
object | ||
realm.id |
string | ||
realm.name |
string, or null | ||
remotePepsEnabled |
boolean | ||
remoteRows |
list | ||
remoteRows[].allowed |
integer, or null | ||
remoteRows[].bias |
string, or null | ||
remoteRows[].decisions |
integer | ||
remoteRows[].deny |
integer, or null | ||
remoteRows[].dischargesObligations |
boolean | ||
remoteRows[].enforces |
boolean | ||
remoteRows[].guards |
string | ||
remoteRows[].id |
string | ||
remoteRows[].indeterminate |
integer, or null | ||
remoteRows[].kind |
string | ||
remoteRows[].label |
string | ||
remoteRows[].lastAllowed |
boolean, or null | ||
remoteRows[].lastAt |
string, or number, or null | ||
remoteRows[].lastDecision |
string, or null | ||
remoteRows[].module |
string | ||
remoteRows[].notApplicable |
integer, or null | ||
remoteRows[].other |
integer, or null | ||
remoteRows[].permit |
integer, or null | ||
remoteRows[].refused |
integer, or null | ||
remoteRows[].remote |
object | ||
remoteRows[].remote.authenticated |
boolean | ||
remoteRows[].remote.certificateSubject |
string | ||
remoteRows[].remote.current |
boolean | ||
remoteRows[].remote.enabled |
boolean | ||
remoteRows[].remote.lastNotify |
string | ||
remoteRows[].remote.lastSeen |
string, or null | ||
remoteRows[].remote.policyCount |
integer, or null | ||
remoteRows[].remote.registeredAt |
string, or null | ||
remoteRows[].remote.stale |
boolean | ||
remoteRows[].remote.syncToken |
string | ||
remoteRows[].remote.version |
string | ||
remoteRows[].undischargeable |
integer | ||
remoteRows[].where |
string | ||
rows |
list | ||
rows[].allowed |
integer, or null | ||
rows[].bias |
string, or null | ||
rows[].decisions |
integer | ||
rows[].deny |
integer, or null | ||
rows[].dischargesObligations |
boolean | ||
rows[].enforces |
boolean | ||
rows[].guards |
string | ||
rows[].id |
string | ||
rows[].indeterminate |
integer, or null | ||
rows[].kind |
string | ||
rows[].label |
string | ||
rows[].lastAllowed |
boolean, or null | ||
rows[].lastAt |
string, or number, or null | ||
rows[].lastDecision |
string, or null | ||
rows[].module |
string | ||
rows[].notApplicable |
integer, or null | ||
rows[].other |
integer, or null | ||
rows[].permit |
integer, or null | ||
rows[].refused |
integer, or null | ||
rows[].remote |
object | ||
rows[].remote.authenticated |
boolean | ||
rows[].remote.certificateSubject |
string | ||
rows[].remote.current |
boolean | ||
rows[].remote.enabled |
boolean | ||
rows[].remote.lastNotify |
string | ||
rows[].remote.lastSeen |
string, or null | ||
rows[].remote.policyCount |
integer, or null | ||
rows[].remote.registeredAt |
string, or null | ||
rows[].remote.stale |
boolean | ||
rows[].remote.syncToken |
string | ||
rows[].remote.version |
string | ||
rows[].undischargeable |
integer | ||
rows[].where |
string | ||
since |
string | ||
xacml |
boolean |
GET /admin-api/xacml/peps
getXacmlPeps
The REMOTE Policy Enforcement Points that pull this repository, and whether they are deciding with the same policy this service holds
Everything the Remote PEPs tab on /admin/xacml draws.
A REMOTE PEP runs in another process, holds its own copy of the engine and PULLS the enabled policies from GET /xacml/pep/policies. The pull is the contract; the nudge this service sends to notifyUrl when the repository changes is an optimisation over the polling interval and never a replacement for it, so a PEP that is never nudged still converges.
REGISTERING IS NOT A PERMISSION. An unregistered PEP can pull and enforce exactly as well — GET /xacml/pep/policies requires no credential, because a policy is a rule and a rule nobody can read is a rule nobody can check. What a row buys is this listing and an address for the nudge.
current is a COMPARISON this service performs between syncToken on the row and the repository’s own, not a claim the PEP makes; stale is how long since it was last heard from against xacml.pepStaleAfterS and changes nothing this service does. The decision counts are the PEP’s own, cumulative in its process — this service saw none of those decisions, which is what a remote PEP is — so a PEP that restarts makes them go down.
Mirrors GET /admin/xacml on the admin console.
The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The register, and what each PEP last reported.
| Member | Type | Required | What it is |
|---|---|---|---|
current |
integer | ||
elsewhere |
list | ||
elsewhere[].count |
integer | ||
elsewhere[].id |
string | ||
elsewhere[].name |
string, or null | ||
enabled |
boolean | ||
listenerCertificates |
object | ||
listenerCertificates.defaultKeyAlg |
string | ||
listenerCertificates.keyAlgorithms |
list | ||
listenerCertificates.keyAlgorithms[] |
string | ||
listenerCertificates.useCase |
string | ||
message |
string | ||
notify |
object | ||
notify.allowedHosts |
list | ||
notify.allowedHosts[] |
string | ||
notify.on |
boolean | ||
notify.timeoutMs |
number | ||
notify.transport |
object | ||
notify.transport.allowHttp |
boolean | ||
notify.transport.caFile |
string | ||
notify.transport.skipTlsVerification |
boolean | ||
notify.transport.skipTlsVerificationSet |
boolean | ||
peps |
list | ||
peps[].allowed |
number, or null | ||
peps[].authenticated |
boolean | ||
peps[].bias |
string | ||
peps[].certificateSubject |
string | ||
peps[].current |
boolean | ||
peps[].decisions |
number, or null | ||
peps[].description |
string | ||
peps[].dn |
string | ||
peps[].enabled |
boolean | ||
peps[].identity |
string | ||
peps[].lastNotify |
string | ||
peps[].lastSeen |
string | ||
peps[].listenerCertificate |
object | ||
peps[].listenerCertificate.certificatePem |
string | ||
peps[].listenerCertificate.dnsNames |
list | ||
peps[].listenerCertificate.dnsNames[] |
string | ||
peps[].listenerCertificate.expired |
boolean | ||
peps[].listenerCertificate.ipAddresses |
list | ||
peps[].listenerCertificate.ipAddresses[] |
string | ||
peps[].listenerCertificate.issuedAt |
string | ||
peps[].listenerCertificate.keyAlg |
string | ||
peps[].listenerCertificate.notAfter |
string | ||
peps[].listenerCertificate.notBefore |
string | ||
peps[].listenerCertificate.serialHex |
string | ||
peps[].listenerCertificate.signatureAlg |
string | ||
peps[].listenerCertificate.subject |
string | ||
peps[].listenerCertificate.thumbprint |
string | ||
peps[].name |
string | ||
peps[].notifyProblem |
string, or null | ||
peps[].notifyUrl |
string | ||
peps[].policyCount |
number, or null | ||
peps[].refused |
number, or null | ||
peps[].registeredAt |
string | ||
peps[].resource |
string | ||
peps[].stale |
boolean | ||
peps[].syncToken |
string | ||
peps[].thumbprint |
string | ||
peps[].undischargeable |
number, or null | ||
peps[].version |
string | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list, or string | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
requiresCertificate |
boolean | ||
stale |
integer | ||
staleAfterS |
number | ||
syncToken |
string, or null | ||
xacml |
boolean |
GET /admin-api/xacml/policies
getXacmlPolicies
The policy repository, with the type-check problems of each
Everything the Policies tab on /admin/xacml draws.
THE STORE IS ou=policies IN THE EMBEDDED DIRECTORY — that container IS the repository rather than a copy of one, so an ldapmodify of xacmlPolicyDocument changes what the PDP decides on the next request.
EXACTLY ONE POLICY IS THE ROOT. A PDP evaluates one document and reaches the rest through PolicyIdReference, so the root is where evaluation starts; a repository with none decides nothing and reports root: null.
templates is what POST /admin-api/xacml/create-from-template will build, with the parameters each takes.
Mirrors GET /admin/xacml on the admin console.
The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The policies, the root, and the templates.
| Member | Type | Required | What it is |
|---|---|---|---|
applicationPolicies |
list | ||
applicationPolicies[].application |
string | ||
applicationPolicies[].enforced |
boolean | ||
applicationPolicies[].known |
boolean | ||
applicationPolicies[].policies |
list | ||
applicationPolicies[].policies[].enabled |
boolean | ||
applicationPolicies[].policies[].name |
string | ||
applicationPolicies[].policies[].orphanedAt |
string, or null | ||
applicationPolicies[].policies[].policyId |
string, or null | ||
applicationPolicies[].policies[].referenced |
boolean | ||
applicationPolicies[].policies[].version |
string | ||
message |
string | ||
policies |
list | ||
policies[].application |
string, or null | ||
policies[].combiningAlgId |
string | ||
policies[].description |
string | ||
policies[].enabled |
boolean | ||
policies[].isRoot |
boolean | ||
policies[].kind |
string | ||
policies[].name |
string | ||
policies[].orphanedAt |
string, or null | ||
policies[].policyId |
string, or null | ||
policies[].problems |
list | ||
policies[].problems[] |
string | ||
policies[].version |
string | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list, or string | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
root |
string, or null | ||
serviceOwn |
list | ||
serviceOwn[].asked |
string | ||
serviceOwn[].builtIn |
boolean | ||
serviceOwn[].decides |
string | ||
serviceOwn[].effect |
string | ||
serviceOwn[].enabled |
boolean, or null | ||
serviceOwn[].entry |
boolean | ||
serviceOwn[].key |
string | ||
serviceOwn[].label |
string | ||
serviceOwn[].name |
string | ||
serviceOwn[].ok |
boolean | ||
serviceOwn[].readsRisk |
boolean | ||
serviceOwn[].remote |
boolean | ||
serviceOwn[].setting |
string | ||
serviceOwn[].template |
string | ||
serviceOwn[].why |
string | ||
templates |
list | ||
templates[].blurb |
string | ||
templates[].id |
string | ||
templates[].label |
string | ||
templates[].parameters |
list | ||
templates[].parameters[].dflt |
string, or number, or boolean, or null | ||
templates[].parameters[].help |
string, or null | ||
templates[].parameters[].label |
string | ||
templates[].parameters[].name |
string | ||
templates[].parameters[].type |
string | ||
templates[].what |
string | ||
xacml |
boolean |
POST /admin-api/xacml/remove
removeXacmlNode
Remove any node from a policy
By path, which is the address GET /admin-api/xacml/editor gave you. A path is only valid against the document it was read from: remove rule 0 and every path naming rule 1 now means rule 0. Re-read the tree after each edit rather than reusing paths.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/set-expression-apply
setXacmlApply
Make an expression a function call
Replaces whatever is at path with an <Apply> of the function named in functionId, with arguments the function’s own signature requires. Every expression slot in a policy takes any of the four shapes, which is why these are four actions on one target rather than four kinds of node.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
functionId |
string | The function to apply. Its arguments are PRE-BUILT to the declared arity and types, so the expression typechecks the moment it exists. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/set-expression-designator
setXacmlDesignator
Make an expression an attribute reference
An <AttributeDesignator>: reads an attribute out of the REQUEST, or out of the directory through the PIP when the id is a bare name or carries the urn:sts:xacml:attribute: prefix.
IT RETURNS A BAG, always, even when it finds exactly one value — which is why string-one-and-only exists and why most functions need it wrapped. Nothing in this engine ever holds a bare value, so there is no code path where somebody has to remember to wrap one.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attributeId |
string | The attribute to read. | |
category |
string | The attribute category. Defaults to access-subject. | |
dataType |
string | The datatype URI. Defaults to xs:string. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/set-expression-function
setXacmlExpressionFunction
Replace an expression with a Function reference
A function named as a VALUE rather than applied: <Function FunctionId="..."/>, which is what the first argument of a higher-order function such as any-of, all-of or map takes.
APPLYING IT THERE INSTEAD is the commonest way to write one of those wrongly, and it is why choosing a higher-order function from set-expression-apply now builds this shape for you rather than an AttributeValue the validator refuses.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
functionId |
string | The function to name. Defaults to string-equal. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/set-expression-selector
setXacmlExpressionSelector
Replace an expression with an AttributeSelector
An XPath over the <Content> of a request category, rather than a named attribute — and it returns a BAG exactly as a designator does, so most functions still need a one-and-only around it.
The namespace bindings its prefixes need TRAVEL WITH THE DOCUMENT: a prefix in the path means nothing without one, and an unresolvable prefix is an empty bag, which is NotApplicable, which looks exactly like a policy that decided you may not. Set them with edit-selector.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
category |
string | The request category whose content the path runs over. Defaults to resource. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
path_xpath |
string | Sent as path — but path is already the node address on this endpoint, so set the XPath with edit-selector immediately afterwards. The selector arrives with //*, which is complete and valid. |
|
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/set-expression-value
setXacmlValue
Make an expression a literal
An <AttributeValue> of dataType with lexical in it. The lexical form is parsed against the datatype when the policy is written, so 2026-13-01 as a date is refused there rather than becoming an Indeterminate at decision time.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
lexical |
string | The value, in that datatype’s lexical form. | |
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
type |
string | The datatype URI. Defaults to xs:string. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/set-expression-variable
setXacmlVariable
Make an expression a variable reference
A <VariableReference> to a <VariableDefinition> in the same policy. The reference is checked at write time, so one naming a variable that is not there is refused rather than deciding Indeterminate.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
path |
string | yes | The node’s address, from GET /admin-api/xacml/editor. ONLY VALID AGAINST THE DOCUMENT IT WAS READ FROM: remove rule 0 and every path naming rule 1 now means rule 0. |
policy |
string | yes | The directory entry name of the policy to edit — the cn under ou=policies, not the PolicyId inside the document. |
variableId |
string | The VariableDefinition to reference. It must exist in the same policy — the reference is checked at write time. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
POST /admin-api/xacml/set-root
setXacmlRootPolicy
Choose the policy the PDP starts from
Clears the flag on the incumbent first, because the store refuses a second root. Done in that order deliberately: a failure then leaves the repository with NO root rather than with two, which is the recoverable one of the two bad states.
Mirrors POST /admin/xacml#xacml-tab-policies, POST /admin/xacml#xacml-tab-editor, POST /admin/xacml#xacml-tab-peps, POST /admin/xacml/policies, POST /admin/xacml/editor and POST /admin/xacml/peps on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
name |
string | yes | The policy’s directory entry name. |
200: The operation was applied.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
string | ||
what |
string | ||
why |
string |