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/consent
getConsent
What people agreed applications may ask for on their behalf
Both halves of the consent register.
How it works. With oauth2.consentRequired on — it is ON by default, and it is the one policy in this service that is — the authorization endpoint draws /oauth2/consent the first time a given username signs in to a given client_id for a given scope, and issues nothing until they answer. Allow writes one oauthConsent value per scope onto that person’s own entry under ou=users; Deny returns access_denied to the client and records nothing.
globals is CONFIGURATION and users is a RECORD, and the difference decides what removing a row does. A global consent is oauthGlobalConsent on an APPLICATION’s entry, one value per scope: everybody who signs in to that application skips the prompt for it and nothing is written about anybody — so revoking it asks EVERYBODY again, including the people who would have said yes. A recorded consent is one person’s answer, and revoking it asks that one person.
A delegated permission is recorded by its WHOLE identifier — https://example.com/write, never the bare write — because two resources may both expose a permission of that name and a consent to one must not cover the other. globals[].resource says which application exposes it where the scope resolves to one, and globals[].granted whether that client has also been GRANTED it: the two are independent, and a consented permission the client does not hold is still refused in product mode, and in development when oauth2.delegatedPermissionsEnforced is on.
users[].unreadable is a value on somebody’s entry that is not in the shape this service writes — an ldapmodify put it there. It consents nothing and is reported rather than dropped.
storable: false means no directory is installed behind the register, so an answer is honoured for one request and forgotten and the screen is drawn every time. That is deliberate: an agreement that cannot be remembered is one nobody gave.
PAGED, BOTH HALVES, SINCE 2026-09-18. Each grows without a bound — a recorded consent is one row per (person, application, scope) — so the reply is ONE PAGE of globals and one of users, each answered by globalsPaging and usersPaging (page, pages, perPage, firstRow, lastRow, total) and moved by globalsPage and usersPage; per sizes both. counts still carries the totals. q narrows users over the person, the application and the scope, and matched is how many it matched. A caller that wants every row walks each half until its page equals its pages. This is the page /admin/consent draws, from the same function.
windowed: true (#820) means the realm’s people are in the store and the recorded half was read a page at a time rather than whole: usersPaging is over PEOPLE (noun: people) and matched and counts.people are how many people hold a consent, counted from an index; each page holds every consent of its people, newest first within it; counts.consents and counts.unreadable are the page’s (counts.countsOf: page); and q is EXACT — a whole username, client_id or scope — with a client_id or scope looked for in at most the first 5,000 holders, search.complete saying whether that was everybody. windowed: false is the whole register, as described above.
Mirrors GET /admin/consent on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
q |
query | string | Substring of the person, the application or the scope, case-insensitive. Narrows users only. Where the answer is windowed, a whole username, client_id or scope instead. |
|
globalsPage |
query | integer | Which page of globals to return, answered by globalsPaging. The global overrides, configuration on application entries. |
|
usersPage |
query | integer | Which page of users to return, answered by usersPaging. The recorded consents, one per (person, application, scope), after q. |
|
per |
query | integer | Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own. | |
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: One page of the scopes consented for everybody on an application, one page of the answers people have given, the paging of each, and whether the screen is being drawn at all.
| Member | Type | Required | What it is |
|---|---|---|---|
applicationChoices |
list | ||
applicationChoices[].identifier |
string | ||
applicationChoices[].name |
string | ||
attribute |
string | ||
counts |
object | ||
counts.consents |
integer | ||
counts.countsOf |
string | ||
counts.globals |
integer | ||
counts.people |
integer | ||
counts.unreadable |
integer | ||
globalAttribute |
string | ||
globals |
list | ||
globals[].client |
string | ||
globals[].clientName |
string | ||
globals[].granted |
boolean | ||
globals[].permission |
string | ||
globals[].resource |
string | ||
globals[].scope |
string | ||
globalsPaging |
object | ||
globalsPaging.firstRow |
integer | ||
globalsPaging.lastRow |
integer | ||
globalsPaging.noun |
string, or null | ||
globalsPaging.page |
integer | ||
globalsPaging.pages |
integer | ||
globalsPaging.param |
string, or null | ||
globalsPaging.perPage |
integer | ||
globalsPaging.total |
integer | ||
matched |
integer | ||
query |
object | ||
query.q |
string | ||
required |
boolean | ||
search |
object | ||
search.complete |
boolean | ||
search.exact |
boolean | ||
search.holders |
integer | ||
search.q |
string | ||
search.scanLimit |
integer | ||
search.scanned |
integer | ||
storable |
boolean | ||
users |
list | ||
users[].at |
string | ||
users[].client |
string | ||
users[].dn |
string | ||
users[].raw |
string | ||
users[].scope |
string | ||
users[].unreadable |
boolean | ||
users[].username |
string | ||
usersPaging |
object | ||
usersPaging.firstRow |
integer | ||
usersPaging.lastRow |
integer | ||
usersPaging.noun |
string, or null | ||
usersPaging.page |
integer | ||
usersPaging.pages |
integer | ||
usersPaging.param |
string, or null | ||
usersPaging.perPage |
integer | ||
usersPaging.total |
integer | ||
windowed |
boolean | ||
withdrawnAttribute |
string |
POST /admin-api/consent/forget-user-consent
forgetUserConsent
Forget everything one person agreed to
Every oauthConsent value on one person’s entry, in one call, so that every application asks them again. A separate operation rather than a loop over revoke-consent because being asked again is the one thing somebody wants after testing this screen, and doing it a row at a time for a person with thirty consents is a chore rather than a control.
It reaches nothing under GLOBAL consent, because there is nothing on their entry to reach — a scope they were never asked about leaves no record, which is what lets the register tell the two apart at all.
What was issued under those consents is revoked (#172), per application, and each withdrawal instant is written onto their entry — see revoke-consent.
Mirrors POST /admin/consent 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 |
|---|---|---|---|
username |
string | yes | The person whose answers are forgotten. |
200: How many answers were forgotten, and how many tokens were revoked (revoked).
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
POST /admin-api/consent/grant-global-consent
grantGlobalConsent
Consent a scope for everybody who signs in to an application
Adds one value to oauthGlobalConsent on the application’s own entry. Nobody is asked about that scope on that application again, and nothing is written about anybody — this is an OVERRIDE and not a record.
That is the whole difference from a person pressing Allow, and it decides what removing it does: revoke-global-consent asks everybody again, because there is no record of who would have agreed. Somebody who consented the same scope personally — before or after — still has that on their entry and is still not asked.
It is keyed on the pair, not on the scope. Consenting read here consents it for THIS application; an application registered five minutes later that spells the same word is still asked. There is no service-wide list of scopes nobody is ever asked about, deliberately: it would mean an application nobody has reviewed inheriting a decision made about a different one.
The scope must be a legal RFC 6749 section 3.3 scope token, because a value with a space in it is two scopes and could never match one. It need NOT name a permission any application defines — most scopes are not permissions, and refusing an unrecognised one would make it impossible to consent openid.
Mirrors POST /admin/consent 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 |
|---|---|---|---|
client |
string | yes | The application people sign in to, by its identifier exactly as ou=applications holds it. This is the CLIENT — the party that will name the scope in a request — and not the resource that exposes it. |
scope |
string | yes | The scope, exactly as a client puts it in a scope parameter. A delegated permission is its WHOLE identifier. |
200: The application as it now stands, and what skipping the prompt for that scope now means.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
POST /admin-api/consent/revoke-application-consent
revokeApplicationConsent
Withdraw everything one person agreed to for one application
Every oauthConsent value naming this person and this application, in one act (#172) — the console’s and the API’s counterpart of the Withdraw button a person has for each application on /portal/consents. They are asked again the next time that application requests anything; every access and refresh token it holds for them under those scopes is revoked; and the instant goes onto their entry, so a refresh token granted before it is refused even after they consent again. Refused when nothing is recorded for the pair — a scope under GLOBAL consent is not on anybody’s entry.
Mirrors POST /admin/consent 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 |
|---|---|---|---|
client |
string | yes | The application whose every consent is withdrawn. |
username |
string | yes | The person, exactly as /admin/users names them. |
200: How many consents were withdrawn (removed), how many tokens were revoked (revoked) and when (withdrawnAt).
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
POST /admin-api/consent/revoke-consent
revokeConsent
Take back one answer one person gave
Removes the oauthConsent value naming this person, this application and this scope. They are asked again the next time that application requests that scope; nobody else is affected.
All three are required and that is not pedantry. One person may consent the same scope to several applications, and revoking the wrong pair is invisible until somebody is asked again — which is a week later and looks like a bug in the screen.
A scope covered by GLOBAL consent is not on anybody’s entry, so there is nothing here to remove and this refuses rather than pretending: revoke-global-consent is the operation for that, and the refusal says so.
What was issued under it is revoked (#172): every access and refresh token this application holds for this person carrying the scope — a refresh token with its whole grant, since withdrawing one scope revokes the whole refresh token — and the instant goes onto their entry as oauthConsentWithdrawn, so a refresh token granted before it is refused even after they consent again.
Mirrors POST /admin/consent 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 |
|---|---|---|---|
client |
string | yes | The application they consented it to. |
scope |
string | yes | The scope they consented. |
username |
string | yes | The person, exactly as /admin/users names them. It is normalised the same way every identity here is, so alice and her urn:uuid: subject are one person. |
200: What was removed, what is asked again, how many tokens were revoked (revoked) and when (withdrawnAt).
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
POST /admin-api/consent/revoke-global-consent
revokeGlobalConsent
Stop consenting a scope for everybody
Removes one value from oauthGlobalConsent. The next person to sign in asking for that scope is PROMPTED, including everybody the override was covering, because an override records nothing about the people it covers. Somebody who agreed to it personally is unaffected — their answer is on their own entry and revoke-consent is what takes that away.
What was issued under it is revoked (#172). Every access and refresh token of this application carrying the scope, for everybody but the people who agreed to it themselves, goes on the revocation register every node reads — so it introspects inactive at once — and the instant is written onto the application’s entry as oauthGlobalConsentWithdrawn, so a refresh token granted before it is refused even if the override is added back. revoked is how many tokens this call revoked. This is the only way to take a global consent away: the generic applications/remove of oauthGlobalConsent is refused (STS-REG-0191). On one of this service’s own surfaces (sts-admin-console, sts-user-portal, sts-debugger-ui) it is not refused either: every session of that surface standing on the override ends at its next token renewal and the person signs in again and is asked.
Mirrors POST /admin/consent 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 |
|---|---|---|---|
client |
string | yes | The application holding it. |
scope |
string | yes | The scope to stop consenting. |
200: What was removed, who is asked again, how many tokens were revoked (revoked) and when (withdrawnAt).
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
dn |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
integer | ||
revoked |
integer | ||
withdrawnAt |
string, or null |
GET /admin-api/delegation
getDelegation
Who acted on whose behalf, through what, to reach what
Every delegation this service has performed or REFUSED, in one model across three protocol families, plus the configured policy that decides the Kerberos ones.
Eight mechanisms: Kerberos S4U2Self, S4U2Proxy (classic and resource-based) and a forwarded ticket-granting ticket; WS-Trust OnBehalfOf and ActAs; RFC 8693 token exchange in both its shapes. They are recorded against ONE model because the question is protocol-independent: which hop invented which identity.
The axis worth filtering on is mode. Under a delegation the credential CARRIES the chain — an act claim, a composite ActAs, S4U_DELEGATION_INFO in the PAC — so the far end can see who is really asking. Under an impersonation nothing does, which means this endpoint is the ONLY place that fact is ever visible: no reading of the token afterwards can recover it.
Refusals are here and are most of the value. A refused act carries reason — the KDC’s own words, the same sentence the client was sent — naming the two accounts and the two attributes and which was missing. A refused delegation appears in NO other resource here: nothing was accepted, so /admin-api/audit and /admin-api/users have nothing to say about it.
Every family is policed now (#108). The KDC decides Kerberos; WS-Trust and token exchange are decided by the delegation policy (GET /admin-api/delegation/policy), enforced in product mode, and each act names what allowed it in authorizedBy — or, in development, what WOULD have refused it.
Besides the paged acts the reply carries chains — the distinct (mechanism, initial, intermediary, target) tuples among what MATCHED, one per edge of the picture — applications, every application an act named in WHATEVER ROLE it played (the console draws one of them in full at /admin/delegation/application) — and policy, which is who may delegate to whom before anybody has tried.
THIS IS THE DELEGATION REGISTER AND NOT EVERYTHING A PERSON WAS ISSUED. An ordinary grant is not a delegation act and is not here: for one identity END TO END — every credential with the exact grant or flow that produced it, beside the acts naming them — the console unions this register with the issued one at /admin/delegation/user?user=…&format=json, and the tokens alone are in GET /admin-api/users.
RESUME BY at: an act’s seq is unique across every process and never reused, and rises within each process, but it is not one order across processes (#465).
Mirrors GET /admin/delegation on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
type |
query | one of krb5-s4u2self, krb5-s4u2proxy-classic, krb5-s4u2proxy-rbcd, krb5-forwarded, wstrust-onbehalfof, wstrust-actas, oauth-impersonation, oauth-delegation, oauth-assertion-grant, oauth-saml-assertion-grant, gnap-impersonation, gnap-derivation |
One mechanism. The reply’s types member describes each of them, with the specification it comes from and whether this service polices it. |
|
mode |
query | one of impersonation, delegation |
The protocol-independent axis: whether what came out carries the chain. ANDed with type, so a mode that does not match the mechanism matches nothing. |
|
outcome |
query | one of issued, refused |
Two rather than the audit log’s three: a delegation is DECIDED rather than performed, so there is no third answer between issuing the credential and refusing to. | |
protocol |
query | string | The family, spelled as /admin-api/users spells it — Kerberos v5, WS-Trust, OAuth 2.0. Free text rather than an enum, for the reason the audit log’s protocol is. |
|
q |
query | string | Substring of ANY party of the chain (normalised name, presented form or application) or of either explanation, case-insensitive. One box over six fields, because the fact a caller has names one of them and not which column it is in. | |
page |
query | integer | Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is. | |
per |
query | integer | Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own. | |
permq |
query | string | Part of a permission’s resource. | |
grantq |
query | string | Part of a grant’s client or resource. | |
appq |
query | string | The application chooser’s search. | |
userq |
query | string | The person chooser’s search. | |
appfrom |
query | integer | Where the application chooser’s page starts. | |
userfrom |
query | integer | Where the person chooser’s page starts. | |
chainsPage |
query | integer | Which page of chains to return, clamped as page is. |
|
permissionsPage |
query | integer | Which page of permissions to return, clamped as page is. |
|
grantsPage |
query | integer | Which page of grants to return, clamped as page is. |
|
pairsPage |
query | integer | Which page of pairs to return, clamped as page is. |
|
flagsPage |
query | integer | Which page of flags to return, clamped as page is. |
|
mechanismsPage |
query | integer | Which page of mechanisms to return, clamped as page is. |
|
policyPairsPage |
query | integer | Which page of policyPairs to return, clamped as page is. |
|
intermediariesPage |
query | integer | Which page of intermediaries to return, clamped as page is. |
|
peoplePage |
query | integer | Which page of people to return, clamped as page is. |
|
groupsPage |
query | integer | Which page of groups to return, clamped as page is. |
|
groupGrantsPage |
query | integer | Which page of groupGrants to return, clamped as page is. |
|
groupPermissionsPage |
query | integer | Which page of groupPermissions to return, clamped as page 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 matching acts, the distinct chains among them, the configured Kerberos policy, and the vocabulary the filters take.
| Member | Type | Required | What it is |
|---|---|---|---|
acts |
list | ||
acts[].at |
number, or null | ||
acts[].authorizedBy |
string | ||
acts[].chainKey |
string | ||
acts[].consumed |
list | ||
acts[].consumed[].identifier |
string | ||
acts[].consumed[].kind |
string | ||
acts[].consumed[].note |
string | ||
acts[].initial |
object | ||
acts[].initial.application |
string | ||
acts[].initial.key |
string | ||
acts[].initial.presented |
string | ||
acts[].initial.what |
string | ||
acts[].intermediary |
object | ||
acts[].intermediary.application |
string | ||
acts[].intermediary.key |
string | ||
acts[].intermediary.presented |
string | ||
acts[].intermediary.what |
string | ||
acts[].mode |
string | ||
acts[].note |
string | ||
acts[].origin |
string | ||
acts[].outcome |
string | ||
acts[].policed |
boolean | ||
acts[].produced |
list | ||
acts[].produced[].identifier |
string | ||
acts[].produced[].kind |
string | ||
acts[].produced[].note |
string | ||
acts[].protocol |
string | ||
acts[].reason |
string | ||
acts[].seq |
number | ||
acts[].sessionId |
string | ||
acts[].spec |
string | ||
acts[].target |
object | ||
acts[].target.application |
string | ||
acts[].target.key |
string | ||
acts[].target.presented |
string | ||
acts[].target.what |
string | ||
acts[].type |
string | ||
acts[].typeLabel |
string | ||
all |
integer | ||
allowed |
object | ||
allowed.counts |
object | ||
allowed.counts.clients |
integer | ||
allowed.counts.dangling |
integer | ||
allowed.counts.grants |
integer | ||
allowed.counts.permissions |
integer | ||
allowed.counts.resources |
integer | ||
allowed.counts.ungranted |
integer | ||
allowed.counts.unidentified |
integer | ||
allowed.counts.unused |
integer | ||
allowed.filter |
object | ||
allowed.filter.grants |
string, or null | ||
allowed.filter.permissions |
string, or null | ||
allowed.grants |
list | ||
allowed.grants[].asked |
boolean | ||
allowed.grants[].baseUri |
string, or null | ||
allowed.grants[].client |
string | ||
allowed.grants[].clientName |
string | ||
allowed.grants[].dangling |
boolean | ||
allowed.grants[].description |
string, or null | ||
allowed.grants[].permissionId |
string | ||
allowed.grants[].permissionName |
string, or null | ||
allowed.grants[].resource |
string | ||
allowed.grants[].resourceName |
string | ||
allowed.graph |
object | ||
allowed.graph.acts |
integer | ||
allowed.graph.chains |
integer | ||
allowed.graph.counts |
object | ||
allowed.graph.counts.edges |
integer | ||
allowed.graph.counts.grants |
integer | ||
allowed.graph.counts.nodes |
integer | ||
allowed.graph.credentials |
list | ||
allowed.graph.credentials[].at |
number, or null | ||
allowed.graph.credentials[].audience |
string | ||
allowed.graph.credentials[].detail |
string | ||
allowed.graph.credentials[].expiresAtMs |
number, or null | ||
allowed.graph.credentials[].family |
string | ||
allowed.graph.credentials[].flow |
string | ||
allowed.graph.credentials[].flowLabel |
string, or null | ||
allowed.graph.credentials[].flowOidc |
string, or null | ||
allowed.graph.credentials[].flowProtocol |
string, or null | ||
allowed.graph.credentials[].flowSpec |
string, or null | ||
allowed.graph.credentials[].flowStated |
boolean | ||
allowed.graph.credentials[].holder |
string | ||
allowed.graph.credentials[].identifier |
string | ||
allowed.graph.credentials[].issuer |
string | ||
allowed.graph.credentials[].kind |
string | ||
allowed.graph.credentials[].revocable |
boolean | ||
allowed.graph.credentials[].revoked |
boolean | ||
allowed.graph.credentials[].scope |
string | ||
allowed.graph.credentials[].sessionId |
string | ||
allowed.graph.credentials[].state |
string, or null | ||
allowed.graph.credentialsOnDelegationLines |
integer | ||
allowed.graph.edges |
list | ||
allowed.graph.edges[].actor |
string, or null | ||
allowed.graph.edges[].acts |
integer | ||
allowed.graph.edges[].asked |
boolean | ||
allowed.graph.edges[].attribute |
string | ||
allowed.graph.edges[].audience |
string | ||
allowed.graph.edges[].audienceRegistered |
boolean | ||
allowed.graph.edges[].authentications |
list | ||
allowed.graph.edges[].authentications[].at |
number, or null | ||
allowed.graph.edges[].authentications[].count |
integer | ||
allowed.graph.edges[].authentications[].lastAt |
number, or null | ||
allowed.graph.edges[].authentications[].method |
string | ||
allowed.graph.edges[].authentications[].protocol |
string | ||
allowed.graph.edges[].authorizedBy |
string | ||
allowed.graph.edges[].baseUri |
string, or null | ||
allowed.graph.edges[].chainKey |
string | ||
allowed.graph.edges[].consumed |
list | ||
allowed.graph.edges[].consumed[].count |
integer | ||
allowed.graph.edges[].consumed[].identifiers |
list | ||
allowed.graph.edges[].consumed[].identifiers[] |
string | ||
allowed.graph.edges[].consumed[].kind |
string | ||
allowed.graph.edges[].consumed[].moreIdentifiers |
integer | ||
allowed.graph.edges[].consumed[].notes |
list | ||
allowed.graph.edges[].consumed[].notes[] |
string | ||
allowed.graph.edges[].consumedFold |
map | ||
allowed.graph.edges[].consumedFold.{key}.count |
integer | ||
allowed.graph.edges[].consumedFold.{key}.identifiers |
list | ||
allowed.graph.edges[].consumedFold.{key}.identifiers[] |
string | ||
allowed.graph.edges[].consumedFold.{key}.kind |
string | ||
allowed.graph.edges[].consumedFold.{key}.moreIdentifiers |
integer | ||
allowed.graph.edges[].consumedFold.{key}.notes |
list | ||
allowed.graph.edges[].consumedFold.{key}.notes[] |
string | ||
allowed.graph.edges[].credentials |
integer | ||
allowed.graph.edges[].description |
string, or null | ||
allowed.graph.edges[].firstAt |
number, or null | ||
allowed.graph.edges[].from |
string | ||
allowed.graph.edges[].fromRole |
string | ||
allowed.graph.edges[].id |
string | ||
allowed.graph.edges[].issued |
integer | ||
allowed.graph.edges[].lastAt |
number, or null | ||
allowed.graph.edges[].mechanism |
string | ||
allowed.graph.edges[].mode |
string | ||
allowed.graph.edges[].permissionId |
string | ||
allowed.graph.edges[].permissionName |
string | ||
allowed.graph.edges[].permissions |
list | ||
allowed.graph.edges[].permissions[] |
string | ||
allowed.graph.edges[].policed |
boolean | ||
allowed.graph.edges[].produced |
list | ||
allowed.graph.edges[].produced[].count |
integer | ||
allowed.graph.edges[].produced[].identifiers |
list | ||
allowed.graph.edges[].produced[].identifiers[] |
string | ||
allowed.graph.edges[].produced[].kind |
string | ||
allowed.graph.edges[].produced[].moreIdentifiers |
integer | ||
allowed.graph.edges[].produced[].notes |
list | ||
allowed.graph.edges[].produced[].notes[] |
string | ||
allowed.graph.edges[].producedFold |
map | ||
allowed.graph.edges[].producedFold.{key}.count |
integer | ||
allowed.graph.edges[].producedFold.{key}.identifiers |
list | ||
allowed.graph.edges[].producedFold.{key}.identifiers[] |
string | ||
allowed.graph.edges[].producedFold.{key}.kind |
string | ||
allowed.graph.edges[].producedFold.{key}.moreIdentifiers |
integer | ||
allowed.graph.edges[].producedFold.{key}.notes |
list | ||
allowed.graph.edges[].producedFold.{key}.notes[] |
string | ||
allowed.graph.edges[].protocol |
string, or null | ||
allowed.graph.edges[].protocols |
list | ||
allowed.graph.edges[].protocols[] |
string | ||
allowed.graph.edges[].reason |
string | ||
allowed.graph.edges[].refused |
integer | ||
allowed.graph.edges[].relation |
string | ||
allowed.graph.edges[].scopes |
list | ||
allowed.graph.edges[].scopes[] |
string | ||
allowed.graph.edges[].setOn |
string | ||
allowed.graph.edges[].skipped |
list | ||
allowed.graph.edges[].skipped[] |
string | ||
allowed.graph.edges[].spec |
string, or null | ||
allowed.graph.edges[].subject |
string, or null | ||
allowed.graph.edges[].to |
string | ||
allowed.graph.edges[].toRole |
string | ||
allowed.graph.edges[].type |
string, or null | ||
allowed.graph.edges[].typeLabel |
string, or null | ||
allowed.graph.edges[].used |
boolean | ||
allowed.graph.issuer |
string | ||
allowed.graph.maxTokenRows |
integer | ||
allowed.graph.nodes |
list | ||
allowed.graph.nodes[].acts |
integer | ||
allowed.graph.nodes[].aliases |
list | ||
allowed.graph.nodes[].aliases[] |
string | ||
allowed.graph.nodes[].application |
string | ||
allowed.graph.nodes[].authentications |
integer | ||
allowed.graph.nodes[].chiefRole |
string | ||
allowed.graph.nodes[].credentials |
integer | ||
allowed.graph.nodes[].dangling |
integer | ||
allowed.graph.nodes[].exposes |
integer | ||
allowed.graph.nodes[].firstAt |
number, or null | ||
allowed.graph.nodes[].flows |
list | ||
allowed.graph.nodes[].flows[] |
string | ||
allowed.graph.nodes[].grants |
integer | ||
allowed.graph.nodes[].id |
string | ||
allowed.graph.nodes[].isClient |
boolean | ||
allowed.graph.nodes[].isSubject |
boolean | ||
allowed.graph.nodes[].issued |
integer | ||
allowed.graph.nodes[].issuer |
string | ||
allowed.graph.nodes[].key |
string | ||
allowed.graph.nodes[].kind |
string | ||
allowed.graph.nodes[].kinds |
list | ||
allowed.graph.nodes[].kinds[] |
string | ||
allowed.graph.nodes[].lastAt |
number, or null | ||
allowed.graph.nodes[].presented |
string | ||
allowed.graph.nodes[].protocols |
list | ||
allowed.graph.nodes[].protocols[] |
string | ||
allowed.graph.nodes[].realm |
object | ||
allowed.graph.nodes[].realm.id |
string | ||
allowed.graph.nodes[].realm.isDefault |
boolean | ||
allowed.graph.nodes[].realm.name |
string, or null | ||
allowed.graph.nodes[].refused |
integer | ||
allowed.graph.nodes[].roles |
object | ||
allowed.graph.nodes[].roles.initial |
number | ||
allowed.graph.nodes[].roles.intermediary |
number | ||
allowed.graph.nodes[].roles.target |
number | ||
allowed.graph.nodes[].selfTarget |
boolean | ||
allowed.graph.nodes[].what |
string | ||
allowed.graph.realm |
object | ||
allowed.graph.realm.id |
string | ||
allowed.graph.realm.isDefault |
boolean | ||
allowed.graph.realm.name |
string, or null | ||
allowed.graph.subject |
string | ||
allowed.graph.tokens |
list | ||
allowed.graph.tokens[].actor |
string, or null | ||
allowed.graph.tokens[].at |
number, or null | ||
allowed.graph.tokens[].chainKey |
string | ||
allowed.graph.tokens[].identifier |
string | ||
allowed.graph.tokens[].kind |
string | ||
allowed.graph.tokens[].mode |
string | ||
allowed.graph.tokens[].note |
string | ||
allowed.graph.tokens[].protocol |
string | ||
allowed.graph.tokens[].seq |
number | ||
allowed.graph.tokens[].subject |
string, or null | ||
allowed.graph.tokens[].target |
string, or null | ||
allowed.graph.tokens[].type |
string | ||
allowed.graph.tokens[].typeLabel |
string | ||
allowed.graph.tokensLeftOff |
integer | ||
allowed.paging |
object | ||
allowed.paging.grants |
object | ||
allowed.paging.grants.firstRow |
integer | ||
allowed.paging.grants.lastRow |
integer | ||
allowed.paging.grants.noun |
string, or null | ||
allowed.paging.grants.page |
integer | ||
allowed.paging.grants.pages |
integer | ||
allowed.paging.grants.param |
string, or null | ||
allowed.paging.grants.perPage |
integer | ||
allowed.paging.grants.total |
integer | ||
allowed.paging.permissions |
object | ||
allowed.paging.permissions.firstRow |
integer | ||
allowed.paging.permissions.lastRow |
integer | ||
allowed.paging.permissions.noun |
string, or null | ||
allowed.paging.permissions.page |
integer | ||
allowed.paging.permissions.pages |
integer | ||
allowed.paging.permissions.param |
string, or null | ||
allowed.paging.permissions.perPage |
integer | ||
allowed.paging.permissions.total |
integer | ||
allowed.permissions |
list | ||
allowed.permissions[].baseUri |
string, or null | ||
allowed.permissions[].description |
string, or null | ||
allowed.permissions[].grantedTo |
list | ||
allowed.permissions[].grantedTo[].asked |
boolean | ||
allowed.permissions[].grantedTo[].identifier |
string | ||
allowed.permissions[].grantedTo[].name |
string | ||
allowed.permissions[].id |
string, or null | ||
allowed.permissions[].name |
string, or null | ||
allowed.permissions[].raw |
string, or null | ||
allowed.permissions[].resource |
string | ||
allowed.permissions[].resourceName |
string | ||
allowed.resources |
list | ||
allowed.resources[].baseUri |
string, or null | ||
allowed.resources[].grantsHeld |
integer | ||
allowed.resources[].identifier |
string | ||
allowed.resources[].name |
string | ||
allowed.resources[].permissions |
list | ||
allowed.resources[].permissions[].description |
string, or null | ||
allowed.resources[].permissions[].grantedTo |
list | ||
allowed.resources[].permissions[].grantedTo[].asked |
boolean | ||
allowed.resources[].permissions[].grantedTo[].identifier |
string | ||
allowed.resources[].permissions[].grantedTo[].name |
string | ||
allowed.resources[].permissions[].id |
string, or null | ||
allowed.resources[].permissions[].name |
string, or null | ||
allowed.resources[].permissions[].raw |
string, or null | ||
allowed.resources[].rawBaseUri |
string | ||
applicationChooser |
object | ||
applicationChooser.complete |
boolean | ||
applicationChooser.entries |
list | ||
applicationChooser.entries[].detail |
string | ||
applicationChooser.entries[].href |
string | ||
applicationChooser.entries[].key |
string | ||
applicationChooser.entries[].label |
string | ||
applicationChooser.entries[].names |
list | ||
applicationChooser.entries[].names[] |
string, or null | ||
applicationChooser.search |
string | ||
applicationChooser.slice |
object | ||
applicationChooser.slice.from |
integer | ||
applicationChooser.slice.matched |
integer | ||
applicationChooser.total |
integer | ||
applications |
list | ||
applications[].acts |
integer | ||
applications[].chains |
integer | ||
applications[].credentials |
integer | ||
applications[].firstAt |
number, or null | ||
applications[].identifier |
string | ||
applications[].identityKey |
string | ||
applications[].issued |
integer | ||
applications[].key |
string | ||
applications[].lastAt |
number, or null | ||
applications[].protocols |
list | ||
applications[].protocols[] |
string | ||
applications[].refused |
integer | ||
applications[].roles |
object | ||
applications[].roles.initial |
number | ||
applications[].roles.intermediary |
number | ||
applications[].roles.target |
number | ||
applications[].spellings |
list | ||
applications[].spellings[] |
string | ||
byMode |
map | ||
byMode.{key} |
integer | ||
byOutcome |
map | ||
byOutcome.{key} |
integer | ||
byProtocol |
map | ||
byProtocol.{key} |
integer | ||
byType |
map | ||
byType.{key} |
integer | ||
chainPage |
object | ||
chainPage.paging |
object | ||
chainPage.paging.firstRow |
integer | ||
chainPage.paging.lastRow |
integer | ||
chainPage.paging.noun |
string, or null | ||
chainPage.paging.page |
integer | ||
chainPage.paging.pages |
integer | ||
chainPage.paging.param |
string, or null | ||
chainPage.paging.perPage |
integer | ||
chainPage.paging.total |
integer | ||
chainPage.shown |
list | ||
chainPage.shown[].acts |
integer | ||
chainPage.shown[].authorizedBy |
string | ||
chainPage.shown[].chainKey |
string | ||
chainPage.shown[].firstAt |
number, or null | ||
chainPage.shown[].initial |
object | ||
chainPage.shown[].initial.application |
string | ||
chainPage.shown[].initial.key |
string | ||
chainPage.shown[].initial.presented |
string | ||
chainPage.shown[].initial.what |
string | ||
chainPage.shown[].intermediary |
object | ||
chainPage.shown[].intermediary.application |
string | ||
chainPage.shown[].intermediary.key |
string | ||
chainPage.shown[].intermediary.presented |
string | ||
chainPage.shown[].intermediary.what |
string | ||
chainPage.shown[].issued |
integer | ||
chainPage.shown[].lastAt |
number, or null | ||
chainPage.shown[].mode |
string | ||
chainPage.shown[].protocol |
string | ||
chainPage.shown[].reason |
string | ||
chainPage.shown[].refused |
integer | ||
chainPage.shown[].target |
object | ||
chainPage.shown[].target.application |
string | ||
chainPage.shown[].target.key |
string | ||
chainPage.shown[].target.presented |
string | ||
chainPage.shown[].target.what |
string | ||
chainPage.shown[].type |
string | ||
chainPage.shown[].typeLabel |
string | ||
chains |
list | ||
chains[].acts |
integer | ||
chains[].authorizedBy |
string | ||
chains[].chainKey |
string | ||
chains[].firstAt |
number, or null | ||
chains[].initial |
object | ||
chains[].initial.application |
string | ||
chains[].initial.key |
string | ||
chains[].initial.presented |
string | ||
chains[].initial.what |
string | ||
chains[].intermediary |
object | ||
chains[].intermediary.application |
string | ||
chains[].intermediary.key |
string | ||
chains[].intermediary.presented |
string | ||
chains[].intermediary.what |
string | ||
chains[].issued |
integer | ||
chains[].lastAt |
number, or null | ||
chains[].mode |
string | ||
chains[].protocol |
string | ||
chains[].reason |
string | ||
chains[].refused |
integer | ||
chains[].target |
object | ||
chains[].target.application |
string | ||
chains[].target.key |
string | ||
chains[].target.presented |
string | ||
chains[].target.what |
string | ||
chains[].type |
string | ||
chains[].typeLabel |
string | ||
delegationPerPage |
integer | ||
delegationPolicy |
object | ||
delegationPolicy.attributes |
map | ||
delegationPolicy.attributes.{key} |
string | ||
delegationPolicy.enforced |
boolean | ||
delegationPolicy.intermediaries |
list | ||
delegationPolicy.intermediaries[].application |
string | ||
delegationPolicy.intermediaries[].defaultSemantics |
string | ||
delegationPolicy.intermediaries[].impersonates |
boolean | ||
delegationPolicy.intermediaries[].notDelegated |
boolean | ||
delegationPolicy.intermediaries[].semantics |
list | ||
delegationPolicy.intermediaries[].semantics[] |
string | ||
delegationPolicy.intermediaries[].subjectGroups |
list | ||
delegationPolicy.intermediaries[].subjectGroups[] |
string | ||
delegationPolicy.intermediariesPaging |
object | ||
delegationPolicy.intermediariesPaging.firstRow |
integer | ||
delegationPolicy.intermediariesPaging.lastRow |
integer | ||
delegationPolicy.intermediariesPaging.noun |
string, or null | ||
delegationPolicy.intermediariesPaging.page |
integer | ||
delegationPolicy.intermediariesPaging.pages |
integer | ||
delegationPolicy.intermediariesPaging.param |
string, or null | ||
delegationPolicy.intermediariesPaging.perPage |
integer | ||
delegationPolicy.intermediariesPaging.total |
integer | ||
delegationPolicy.pairs |
list | ||
delegationPolicy.pairs[].attribute |
string | ||
delegationPolicy.pairs[].impersonates |
boolean | ||
delegationPolicy.pairs[].intermediary |
string | ||
delegationPolicy.pairs[].mechanism |
string | ||
delegationPolicy.pairs[].setOn |
string | ||
delegationPolicy.pairs[].setOnRole |
string | ||
delegationPolicy.pairs[].subjectGroups |
list | ||
delegationPolicy.pairs[].subjectGroups[] |
string | ||
delegationPolicy.pairs[].target |
string | ||
delegationPolicy.pairs[].targetApplication |
string, or null | ||
delegationPolicy.pairs[].targetKnown |
boolean | ||
delegationPolicy.pairs[].warning |
string | ||
delegationPolicy.pairsPaging |
object | ||
delegationPolicy.pairsPaging.firstRow |
integer | ||
delegationPolicy.pairsPaging.lastRow |
integer | ||
delegationPolicy.pairsPaging.noun |
string, or null | ||
delegationPolicy.pairsPaging.page |
integer | ||
delegationPolicy.pairsPaging.pages |
integer | ||
delegationPolicy.pairsPaging.param |
string, or null | ||
delegationPolicy.pairsPaging.perPage |
integer | ||
delegationPolicy.pairsPaging.total |
integer | ||
delegationPolicy.people |
list | ||
delegationPolicy.people[].defaultSemantics |
string | ||
delegationPolicy.people[].dn |
string | ||
delegationPolicy.people[].mayAct |
string | ||
delegationPolicy.people[].notDelegated |
boolean | ||
delegationPolicy.people[].semantics |
list | ||
delegationPolicy.people[].semantics[] |
string | ||
delegationPolicy.people[].username |
string | ||
delegationPolicy.peoplePaging |
object | ||
delegationPolicy.peoplePaging.firstRow |
integer | ||
delegationPolicy.peoplePaging.lastRow |
integer | ||
delegationPolicy.peoplePaging.noun |
string, or null | ||
delegationPolicy.peoplePaging.page |
integer | ||
delegationPolicy.peoplePaging.pages |
integer | ||
delegationPolicy.peoplePaging.param |
string, or null | ||
delegationPolicy.peoplePaging.perPage |
integer | ||
delegationPolicy.peoplePaging.total |
integer | ||
delegationPolicy.protectedGroups |
list | ||
delegationPolicy.protectedGroups[] |
string | ||
dropped |
integer | ||
exchangePolicyView |
object | ||
exchangePolicyView.intermediaries |
object | ||
exchangePolicyView.intermediaries.paging |
object | ||
exchangePolicyView.intermediaries.paging.firstRow |
integer | ||
exchangePolicyView.intermediaries.paging.lastRow |
integer | ||
exchangePolicyView.intermediaries.paging.noun |
string, or null | ||
exchangePolicyView.intermediaries.paging.page |
integer | ||
exchangePolicyView.intermediaries.paging.pages |
integer | ||
exchangePolicyView.intermediaries.paging.param |
string, or null | ||
exchangePolicyView.intermediaries.paging.perPage |
integer | ||
exchangePolicyView.intermediaries.paging.total |
integer | ||
exchangePolicyView.intermediaries.shown |
list | ||
exchangePolicyView.intermediaries.shown[].application |
string | ||
exchangePolicyView.intermediaries.shown[].defaultSemantics |
string | ||
exchangePolicyView.intermediaries.shown[].impersonates |
boolean | ||
exchangePolicyView.intermediaries.shown[].notDelegated |
boolean | ||
exchangePolicyView.intermediaries.shown[].semantics |
list | ||
exchangePolicyView.intermediaries.shown[].semantics[] |
string | ||
exchangePolicyView.intermediaries.shown[].subjectGroups |
list | ||
exchangePolicyView.intermediaries.shown[].subjectGroups[] |
string | ||
exchangePolicyView.pairs |
object | ||
exchangePolicyView.pairs.paging |
object | ||
exchangePolicyView.pairs.paging.firstRow |
integer | ||
exchangePolicyView.pairs.paging.lastRow |
integer | ||
exchangePolicyView.pairs.paging.noun |
string, or null | ||
exchangePolicyView.pairs.paging.page |
integer | ||
exchangePolicyView.pairs.paging.pages |
integer | ||
exchangePolicyView.pairs.paging.param |
string, or null | ||
exchangePolicyView.pairs.paging.perPage |
integer | ||
exchangePolicyView.pairs.paging.total |
integer | ||
exchangePolicyView.pairs.shown |
list | ||
exchangePolicyView.pairs.shown[].attribute |
string | ||
exchangePolicyView.pairs.shown[].impersonates |
boolean | ||
exchangePolicyView.pairs.shown[].intermediary |
string | ||
exchangePolicyView.pairs.shown[].mechanism |
string | ||
exchangePolicyView.pairs.shown[].setOn |
string | ||
exchangePolicyView.pairs.shown[].setOnRole |
string | ||
exchangePolicyView.pairs.shown[].subjectGroups |
list | ||
exchangePolicyView.pairs.shown[].subjectGroups[] |
string | ||
exchangePolicyView.pairs.shown[].target |
string | ||
exchangePolicyView.pairs.shown[].targetApplication |
string, or null | ||
exchangePolicyView.pairs.shown[].targetKnown |
boolean | ||
exchangePolicyView.pairs.shown[].warning |
string | ||
exchangePolicyView.people |
object | ||
exchangePolicyView.people.paging |
object | ||
exchangePolicyView.people.paging.firstRow |
integer | ||
exchangePolicyView.people.paging.lastRow |
integer | ||
exchangePolicyView.people.paging.noun |
string, or null | ||
exchangePolicyView.people.paging.page |
integer | ||
exchangePolicyView.people.paging.pages |
integer | ||
exchangePolicyView.people.paging.param |
string, or null | ||
exchangePolicyView.people.paging.perPage |
integer | ||
exchangePolicyView.people.paging.total |
integer | ||
exchangePolicyView.people.shown |
list | ||
exchangePolicyView.people.shown[].defaultSemantics |
string | ||
exchangePolicyView.people.shown[].dn |
string | ||
exchangePolicyView.people.shown[].mayAct |
string | ||
exchangePolicyView.people.shown[].notDelegated |
boolean | ||
exchangePolicyView.people.shown[].semantics |
list | ||
exchangePolicyView.people.shown[].semantics[] |
string | ||
exchangePolicyView.people.shown[].username |
string | ||
exchangePolicyView.register |
object | ||
exchangePolicyView.register.attributes |
map | ||
exchangePolicyView.register.attributes.{key} |
string | ||
exchangePolicyView.register.enforced |
boolean | ||
exchangePolicyView.register.intermediaries |
list | ||
exchangePolicyView.register.intermediaries[].application |
string | ||
exchangePolicyView.register.intermediaries[].defaultSemantics |
string | ||
exchangePolicyView.register.intermediaries[].impersonates |
boolean | ||
exchangePolicyView.register.intermediaries[].notDelegated |
boolean | ||
exchangePolicyView.register.intermediaries[].semantics |
list | ||
exchangePolicyView.register.intermediaries[].semantics[] |
string | ||
exchangePolicyView.register.intermediaries[].subjectGroups |
list | ||
exchangePolicyView.register.intermediaries[].subjectGroups[] |
string | ||
exchangePolicyView.register.pairs |
list | ||
exchangePolicyView.register.pairs[].attribute |
string | ||
exchangePolicyView.register.pairs[].impersonates |
boolean | ||
exchangePolicyView.register.pairs[].intermediary |
string | ||
exchangePolicyView.register.pairs[].mechanism |
string | ||
exchangePolicyView.register.pairs[].setOn |
string | ||
exchangePolicyView.register.pairs[].setOnRole |
string | ||
exchangePolicyView.register.pairs[].subjectGroups |
list | ||
exchangePolicyView.register.pairs[].subjectGroups[] |
string | ||
exchangePolicyView.register.pairs[].target |
string | ||
exchangePolicyView.register.pairs[].targetApplication |
string, or null | ||
exchangePolicyView.register.pairs[].targetKnown |
boolean | ||
exchangePolicyView.register.pairs[].warning |
string | ||
exchangePolicyView.register.people |
list | ||
exchangePolicyView.register.people[].defaultSemantics |
string | ||
exchangePolicyView.register.people[].dn |
string | ||
exchangePolicyView.register.people[].mayAct |
string | ||
exchangePolicyView.register.people[].notDelegated |
boolean | ||
exchangePolicyView.register.people[].semantics |
list | ||
exchangePolicyView.register.people[].semantics[] |
string | ||
exchangePolicyView.register.people[].username |
string | ||
exchangePolicyView.register.protectedGroups |
list | ||
exchangePolicyView.register.protectedGroups[] |
string | ||
facts |
object | ||
facts.apps |
map | ||
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | ||
facts.users.{key} |
boolean | ||
filter |
object | ||
filter.mode |
string, or null | ||
filter.outcome |
string, or null | ||
filter.protocol |
string, or null | ||
filter.q |
string, or null | ||
filter.type |
string, or null | ||
firstRow |
integer | ||
flagPage |
object | ||
flagPage.paging |
object | ||
flagPage.paging.firstRow |
integer | ||
flagPage.paging.lastRow |
integer | ||
flagPage.paging.noun |
string, or null | ||
flagPage.paging.page |
integer | ||
flagPage.paging.pages |
integer | ||
flagPage.paging.param |
string, or null | ||
flagPage.paging.perPage |
integer | ||
flagPage.paging.total |
integer | ||
flagPage.shown |
list | ||
flagPage.shown[].autoCreated |
boolean | ||
flagPage.shown[].description |
string | ||
flagPage.shown[].effects |
list | ||
flagPage.shown[].effects[] |
string | ||
flagPage.shown[].notDelegated |
boolean | ||
flagPage.shown[].okAsDelegate |
boolean | ||
flagPage.shown[].principal |
string | ||
flagPage.shown[].realm |
string | ||
flagPage.shown[].trustedToAuthenticateForDelegation |
boolean | ||
graph |
object | ||
graph.acts |
integer | ||
graph.chains |
integer | ||
graph.counts |
object | ||
graph.counts.edges |
integer | ||
graph.counts.grants |
integer | ||
graph.counts.nodes |
integer | ||
graph.credentials |
list | ||
graph.credentials[].at |
number, or null | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number, or null | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string, or null | ||
graph.credentials[].flowOidc |
string, or null | ||
graph.credentials[].flowProtocol |
string, or null | ||
graph.credentials[].flowSpec |
string, or null | ||
graph.credentials[].flowStated |
boolean | ||
graph.credentials[].holder |
string | ||
graph.credentials[].identifier |
string | ||
graph.credentials[].issuer |
string | ||
graph.credentials[].kind |
string | ||
graph.credentials[].revocable |
boolean | ||
graph.credentials[].revoked |
boolean | ||
graph.credentials[].scope |
string | ||
graph.credentials[].sessionId |
string | ||
graph.credentials[].state |
string, or null | ||
graph.credentialsOnDelegationLines |
integer | ||
graph.edges |
list | ||
graph.edges[].actor |
string, or null | ||
graph.edges[].acts |
integer | ||
graph.edges[].asked |
boolean | ||
graph.edges[].attribute |
string | ||
graph.edges[].audience |
string | ||
graph.edges[].audienceRegistered |
boolean | ||
graph.edges[].authentications |
list | ||
graph.edges[].authentications[].at |
number, or null | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number, or null | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string, or null | ||
graph.edges[].chainKey |
string | ||
graph.edges[].consumed |
list | ||
graph.edges[].consumed[].count |
integer | ||
graph.edges[].consumed[].identifiers |
list | ||
graph.edges[].consumed[].identifiers[] |
string | ||
graph.edges[].consumed[].kind |
string | ||
graph.edges[].consumed[].moreIdentifiers |
integer | ||
graph.edges[].consumed[].notes |
list | ||
graph.edges[].consumed[].notes[] |
string | ||
graph.edges[].consumedFold |
map | ||
graph.edges[].consumedFold.{key}.count |
integer | ||
graph.edges[].consumedFold.{key}.identifiers |
list | ||
graph.edges[].consumedFold.{key}.identifiers[] |
string | ||
graph.edges[].consumedFold.{key}.kind |
string | ||
graph.edges[].consumedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].consumedFold.{key}.notes |
list | ||
graph.edges[].consumedFold.{key}.notes[] |
string | ||
graph.edges[].credentials |
integer | ||
graph.edges[].description |
string, or null | ||
graph.edges[].firstAt |
number, or null | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number, or null | ||
graph.edges[].mechanism |
string | ||
graph.edges[].mode |
string | ||
graph.edges[].permissionId |
string | ||
graph.edges[].permissionName |
string | ||
graph.edges[].permissions |
list | ||
graph.edges[].permissions[] |
string | ||
graph.edges[].policed |
boolean | ||
graph.edges[].produced |
list | ||
graph.edges[].produced[].count |
integer | ||
graph.edges[].produced[].identifiers |
list | ||
graph.edges[].produced[].identifiers[] |
string | ||
graph.edges[].produced[].kind |
string | ||
graph.edges[].produced[].moreIdentifiers |
integer | ||
graph.edges[].produced[].notes |
list | ||
graph.edges[].produced[].notes[] |
string | ||
graph.edges[].producedFold |
map | ||
graph.edges[].producedFold.{key}.count |
integer | ||
graph.edges[].producedFold.{key}.identifiers |
list | ||
graph.edges[].producedFold.{key}.identifiers[] |
string | ||
graph.edges[].producedFold.{key}.kind |
string | ||
graph.edges[].producedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].producedFold.{key}.notes |
list | ||
graph.edges[].producedFold.{key}.notes[] |
string | ||
graph.edges[].protocol |
string, or null | ||
graph.edges[].protocols |
list | ||
graph.edges[].protocols[] |
string | ||
graph.edges[].reason |
string | ||
graph.edges[].refused |
integer | ||
graph.edges[].relation |
string | ||
graph.edges[].scopes |
list | ||
graph.edges[].scopes[] |
string | ||
graph.edges[].setOn |
string | ||
graph.edges[].skipped |
list | ||
graph.edges[].skipped[] |
string | ||
graph.edges[].spec |
string, or null | ||
graph.edges[].subject |
string, or null | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string, or null | ||
graph.edges[].typeLabel |
string, or null | ||
graph.edges[].used |
boolean | ||
graph.issuer |
string | ||
graph.maxTokenRows |
integer | ||
graph.nodes |
list | ||
graph.nodes[].acts |
integer | ||
graph.nodes[].aliases |
list | ||
graph.nodes[].aliases[] |
string | ||
graph.nodes[].application |
string | ||
graph.nodes[].authentications |
integer | ||
graph.nodes[].chiefRole |
string | ||
graph.nodes[].credentials |
integer | ||
graph.nodes[].dangling |
integer | ||
graph.nodes[].exposes |
integer | ||
graph.nodes[].firstAt |
number, or null | ||
graph.nodes[].flows |
list | ||
graph.nodes[].flows[] |
string | ||
graph.nodes[].grants |
integer | ||
graph.nodes[].id |
string | ||
graph.nodes[].isClient |
boolean | ||
graph.nodes[].isSubject |
boolean | ||
graph.nodes[].issued |
integer | ||
graph.nodes[].issuer |
string | ||
graph.nodes[].key |
string | ||
graph.nodes[].kind |
string | ||
graph.nodes[].kinds |
list | ||
graph.nodes[].kinds[] |
string | ||
graph.nodes[].lastAt |
number, or null | ||
graph.nodes[].presented |
string | ||
graph.nodes[].protocols |
list | ||
graph.nodes[].protocols[] |
string | ||
graph.nodes[].realm |
object | ||
graph.nodes[].realm.id |
string | ||
graph.nodes[].realm.isDefault |
boolean | ||
graph.nodes[].realm.name |
string, or null | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
number | ||
graph.nodes[].roles.intermediary |
number | ||
graph.nodes[].roles.target |
number | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string, or null | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string, or null | ||
graph.tokens[].at |
number, or null | ||
graph.tokens[].chainKey |
string | ||
graph.tokens[].identifier |
string | ||
graph.tokens[].kind |
string | ||
graph.tokens[].mode |
string | ||
graph.tokens[].note |
string | ||
graph.tokens[].protocol |
string | ||
graph.tokens[].seq |
number | ||
graph.tokens[].subject |
string, or null | ||
graph.tokens[].target |
string, or null | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
held |
integer | ||
heldHere |
integer | ||
lastRow |
integer | ||
matched |
integer | ||
maxRecords |
integer | ||
mechanismPage |
object | ||
mechanismPage.paging |
object | ||
mechanismPage.paging.firstRow |
integer | ||
mechanismPage.paging.lastRow |
integer | ||
mechanismPage.paging.noun |
string, or null | ||
mechanismPage.paging.page |
integer | ||
mechanismPage.paging.pages |
integer | ||
mechanismPage.paging.param |
string, or null | ||
mechanismPage.paging.perPage |
integer | ||
mechanismPage.paging.total |
integer | ||
mechanismPage.shown |
list | ||
mechanismPage.shown[].label |
string | ||
mechanismPage.shown[].mode |
string | ||
mechanismPage.shown[].policed |
boolean | ||
mechanismPage.shown[].protocol |
string | ||
mechanismPage.shown[].spec |
string | ||
mechanismPage.shown[].type |
string | ||
mechanismPage.shown[].what |
string | ||
modes |
list | ||
modes[].label |
string | ||
modes[].mode |
string | ||
modes[].what |
string | ||
newestSeq |
number | ||
oldestSeq |
number | ||
outcomes |
list | ||
outcomes[] |
string | ||
page |
integer | ||
pages |
integer | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string, or null | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string, or null | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
pairPage |
object | ||
pairPage.paging |
object | ||
pairPage.paging.firstRow |
integer | ||
pairPage.paging.lastRow |
integer | ||
pairPage.paging.noun |
string, or null | ||
pairPage.paging.page |
integer | ||
pairPage.paging.pages |
integer | ||
pairPage.paging.param |
string, or null | ||
pairPage.paging.perPage |
integer | ||
pairPage.paging.total |
integer | ||
pairPage.shown |
list | ||
pairPage.shown[].attribute |
string | ||
pairPage.shown[].frontEnd |
string | ||
pairPage.shown[].mechanism |
string | ||
pairPage.shown[].note |
string | ||
pairPage.shown[].realm |
string | ||
pairPage.shown[].requires |
string | ||
pairPage.shown[].setOn |
string | ||
pairPage.shown[].setOnRole |
string | ||
pairPage.shown[].target |
string | ||
pairPage.shown[].targetKnown |
boolean | ||
pairPage.shown[].type |
string | ||
pairPage.shown[].warning |
string | ||
perPage |
integer | ||
permissionsView |
object | ||
permissionsView.allApplications |
list | ||
permissionsView.allApplications[].identifier |
string | ||
permissionsView.allApplications[].name |
string | ||
permissionsView.listState |
object | ||
permissionsView.listState.grantPage |
object | ||
permissionsView.listState.grantPage.paging |
object | ||
permissionsView.listState.grantPage.paging.firstRow |
integer | ||
permissionsView.listState.grantPage.paging.lastRow |
integer | ||
permissionsView.listState.grantPage.paging.noun |
string, or null | ||
permissionsView.listState.grantPage.paging.page |
integer | ||
permissionsView.listState.grantPage.paging.pages |
integer | ||
permissionsView.listState.grantPage.paging.param |
string, or null | ||
permissionsView.listState.grantPage.paging.perPage |
integer | ||
permissionsView.listState.grantPage.paging.total |
integer | ||
permissionsView.listState.grantPage.shown |
list | ||
permissionsView.listState.grantPage.shown[].asked |
boolean | ||
permissionsView.listState.grantPage.shown[].baseUri |
string, or null | ||
permissionsView.listState.grantPage.shown[].client |
string | ||
permissionsView.listState.grantPage.shown[].clientName |
string | ||
permissionsView.listState.grantPage.shown[].dangling |
boolean | ||
permissionsView.listState.grantPage.shown[].description |
string, or null | ||
permissionsView.listState.grantPage.shown[].permissionId |
string | ||
permissionsView.listState.grantPage.shown[].permissionName |
string, or null | ||
permissionsView.listState.grantPage.shown[].resource |
string | ||
permissionsView.listState.grantPage.shown[].resourceName |
string | ||
permissionsView.listState.grantWanted |
string | ||
permissionsView.listState.permPage |
object | ||
permissionsView.listState.permPage.paging |
object | ||
permissionsView.listState.permPage.paging.firstRow |
integer | ||
permissionsView.listState.permPage.paging.lastRow |
integer | ||
permissionsView.listState.permPage.paging.noun |
string, or null | ||
permissionsView.listState.permPage.paging.page |
integer | ||
permissionsView.listState.permPage.paging.pages |
integer | ||
permissionsView.listState.permPage.paging.param |
string, or null | ||
permissionsView.listState.permPage.paging.perPage |
integer | ||
permissionsView.listState.permPage.paging.total |
integer | ||
permissionsView.listState.permPage.shown |
list | ||
permissionsView.listState.permPage.shown[].baseUri |
string, or null | ||
permissionsView.listState.permPage.shown[].description |
string, or null | ||
permissionsView.listState.permPage.shown[].grantedTo |
list | ||
permissionsView.listState.permPage.shown[].grantedTo[].asked |
boolean | ||
permissionsView.listState.permPage.shown[].grantedTo[].identifier |
string | ||
permissionsView.listState.permPage.shown[].grantedTo[].name |
string | ||
permissionsView.listState.permPage.shown[].id |
string, or null | ||
permissionsView.listState.permPage.shown[].name |
string, or null | ||
permissionsView.listState.permPage.shown[].raw |
string, or null | ||
permissionsView.listState.permPage.shown[].resource |
string | ||
permissionsView.listState.permPage.shown[].resourceName |
string | ||
permissionsView.listState.permWanted |
string | ||
permissionsView.register |
object | ||
permissionsView.register.counts |
object | ||
permissionsView.register.counts.clients |
integer | ||
permissionsView.register.counts.dangling |
integer | ||
permissionsView.register.counts.grants |
integer | ||
permissionsView.register.counts.permissions |
integer | ||
permissionsView.register.counts.resources |
integer | ||
permissionsView.register.counts.ungranted |
integer | ||
permissionsView.register.counts.unidentified |
integer | ||
permissionsView.register.counts.unused |
integer | ||
permissionsView.register.grants |
list | ||
permissionsView.register.grants[].asked |
boolean | ||
permissionsView.register.grants[].baseUri |
string, or null | ||
permissionsView.register.grants[].client |
string | ||
permissionsView.register.grants[].clientName |
string | ||
permissionsView.register.grants[].dangling |
boolean | ||
permissionsView.register.grants[].description |
string, or null | ||
permissionsView.register.grants[].permissionId |
string | ||
permissionsView.register.grants[].permissionName |
string, or null | ||
permissionsView.register.grants[].resource |
string | ||
permissionsView.register.grants[].resourceName |
string | ||
permissionsView.register.permissions |
list | ||
permissionsView.register.permissions[].baseUri |
string, or null | ||
permissionsView.register.permissions[].description |
string, or null | ||
permissionsView.register.permissions[].grantedTo |
list | ||
permissionsView.register.permissions[].grantedTo[].asked |
boolean | ||
permissionsView.register.permissions[].grantedTo[].identifier |
string | ||
permissionsView.register.permissions[].grantedTo[].name |
string | ||
permissionsView.register.permissions[].id |
string, or null | ||
permissionsView.register.permissions[].name |
string, or null | ||
permissionsView.register.permissions[].raw |
string, or null | ||
permissionsView.register.permissions[].resource |
string | ||
permissionsView.register.permissions[].resourceName |
string | ||
permissionsView.register.resources |
list | ||
permissionsView.register.resources[].baseUri |
string, or null | ||
permissionsView.register.resources[].grantsHeld |
integer | ||
permissionsView.register.resources[].identifier |
string | ||
permissionsView.register.resources[].name |
string | ||
permissionsView.register.resources[].permissions |
list | ||
permissionsView.register.resources[].permissions[].description |
string, or null | ||
permissionsView.register.resources[].permissions[].grantedTo |
list | ||
permissionsView.register.resources[].permissions[].grantedTo[].asked |
object | Nested deeper than this page draws. | |
permissionsView.register.resources[].permissions[].grantedTo[].identifier |
object | Nested deeper than this page draws. | |
permissionsView.register.resources[].permissions[].grantedTo[].name |
object | Nested deeper than this page draws. | |
permissionsView.register.resources[].permissions[].id |
string, or null | ||
permissionsView.register.resources[].permissions[].name |
string, or null | ||
permissionsView.register.resources[].permissions[].raw |
string, or null | ||
permissionsView.register.resources[].rawBaseUri |
string | ||
policy |
object | ||
policy.accounts |
list | ||
policy.accounts[].autoCreated |
boolean | ||
policy.accounts[].description |
string | ||
policy.accounts[].effects |
list | ||
policy.accounts[].effects[] |
string | ||
policy.accounts[].notDelegated |
boolean | ||
policy.accounts[].okAsDelegate |
boolean | ||
policy.accounts[].principal |
string | ||
policy.accounts[].realm |
string | ||
policy.accounts[].trustedToAuthenticateForDelegation |
boolean | ||
policy.pairs |
list | ||
policy.pairs[].attribute |
string | ||
policy.pairs[].frontEnd |
string | ||
policy.pairs[].mechanism |
string | ||
policy.pairs[].note |
string | ||
policy.pairs[].realm |
string | ||
policy.pairs[].requires |
string | ||
policy.pairs[].setOn |
string | ||
policy.pairs[].setOnRole |
string | ||
policy.pairs[].target |
string | ||
policy.pairs[].targetKnown |
boolean | ||
policy.pairs[].type |
string | ||
policy.pairs[].warning |
string | ||
processes |
integer | ||
recorded |
integer | ||
roles |
list | ||
roles[].label |
string | ||
roles[].role |
string | ||
roles[].what |
string | ||
shown |
integer | ||
types |
list | ||
types[].label |
string | ||
types[].mode |
string | ||
types[].policed |
boolean | ||
types[].protocol |
string | ||
types[].spec |
string | ||
types[].type |
string | ||
types[].what |
string | ||
userChooser |
object | ||
userChooser.complete |
boolean | ||
userChooser.entries |
list | ||
userChooser.entries[].detail |
string | ||
userChooser.entries[].href |
string | ||
userChooser.entries[].key |
string | ||
userChooser.entries[].label |
string | ||
userChooser.entries[].names |
list | ||
userChooser.entries[].names[] |
string, or null | ||
userChooser.search |
string | ||
userChooser.slice |
object | ||
userChooser.slice.from |
integer | ||
userChooser.slice.matched |
integer | ||
userChooser.total |
integer |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean |
GET /admin-api/delegation/application
getDelegationApplication
Everything delegated through one application or to it
Every act an application took part in, in EITHER role — the intermediary acting for somebody and the target a credential is for — with the role it played in each (rolesBySeq), the graph of those acts and, as for /delegation/map, looks, the drawing (svg) and its size. applications is every application some act named, which is what the page’s chooser searches.
An application no act names is answered with application: null, not an error: the store is capped and drops the oldest.
The drawing is the console’s: GET /admin-api/console/delegation/application.
Mirrors GET /admin/delegation/application on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
application |
query | string | The application, as a protocol presented it or normalised. | |
type |
query | one of krb5-s4u2self, krb5-s4u2proxy-classic, krb5-s4u2proxy-rbcd, krb5-forwarded, wstrust-onbehalfof, wstrust-actas, oauth-impersonation, oauth-delegation, oauth-assertion-grant, oauth-saml-assertion-grant, gnap-impersonation, gnap-derivation |
One mechanism. The reply’s types member describes each of them, with the specification it comes from and whether this service polices it. |
|
mode |
query | one of impersonation, delegation |
The protocol-independent axis: whether what came out carries the chain. ANDed with type, so a mode that does not match the mechanism matches nothing. |
|
outcome |
query | one of issued, refused |
Two rather than the audit log’s three: a delegation is DECIDED rather than performed, so there is no third answer between issuing the credential and refusing to. | |
protocol |
query | string | The family, spelled as /admin-api/users spells it — Kerberos v5, WS-Trust, OAuth 2.0. Free text rather than an enum, for the reason the audit log’s protocol is. |
|
q |
query | string | Substring of ANY party of the chain (normalised name, presented form or application) or of either explanation, case-insensitive. One box over six fields, because the fact a caller has names one of them and not which column it is in. | |
page |
query | integer | Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is. | |
per |
query | integer | Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own. | |
permq |
query | string | Part of a permission’s resource. | |
grantq |
query | string | Part of a grant’s client or resource. | |
appq |
query | string | The application chooser’s search. | |
userq |
query | string | The person chooser’s search. | |
appfrom |
query | integer | Where the application chooser’s page starts. | |
userfrom |
query | integer | Where the person chooser’s page starts. | |
chainsPage |
query | integer | Which page of chains to return, clamped as page is. |
|
permissionsPage |
query | integer | Which page of permissions to return, clamped as page is. |
|
grantsPage |
query | integer | Which page of grants to return, clamped as page is. |
|
pairsPage |
query | integer | Which page of pairs to return, clamped as page is. |
|
flagsPage |
query | integer | Which page of flags to return, clamped as page is. |
|
mechanismsPage |
query | integer | Which page of mechanisms to return, clamped as page is. |
|
policyPairsPage |
query | integer | Which page of policyPairs to return, clamped as page is. |
|
intermediariesPage |
query | integer | Which page of intermediaries to return, clamped as page is. |
|
peoplePage |
query | integer | Which page of people to return, clamped as page is. |
|
groupsPage |
query | integer | Which page of groups to return, clamped as page is. |
|
groupGrantsPage |
query | integer | Which page of groupGrants to return, clamped as page is. |
|
groupPermissionsPage |
query | integer | Which page of groupPermissions to return, clamped as page 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 application, its acts, the graph, every node’s look and the drawing.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
acts |
list | ||
acts[].at |
number, or null | ||
acts[].authorizedBy |
string | ||
acts[].chainKey |
string | ||
acts[].consumed |
list | ||
acts[].consumed[].identifier |
string | ||
acts[].consumed[].kind |
string | ||
acts[].consumed[].note |
string | ||
acts[].initial |
object | ||
acts[].initial.application |
string | ||
acts[].initial.key |
string | ||
acts[].initial.presented |
string | ||
acts[].initial.what |
string | ||
acts[].intermediary |
object | ||
acts[].intermediary.application |
string | ||
acts[].intermediary.key |
string | ||
acts[].intermediary.presented |
string | ||
acts[].intermediary.what |
string | ||
acts[].mode |
string | ||
acts[].note |
string | ||
acts[].origin |
string | ||
acts[].outcome |
string | ||
acts[].policed |
boolean | ||
acts[].produced |
list | ||
acts[].produced[].identifier |
string | ||
acts[].produced[].kind |
string | ||
acts[].produced[].note |
string | ||
acts[].protocol |
string | ||
acts[].reason |
string | ||
acts[].seq |
number | ||
acts[].sessionId |
string | ||
acts[].spec |
string | ||
acts[].target |
object | ||
acts[].target.application |
string | ||
acts[].target.key |
string | ||
acts[].target.presented |
string | ||
acts[].target.what |
string | ||
acts[].type |
string | ||
acts[].typeLabel |
string | ||
application |
object | ||
application.acts |
integer | ||
application.chains |
integer | ||
application.credentials |
integer | ||
application.firstAt |
number, or null | ||
application.identifier |
string | ||
application.identityKey |
string | ||
application.issued |
integer | ||
application.key |
string | ||
application.lastAt |
number, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.refused |
integer | ||
application.roles |
object | ||
application.roles.initial |
number | ||
application.roles.intermediary |
number | ||
application.roles.target |
number | ||
application.spellings |
list | ||
application.spellings[] |
string | ||
applications |
list | ||
applications[].acts |
integer | ||
applications[].chains |
integer | ||
applications[].credentials |
integer | ||
applications[].firstAt |
number, or null | ||
applications[].identifier |
string | ||
applications[].identityKey |
string | ||
applications[].issued |
integer | ||
applications[].key |
string | ||
applications[].lastAt |
number, or null | ||
applications[].protocols |
list | ||
applications[].protocols[] |
string | ||
applications[].refused |
integer | ||
applications[].roles |
object | ||
applications[].roles.initial |
number | ||
applications[].roles.intermediary |
number | ||
applications[].roles.target |
number | ||
applications[].spellings |
list | ||
applications[].spellings[] |
string | ||
asked |
string, or null | ||
chooser |
object | ||
chooser.complete |
boolean | ||
chooser.entries |
list | ||
chooser.entries[].detail |
string | ||
chooser.entries[].href |
string | ||
chooser.entries[].key |
string | ||
chooser.entries[].label |
string | ||
chooser.entries[].names |
list | ||
chooser.entries[].names[] |
string, or null | ||
chooser.search |
string | ||
chooser.slice |
object | ||
chooser.slice.from |
integer | ||
chooser.slice.matched |
integer | ||
chooser.total |
integer | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.verifiesCredentials |
boolean | Whether this realm verifies what is presented (its mode), which one sentence of a picture’s tooltips turns on. The console lays the picture out in the browser from the answer’s data and reads it there (#444). | |
drawing.width |
number | ||
facts |
object | ||
facts.apps |
map | ||
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | ||
facts.users.{key} |
boolean | ||
graph |
object | ||
graph.acts |
integer | ||
graph.chains |
integer | ||
graph.counts |
object | ||
graph.counts.edges |
integer | ||
graph.counts.grants |
integer | ||
graph.counts.nodes |
integer | ||
graph.credentials |
list | ||
graph.credentials[].at |
number, or null | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number, or null | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string, or null | ||
graph.credentials[].flowOidc |
string, or null | ||
graph.credentials[].flowProtocol |
string, or null | ||
graph.credentials[].flowSpec |
string, or null | ||
graph.credentials[].flowStated |
boolean | ||
graph.credentials[].holder |
string | ||
graph.credentials[].identifier |
string | ||
graph.credentials[].issuer |
string | ||
graph.credentials[].kind |
string | ||
graph.credentials[].revocable |
boolean | ||
graph.credentials[].revoked |
boolean | ||
graph.credentials[].scope |
string | ||
graph.credentials[].sessionId |
string | ||
graph.credentials[].state |
string, or null | ||
graph.credentialsOnDelegationLines |
integer | ||
graph.edges |
list | ||
graph.edges[].actor |
string, or null | ||
graph.edges[].acts |
integer | ||
graph.edges[].asked |
boolean | ||
graph.edges[].attribute |
string | ||
graph.edges[].audience |
string | ||
graph.edges[].audienceRegistered |
boolean | ||
graph.edges[].authentications |
list | ||
graph.edges[].authentications[].at |
number, or null | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number, or null | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string, or null | ||
graph.edges[].chainKey |
string | ||
graph.edges[].consumed |
list | ||
graph.edges[].consumed[].count |
integer | ||
graph.edges[].consumed[].identifiers |
list | ||
graph.edges[].consumed[].identifiers[] |
string | ||
graph.edges[].consumed[].kind |
string | ||
graph.edges[].consumed[].moreIdentifiers |
integer | ||
graph.edges[].consumed[].notes |
list | ||
graph.edges[].consumed[].notes[] |
string | ||
graph.edges[].consumedFold |
map | ||
graph.edges[].consumedFold.{key}.count |
integer | ||
graph.edges[].consumedFold.{key}.identifiers |
list | ||
graph.edges[].consumedFold.{key}.identifiers[] |
string | ||
graph.edges[].consumedFold.{key}.kind |
string | ||
graph.edges[].consumedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].consumedFold.{key}.notes |
list | ||
graph.edges[].consumedFold.{key}.notes[] |
string | ||
graph.edges[].credentials |
integer | ||
graph.edges[].description |
string, or null | ||
graph.edges[].firstAt |
number, or null | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number, or null | ||
graph.edges[].mechanism |
string | ||
graph.edges[].mode |
string | ||
graph.edges[].permissionId |
string | ||
graph.edges[].permissionName |
string | ||
graph.edges[].permissions |
list | ||
graph.edges[].permissions[] |
string | ||
graph.edges[].policed |
boolean | ||
graph.edges[].produced |
list | ||
graph.edges[].produced[].count |
integer | ||
graph.edges[].produced[].identifiers |
list | ||
graph.edges[].produced[].identifiers[] |
string | ||
graph.edges[].produced[].kind |
string | ||
graph.edges[].produced[].moreIdentifiers |
integer | ||
graph.edges[].produced[].notes |
list | ||
graph.edges[].produced[].notes[] |
string | ||
graph.edges[].producedFold |
map | ||
graph.edges[].producedFold.{key}.count |
integer | ||
graph.edges[].producedFold.{key}.identifiers |
list | ||
graph.edges[].producedFold.{key}.identifiers[] |
string | ||
graph.edges[].producedFold.{key}.kind |
string | ||
graph.edges[].producedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].producedFold.{key}.notes |
list | ||
graph.edges[].producedFold.{key}.notes[] |
string | ||
graph.edges[].protocol |
string, or null | ||
graph.edges[].protocols |
list | ||
graph.edges[].protocols[] |
string | ||
graph.edges[].reason |
string | ||
graph.edges[].refused |
integer | ||
graph.edges[].relation |
string | ||
graph.edges[].scopes |
list | ||
graph.edges[].scopes[] |
string | ||
graph.edges[].setOn |
string | ||
graph.edges[].skipped |
list | ||
graph.edges[].skipped[] |
string | ||
graph.edges[].spec |
string, or null | ||
graph.edges[].subject |
string, or null | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string, or null | ||
graph.edges[].typeLabel |
string, or null | ||
graph.edges[].used |
boolean | ||
graph.issuer |
string | ||
graph.maxTokenRows |
integer | ||
graph.nodes |
list | ||
graph.nodes[].acts |
integer | ||
graph.nodes[].aliases |
list | ||
graph.nodes[].aliases[] |
string | ||
graph.nodes[].application |
string | ||
graph.nodes[].authentications |
integer | ||
graph.nodes[].chiefRole |
string | ||
graph.nodes[].credentials |
integer | ||
graph.nodes[].dangling |
integer | ||
graph.nodes[].exposes |
integer | ||
graph.nodes[].firstAt |
number, or null | ||
graph.nodes[].flows |
list | ||
graph.nodes[].flows[] |
string | ||
graph.nodes[].grants |
integer | ||
graph.nodes[].id |
string | ||
graph.nodes[].isClient |
boolean | ||
graph.nodes[].isSubject |
boolean | ||
graph.nodes[].issued |
integer | ||
graph.nodes[].issuer |
string | ||
graph.nodes[].key |
string | ||
graph.nodes[].kind |
string | ||
graph.nodes[].kinds |
list | ||
graph.nodes[].kinds[] |
string | ||
graph.nodes[].lastAt |
number, or null | ||
graph.nodes[].presented |
string | ||
graph.nodes[].protocols |
list | ||
graph.nodes[].protocols[] |
string | ||
graph.nodes[].realm |
object | ||
graph.nodes[].realm.id |
string | ||
graph.nodes[].realm.isDefault |
boolean | ||
graph.nodes[].realm.name |
string, or null | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
number | ||
graph.nodes[].roles.intermediary |
number | ||
graph.nodes[].roles.target |
number | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string, or null | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string, or null | ||
graph.tokens[].at |
number, or null | ||
graph.tokens[].chainKey |
string | ||
graph.tokens[].identifier |
string | ||
graph.tokens[].kind |
string | ||
graph.tokens[].mode |
string | ||
graph.tokens[].note |
string | ||
graph.tokens[].protocol |
string | ||
graph.tokens[].seq |
number | ||
graph.tokens[].subject |
string, or null | ||
graph.tokens[].target |
string, or null | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
held |
integer | ||
key |
string, or null | ||
label |
string | ||
looks |
map | ||
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string | ||
looks.{key}.title |
string | ||
mapKey |
string | ||
maxRecords |
integer | ||
registered |
boolean | ||
registeredName |
string | ||
roles |
list | ||
roles[].label |
string | ||
roles[].role |
string | ||
roles[].what |
string | ||
rolesBySeq |
map | ||
rolesBySeq.{key} |
list | ||
rolesBySeq.{key}[] |
string | ||
svg |
string |
As image/svg+xml.
GET /admin-api/delegation/policy
getDelegationPolicy
Who may act for whom at WS-Trust and the token exchange
The delegation policy OnBehalfOf / ActAs and the RFC 8693 token exchange are decided by — Kerberos’s model on application entries:
appAllowedToDelegateToon the INTERMEDIARY names the targets it may reach as somebody else;appAllowedToActOnBehalfOfon the TARGET names the intermediaries it accepts;appDelegationSubjectGroupon the intermediary names the groups of people it may act for (empty: anybody unprotected);appDelegationSemanticssays whether it may IMPERSONATE as well as delegate (empty is delegation only),appDefaultDelegationSemanticsits default, andappNotDelegatedthat nobody acts for it.
The issuance policy decides on these facts (#186). pairs has one row per (intermediary, target, attribute); intermediaries the applications carrying the flag or a subject group; people those carrying stsNotDelegated or stsMayAct; protectedGroups the console rosters, whose members are never delegated. enforced is true in product mode; in development the policy is asked and what it would have refused is recorded on the act. Each list is paged: ?policyPairsPage=, ?intermediariesPage=, ?peoplePage=, and ?per= for all three.
Mirrors GET /admin/delegation on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
policyPairsPage |
query | integer | The page of pairs. |
|
intermediariesPage |
query | integer | The page of intermediaries. |
|
peoplePage |
query | integer | The page of people. |
|
per |
query | integer | Rows per page, for all three lists (default 10). | |
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 three lists, each with its paging, and whether the policy is enforced.
| Member | Type | Required | What it is |
|---|---|---|---|
attributes |
map | ||
attributes.{key} |
string | ||
enforced |
boolean | ||
intermediaries |
list | ||
intermediaries[].application |
string | ||
intermediaries[].defaultSemantics |
string | ||
intermediaries[].impersonates |
boolean | ||
intermediaries[].notDelegated |
boolean | ||
intermediaries[].semantics |
list | ||
intermediaries[].semantics[] |
string | ||
intermediaries[].subjectGroups |
list | ||
intermediaries[].subjectGroups[] |
string | ||
intermediariesPaging |
object | ||
intermediariesPaging.firstRow |
integer | ||
intermediariesPaging.lastRow |
integer | ||
intermediariesPaging.noun |
string, or null | ||
intermediariesPaging.page |
integer | ||
intermediariesPaging.pages |
integer | ||
intermediariesPaging.param |
string, or null | ||
intermediariesPaging.perPage |
integer | ||
intermediariesPaging.total |
integer | ||
pairs |
list | ||
pairs[].attribute |
string | ||
pairs[].impersonates |
boolean | ||
pairs[].intermediary |
string | ||
pairs[].mechanism |
string | ||
pairs[].setOn |
string | ||
pairs[].setOnRole |
string | ||
pairs[].subjectGroups |
list | ||
pairs[].subjectGroups[] |
string | ||
pairs[].target |
string | ||
pairs[].targetApplication |
string, or null | ||
pairs[].targetKnown |
boolean | ||
pairs[].warning |
string | ||
pairsPaging |
object | ||
pairsPaging.firstRow |
integer | ||
pairsPaging.lastRow |
integer | ||
pairsPaging.noun |
string, or null | ||
pairsPaging.page |
integer | ||
pairsPaging.pages |
integer | ||
pairsPaging.param |
string, or null | ||
pairsPaging.perPage |
integer | ||
pairsPaging.total |
integer | ||
people |
list | ||
people[].defaultSemantics |
string | ||
people[].dn |
string | ||
people[].mayAct |
string | ||
people[].notDelegated |
boolean | ||
people[].semantics |
list | ||
people[].semantics[] |
string | ||
people[].username |
string | ||
peoplePaging |
object | ||
peoplePaging.firstRow |
integer | ||
peoplePaging.lastRow |
integer | ||
peoplePaging.noun |
string, or null | ||
peoplePaging.page |
integer | ||
peoplePaging.pages |
integer | ||
peoplePaging.param |
string, or null | ||
peoplePaging.perPage |
integer | ||
peoplePaging.total |
integer | ||
protectedGroups |
list | ||
protectedGroups[] |
string |
GET /admin-api/delegation/user
getDelegationUser
Everything issued and delegated in one person’s name
The identity register and the delegation register UNIONED for one person: every credential issued naming them with the grant or flow that produced it (credentials, flows), their sign-ins, every act naming them in any role (acts), the graph and, as for /delegation/map, looks, the drawing (svg) and its size. users is everybody either register holds, which is what the page’s chooser searches.
A name neither register holds is answered with user: null, not an error.
The drawing is the console’s: GET /admin-api/console/delegation/user.
Mirrors GET /admin/delegation/user on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | string | The person, under any spelling this service has seen them under. | |
type |
query | one of krb5-s4u2self, krb5-s4u2proxy-classic, krb5-s4u2proxy-rbcd, krb5-forwarded, wstrust-onbehalfof, wstrust-actas, oauth-impersonation, oauth-delegation, oauth-assertion-grant, oauth-saml-assertion-grant, gnap-impersonation, gnap-derivation |
One mechanism. The reply’s types member describes each of them, with the specification it comes from and whether this service polices it. |
|
mode |
query | one of impersonation, delegation |
The protocol-independent axis: whether what came out carries the chain. ANDed with type, so a mode that does not match the mechanism matches nothing. |
|
outcome |
query | one of issued, refused |
Two rather than the audit log’s three: a delegation is DECIDED rather than performed, so there is no third answer between issuing the credential and refusing to. | |
protocol |
query | string | The family, spelled as /admin-api/users spells it — Kerberos v5, WS-Trust, OAuth 2.0. Free text rather than an enum, for the reason the audit log’s protocol is. |
|
q |
query | string | Substring of ANY party of the chain (normalised name, presented form or application) or of either explanation, case-insensitive. One box over six fields, because the fact a caller has names one of them and not which column it is in. | |
page |
query | integer | Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is. | |
per |
query | integer | Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own. | |
permq |
query | string | Part of a permission’s resource. | |
grantq |
query | string | Part of a grant’s client or resource. | |
appq |
query | string | The application chooser’s search. | |
userq |
query | string | The person chooser’s search. | |
appfrom |
query | integer | Where the application chooser’s page starts. | |
userfrom |
query | integer | Where the person chooser’s page starts. | |
chainsPage |
query | integer | Which page of chains to return, clamped as page is. |
|
permissionsPage |
query | integer | Which page of permissions to return, clamped as page is. |
|
grantsPage |
query | integer | Which page of grants to return, clamped as page is. |
|
pairsPage |
query | integer | Which page of pairs to return, clamped as page is. |
|
flagsPage |
query | integer | Which page of flags to return, clamped as page is. |
|
mechanismsPage |
query | integer | Which page of mechanisms to return, clamped as page is. |
|
policyPairsPage |
query | integer | Which page of policyPairs to return, clamped as page is. |
|
intermediariesPage |
query | integer | Which page of intermediaries to return, clamped as page is. |
|
peoplePage |
query | integer | Which page of people to return, clamped as page is. |
|
groupsPage |
query | integer | Which page of groups to return, clamped as page is. |
|
groupGrantsPage |
query | integer | Which page of groupGrants to return, clamped as page is. |
|
groupPermissionsPage |
query | integer | Which page of groupPermissions to return, clamped as page 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 person, their credentials, flows and acts, the graph, every node’s look and the drawing.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
acts |
list | ||
acts[].at |
number, or null | ||
acts[].authorizedBy |
string | ||
acts[].chainKey |
string | ||
acts[].consumed |
list | ||
acts[].consumed[].identifier |
string | ||
acts[].consumed[].kind |
string | ||
acts[].consumed[].note |
string | ||
acts[].initial |
object | ||
acts[].initial.application |
string | ||
acts[].initial.key |
string | ||
acts[].initial.presented |
string | ||
acts[].initial.what |
string | ||
acts[].intermediary |
object | ||
acts[].intermediary.application |
string | ||
acts[].intermediary.key |
string | ||
acts[].intermediary.presented |
string | ||
acts[].intermediary.what |
string | ||
acts[].mode |
string | ||
acts[].note |
string | ||
acts[].origin |
string | ||
acts[].outcome |
string | ||
acts[].policed |
boolean | ||
acts[].produced |
list | ||
acts[].produced[].identifier |
string | ||
acts[].produced[].kind |
string | ||
acts[].produced[].note |
string | ||
acts[].protocol |
string | ||
acts[].reason |
string | ||
acts[].seq |
number | ||
acts[].sessionId |
string | ||
acts[].spec |
string | ||
acts[].target |
object | ||
acts[].target.application |
string | ||
acts[].target.key |
string | ||
acts[].target.presented |
string | ||
acts[].target.what |
string | ||
acts[].type |
string | ||
acts[].typeLabel |
string | ||
asked |
string, or null | ||
chooser |
object | ||
chooser.complete |
boolean | ||
chooser.entries |
list | ||
chooser.entries[].detail |
string | ||
chooser.entries[].href |
string | ||
chooser.entries[].key |
string | ||
chooser.entries[].label |
string | ||
chooser.entries[].names |
list | ||
chooser.entries[].names[] |
string, or null | ||
chooser.search |
string | ||
chooser.slice |
object | ||
chooser.slice.from |
integer | ||
chooser.slice.matched |
integer | ||
chooser.total |
integer | ||
counts |
object | ||
counts.acts |
integer | ||
counts.applications |
integer | ||
counts.authentications |
integer | ||
counts.chains |
integer | ||
counts.credentials |
integer | ||
credentials |
list | ||
credentials[].at |
number, or null | ||
credentials[].audience |
string | ||
credentials[].detail |
string | ||
credentials[].expiresAtMs |
number, or null | ||
credentials[].family |
string | ||
credentials[].flow |
string | ||
credentials[].flowLabel |
string, or null | ||
credentials[].flowOidc |
string, or null | ||
credentials[].flowProtocol |
string, or null | ||
credentials[].flowSpec |
string, or null | ||
credentials[].flowStated |
boolean | ||
credentials[].holder |
string | ||
credentials[].identifier |
string | ||
credentials[].issuer |
string | ||
credentials[].kind |
string | ||
credentials[].revocable |
boolean | ||
credentials[].revoked |
boolean | ||
credentials[].scope |
string | ||
credentials[].sessionId |
string | ||
credentials[].state |
string, or null | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.verifiesCredentials |
boolean | Whether this realm verifies what is presented (its mode), which one sentence of a picture’s tooltips turns on. The console lays the picture out in the browser from the answer’s data and reads it there (#444). | |
drawing.width |
number | ||
facts |
object | ||
facts.apps |
map | ||
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | ||
facts.users.{key} |
boolean | ||
flows |
list | ||
flows[].browser |
boolean | ||
flows[].flow |
string | ||
flows[].label |
string | ||
flows[].oidc |
string | ||
flows[].protocol |
string | ||
flows[].spec |
string | ||
flows[].unknown |
boolean | ||
flows[].what |
string | ||
graph |
object | ||
graph.acts |
integer | ||
graph.chains |
integer | ||
graph.counts |
object | ||
graph.counts.edges |
integer | ||
graph.counts.grants |
integer | ||
graph.counts.nodes |
integer | ||
graph.credentials |
list | ||
graph.credentials[].at |
number, or null | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number, or null | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string, or null | ||
graph.credentials[].flowOidc |
string, or null | ||
graph.credentials[].flowProtocol |
string, or null | ||
graph.credentials[].flowSpec |
string, or null | ||
graph.credentials[].flowStated |
boolean | ||
graph.credentials[].holder |
string | ||
graph.credentials[].identifier |
string | ||
graph.credentials[].issuer |
string | ||
graph.credentials[].kind |
string | ||
graph.credentials[].revocable |
boolean | ||
graph.credentials[].revoked |
boolean | ||
graph.credentials[].scope |
string | ||
graph.credentials[].sessionId |
string | ||
graph.credentials[].state |
string, or null | ||
graph.credentialsOnDelegationLines |
integer | ||
graph.edges |
list | ||
graph.edges[].actor |
string, or null | ||
graph.edges[].acts |
integer | ||
graph.edges[].asked |
boolean | ||
graph.edges[].attribute |
string | ||
graph.edges[].audience |
string | ||
graph.edges[].audienceRegistered |
boolean | ||
graph.edges[].authentications |
list | ||
graph.edges[].authentications[].at |
number, or null | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number, or null | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string, or null | ||
graph.edges[].chainKey |
string | ||
graph.edges[].consumed |
list | ||
graph.edges[].consumed[].count |
integer | ||
graph.edges[].consumed[].identifiers |
list | ||
graph.edges[].consumed[].identifiers[] |
string | ||
graph.edges[].consumed[].kind |
string | ||
graph.edges[].consumed[].moreIdentifiers |
integer | ||
graph.edges[].consumed[].notes |
list | ||
graph.edges[].consumed[].notes[] |
string | ||
graph.edges[].consumedFold |
map | ||
graph.edges[].consumedFold.{key}.count |
integer | ||
graph.edges[].consumedFold.{key}.identifiers |
list | ||
graph.edges[].consumedFold.{key}.identifiers[] |
string | ||
graph.edges[].consumedFold.{key}.kind |
string | ||
graph.edges[].consumedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].consumedFold.{key}.notes |
list | ||
graph.edges[].consumedFold.{key}.notes[] |
string | ||
graph.edges[].credentials |
integer | ||
graph.edges[].description |
string, or null | ||
graph.edges[].firstAt |
number, or null | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number, or null | ||
graph.edges[].mechanism |
string | ||
graph.edges[].mode |
string | ||
graph.edges[].permissionId |
string | ||
graph.edges[].permissionName |
string | ||
graph.edges[].permissions |
list | ||
graph.edges[].permissions[] |
string | ||
graph.edges[].policed |
boolean | ||
graph.edges[].produced |
list | ||
graph.edges[].produced[].count |
integer | ||
graph.edges[].produced[].identifiers |
list | ||
graph.edges[].produced[].identifiers[] |
string | ||
graph.edges[].produced[].kind |
string | ||
graph.edges[].produced[].moreIdentifiers |
integer | ||
graph.edges[].produced[].notes |
list | ||
graph.edges[].produced[].notes[] |
string | ||
graph.edges[].producedFold |
map | ||
graph.edges[].producedFold.{key}.count |
integer | ||
graph.edges[].producedFold.{key}.identifiers |
list | ||
graph.edges[].producedFold.{key}.identifiers[] |
string | ||
graph.edges[].producedFold.{key}.kind |
string | ||
graph.edges[].producedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].producedFold.{key}.notes |
list | ||
graph.edges[].producedFold.{key}.notes[] |
string | ||
graph.edges[].protocol |
string, or null | ||
graph.edges[].protocols |
list | ||
graph.edges[].protocols[] |
string | ||
graph.edges[].reason |
string | ||
graph.edges[].refused |
integer | ||
graph.edges[].relation |
string | ||
graph.edges[].scopes |
list | ||
graph.edges[].scopes[] |
string | ||
graph.edges[].setOn |
string | ||
graph.edges[].skipped |
list | ||
graph.edges[].skipped[] |
string | ||
graph.edges[].spec |
string, or null | ||
graph.edges[].subject |
string, or null | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string, or null | ||
graph.edges[].typeLabel |
string, or null | ||
graph.edges[].used |
boolean | ||
graph.issuer |
string | ||
graph.maxTokenRows |
integer | ||
graph.nodes |
list | ||
graph.nodes[].acts |
integer | ||
graph.nodes[].aliases |
list | ||
graph.nodes[].aliases[] |
string | ||
graph.nodes[].application |
string | ||
graph.nodes[].authentications |
integer | ||
graph.nodes[].chiefRole |
string | ||
graph.nodes[].credentials |
integer | ||
graph.nodes[].dangling |
integer | ||
graph.nodes[].exposes |
integer | ||
graph.nodes[].firstAt |
number, or null | ||
graph.nodes[].flows |
list | ||
graph.nodes[].flows[] |
string | ||
graph.nodes[].grants |
integer | ||
graph.nodes[].id |
string | ||
graph.nodes[].isClient |
boolean | ||
graph.nodes[].isSubject |
boolean | ||
graph.nodes[].issued |
integer | ||
graph.nodes[].issuer |
string | ||
graph.nodes[].key |
string | ||
graph.nodes[].kind |
string | ||
graph.nodes[].kinds |
list | ||
graph.nodes[].kinds[] |
string | ||
graph.nodes[].lastAt |
number, or null | ||
graph.nodes[].presented |
string | ||
graph.nodes[].protocols |
list | ||
graph.nodes[].protocols[] |
string | ||
graph.nodes[].realm |
object | ||
graph.nodes[].realm.id |
string | ||
graph.nodes[].realm.isDefault |
boolean | ||
graph.nodes[].realm.name |
string, or null | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
number | ||
graph.nodes[].roles.intermediary |
number | ||
graph.nodes[].roles.target |
number | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string, or null | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string, or null | ||
graph.tokens[].at |
number, or null | ||
graph.tokens[].chainKey |
string | ||
graph.tokens[].identifier |
string | ||
graph.tokens[].kind |
string | ||
graph.tokens[].mode |
string | ||
graph.tokens[].note |
string | ||
graph.tokens[].protocol |
string | ||
graph.tokens[].seq |
number | ||
graph.tokens[].subject |
string, or null | ||
graph.tokens[].target |
string, or null | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
key |
string, or null | ||
label |
string | ||
looks |
map | ||
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string | ||
looks.{key}.title |
string | ||
mapKey |
string | ||
onDelegationLines |
integer | ||
svg |
string | ||
user |
object | ||
user.acts |
integer | ||
user.artifacts |
integer | ||
user.authenticated |
boolean | ||
user.authentications |
integer | ||
user.chains |
integer | ||
user.delegated |
boolean | ||
user.forms |
list | ||
user.forms[] |
string, or null | ||
user.isClient |
boolean | ||
user.issued |
integer | ||
user.key |
string | ||
user.lastAt |
number, or null | ||
user.name |
string, or null | ||
user.presented |
string | ||
user.protocols |
list | ||
user.protocols[] |
string | ||
user.refused |
integer | ||
user.roles |
object | ||
user.roles.initial |
number | ||
user.roles.intermediary |
number | ||
user.roles.target |
number | ||
user.tokens |
object | ||
user.tokens.expired |
integer | ||
user.tokens.issued |
integer | ||
user.tokens.other |
integer | ||
user.tokens.revoked |
integer | ||
user.tokens.valid |
integer | ||
users |
list | ||
users[].acts |
integer | ||
users[].artifacts |
integer | ||
users[].authenticated |
boolean | ||
users[].authentications |
integer | ||
users[].chains |
integer | ||
users[].delegated |
boolean | ||
users[].forms |
list | ||
users[].forms[] |
string, or null | ||
users[].isClient |
boolean | ||
users[].issued |
integer | ||
users[].key |
string | ||
users[].lastAt |
number, or null | ||
users[].name |
string, or null | ||
users[].presented |
string | ||
users[].protocols |
list | ||
users[].protocols[] |
string | ||
users[].refused |
integer | ||
users[].roles |
object | ||
users[].roles.initial |
number | ||
users[].roles.intermediary |
number | ||
users[].roles.target |
number | ||
users[].tokens |
object | ||
users[].tokens.expired |
integer | ||
users[].tokens.issued |
integer | ||
users[].tokens.other |
integer | ||
users[].tokens.revoked |
integer | ||
users[].tokens.valid |
integer | ||
usersComplete |
boolean |
As image/svg+xml.
GET /admin-api/permissions
getPermissions
Which applications may reach which, decided in advance
The CONFIGURED delegation register, in Microsoft Entra ID’s shape. It is the other half of GET /admin-api/delegation: that one is what HAPPENED — acts, evidence, one row per exchange — and this one is INTENT, typed in before anybody asked for anything.
How it works. A RESOURCE application is given a base URI (oauthPermissionBaseUri; Entra calls it the Application ID URI and spells it api://<guid>, and anything absolute works here) and permissions on it (oauthPermission). A permission is identified by the two joined — https://example.com/ + write = https://example.com/write — and a CLIENT application is granted some of them (oauthDelegatedPermission). All three are ordinary attributes on ordinary entries in ou=applications, so an ldapmodify is a configuration change here exactly as it is for a redirect URI.
What the token then says. A client asks for a permission as an ordinary OAuth scope, and the access token comes back AUDIENCED to the base URI with the permission NAME on its scope claim: scope=openid https://example.com/write produces aud: https://example.com/ and scope: openid write. Each grant row spells that out, because it is two facts a caller would otherwise have to compose.
In product mode an ungranted permission is invalid_scope, at the authorization endpoint where the client can still be told and at the token endpoint. In development it is honoured exactly as a granted one is and marked here, unless oauth2.delegatedPermissionsEnforced is on.
grants[].dangling is a grant naming a permission no application defines — a deleted resource, a permission removed from under it, or an ldapmodify, since both console doors refuse to create one. grants[].asked is whether the client has ever requested that scope, read off its own oauthScope: evidence rather than proof, and the one thing here that comes from what happened.
The graph member is the same picture /admin/delegation/allowed draws, in the shape GET /admin-api/delegation’s graph uses.
Mirrors GET /admin/delegation 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: Every application exposing an API, every permission defined, every grant between two applications, and the graph of them.
| Member | Type | Required | What it is |
|---|---|---|---|
counts |
object | ||
counts.clients |
integer | ||
counts.dangling |
integer | ||
counts.grants |
integer | ||
counts.permissions |
integer | ||
counts.resources |
integer | ||
counts.ungranted |
integer | ||
counts.unidentified |
integer | ||
counts.unused |
integer | ||
grants |
list | ||
grants[].asked |
boolean | ||
grants[].baseUri |
string, or null | ||
grants[].client |
string | ||
grants[].clientName |
string | ||
grants[].dangling |
boolean | ||
grants[].description |
string, or null | ||
grants[].permissionId |
string | ||
grants[].permissionName |
string, or null | ||
grants[].resource |
string | ||
grants[].resourceName |
string | ||
graph |
object | ||
graph.acts |
integer | ||
graph.chains |
integer | ||
graph.counts |
object | ||
graph.counts.edges |
integer | ||
graph.counts.grants |
integer | ||
graph.counts.nodes |
integer | ||
graph.credentials |
list | ||
graph.credentials[].at |
number, or null | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number, or null | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string, or null | ||
graph.credentials[].flowOidc |
string, or null | ||
graph.credentials[].flowProtocol |
string, or null | ||
graph.credentials[].flowSpec |
string, or null | ||
graph.credentials[].flowStated |
boolean | ||
graph.credentials[].holder |
string | ||
graph.credentials[].identifier |
string | ||
graph.credentials[].issuer |
string | ||
graph.credentials[].kind |
string | ||
graph.credentials[].revocable |
boolean | ||
graph.credentials[].revoked |
boolean | ||
graph.credentials[].scope |
string | ||
graph.credentials[].sessionId |
string | ||
graph.credentials[].state |
string, or null | ||
graph.credentialsOnDelegationLines |
integer | ||
graph.edges |
list | ||
graph.edges[].actor |
string, or null | ||
graph.edges[].acts |
integer | ||
graph.edges[].asked |
boolean | ||
graph.edges[].attribute |
string | ||
graph.edges[].audience |
string | ||
graph.edges[].audienceRegistered |
boolean | ||
graph.edges[].authentications |
list | ||
graph.edges[].authentications[].at |
number, or null | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number, or null | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string, or null | ||
graph.edges[].chainKey |
string | ||
graph.edges[].consumed |
list | ||
graph.edges[].consumed[].count |
integer | ||
graph.edges[].consumed[].identifiers |
list | ||
graph.edges[].consumed[].identifiers[] |
string | ||
graph.edges[].consumed[].kind |
string | ||
graph.edges[].consumed[].moreIdentifiers |
integer | ||
graph.edges[].consumed[].notes |
list | ||
graph.edges[].consumed[].notes[] |
string | ||
graph.edges[].consumedFold |
map | ||
graph.edges[].consumedFold.{key}.count |
integer | ||
graph.edges[].consumedFold.{key}.identifiers |
list | ||
graph.edges[].consumedFold.{key}.identifiers[] |
string | ||
graph.edges[].consumedFold.{key}.kind |
string | ||
graph.edges[].consumedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].consumedFold.{key}.notes |
list | ||
graph.edges[].consumedFold.{key}.notes[] |
string | ||
graph.edges[].credentials |
integer | ||
graph.edges[].description |
string, or null | ||
graph.edges[].firstAt |
number, or null | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number, or null | ||
graph.edges[].mechanism |
string | ||
graph.edges[].mode |
string | ||
graph.edges[].permissionId |
string | ||
graph.edges[].permissionName |
string | ||
graph.edges[].permissions |
list | ||
graph.edges[].permissions[] |
string | ||
graph.edges[].policed |
boolean | ||
graph.edges[].produced |
list | ||
graph.edges[].produced[].count |
integer | ||
graph.edges[].produced[].identifiers |
list | ||
graph.edges[].produced[].identifiers[] |
string | ||
graph.edges[].produced[].kind |
string | ||
graph.edges[].produced[].moreIdentifiers |
integer | ||
graph.edges[].produced[].notes |
list | ||
graph.edges[].produced[].notes[] |
string | ||
graph.edges[].producedFold |
map | ||
graph.edges[].producedFold.{key}.count |
integer | ||
graph.edges[].producedFold.{key}.identifiers |
list | ||
graph.edges[].producedFold.{key}.identifiers[] |
string | ||
graph.edges[].producedFold.{key}.kind |
string | ||
graph.edges[].producedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].producedFold.{key}.notes |
list | ||
graph.edges[].producedFold.{key}.notes[] |
string | ||
graph.edges[].protocol |
string, or null | ||
graph.edges[].protocols |
list | ||
graph.edges[].protocols[] |
string | ||
graph.edges[].reason |
string | ||
graph.edges[].refused |
integer | ||
graph.edges[].relation |
string | ||
graph.edges[].scopes |
list | ||
graph.edges[].scopes[] |
string | ||
graph.edges[].setOn |
string | ||
graph.edges[].skipped |
list | ||
graph.edges[].skipped[] |
string | ||
graph.edges[].spec |
string, or null | ||
graph.edges[].subject |
string, or null | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string, or null | ||
graph.edges[].typeLabel |
string, or null | ||
graph.edges[].used |
boolean | ||
graph.issuer |
string | ||
graph.maxTokenRows |
integer | ||
graph.nodes |
list | ||
graph.nodes[].acts |
integer | ||
graph.nodes[].aliases |
list | ||
graph.nodes[].aliases[] |
string | ||
graph.nodes[].application |
string | ||
graph.nodes[].authentications |
integer | ||
graph.nodes[].chiefRole |
string | ||
graph.nodes[].credentials |
integer | ||
graph.nodes[].dangling |
integer | ||
graph.nodes[].exposes |
integer | ||
graph.nodes[].firstAt |
number, or null | ||
graph.nodes[].flows |
list | ||
graph.nodes[].flows[] |
string | ||
graph.nodes[].grants |
integer | ||
graph.nodes[].id |
string | ||
graph.nodes[].isClient |
boolean | ||
graph.nodes[].isSubject |
boolean | ||
graph.nodes[].issued |
integer | ||
graph.nodes[].issuer |
string | ||
graph.nodes[].key |
string | ||
graph.nodes[].kind |
string | ||
graph.nodes[].kinds |
list | ||
graph.nodes[].kinds[] |
string | ||
graph.nodes[].lastAt |
number, or null | ||
graph.nodes[].presented |
string | ||
graph.nodes[].protocols |
list | ||
graph.nodes[].protocols[] |
string | ||
graph.nodes[].realm |
object | ||
graph.nodes[].realm.id |
string | ||
graph.nodes[].realm.isDefault |
boolean | ||
graph.nodes[].realm.name |
string, or null | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
number | ||
graph.nodes[].roles.intermediary |
number | ||
graph.nodes[].roles.target |
number | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string, or null | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string, or null | ||
graph.tokens[].at |
number, or null | ||
graph.tokens[].chainKey |
string | ||
graph.tokens[].identifier |
string | ||
graph.tokens[].kind |
string | ||
graph.tokens[].mode |
string | ||
graph.tokens[].note |
string | ||
graph.tokens[].protocol |
string | ||
graph.tokens[].seq |
number | ||
graph.tokens[].subject |
string, or null | ||
graph.tokens[].target |
string, or null | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
permissions |
list | ||
permissions[].baseUri |
string, or null | ||
permissions[].description |
string, or null | ||
permissions[].grantedTo |
list | ||
permissions[].grantedTo[].asked |
boolean | ||
permissions[].grantedTo[].identifier |
string | ||
permissions[].grantedTo[].name |
string | ||
permissions[].id |
string, or null | ||
permissions[].name |
string, or null | ||
permissions[].raw |
string, or null | ||
permissions[].resource |
string | ||
permissions[].resourceName |
string | ||
resources |
list | ||
resources[].baseUri |
string, or null | ||
resources[].grantsHeld |
integer | ||
resources[].identifier |
string | ||
resources[].name |
string | ||
resources[].permissions |
list | ||
resources[].permissions[].description |
string, or null | ||
resources[].permissions[].grantedTo |
list | ||
resources[].permissions[].grantedTo[].asked |
boolean | ||
resources[].permissions[].grantedTo[].identifier |
string | ||
resources[].permissions[].grantedTo[].name |
string | ||
resources[].permissions[].id |
string, or null | ||
resources[].permissions[].name |
string, or null | ||
resources[].permissions[].raw |
string, or null | ||
resources[].rawBaseUri |
string |
POST /admin-api/permissions/define-permission
definePermission
Expose one permission on an application
Entra ID’s oauth2PermissionScopes, one at a time.
The NAME is what ends up on the access token’s scope claim, so it must be a legal OAuth scope token: any printable ASCII except space, double quote and backslash (RFC 6749 section 3.3), and not |, which separates the name from the description in the attribute. The DESCRIPTION is optional and is stored after the first | in the same value.
Defining a permission grants it to nobody. That is the ordering this feature is built on and the reason this operation and grant-permission are two: a permission must exist before anything can be granted it, and the check is in applications.updateApplication() so that this operation, the console form and the generic POST /admin-api/applications/add cannot disagree about it.
A second permission of the SAME NAME is refused rather than merged — a permission has one description, and two rows with one name would leave the second unreachable. Remove it and define it again to change the wording.
Mirrors POST /admin/delegation-settings 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 | Optional prose, shown wherever the permission is. | |
name |
string | yes | The permission name — the word a client will send inside a scope. |
resource |
string | yes | The application that exposes it. |
200: The permission’s identifier, and what a request naming it would be issued.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
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 |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/permissions/grant-permission
grantPermission
Grant a client application a permission on another one
THE DELEGATION RELATIONSHIP ITSELF — Entra ID’s requiredResourceAccess, one permission at a time.
It lands on the CLIENT’s entry, as a value of oauthDelegatedPermission, because the client is the party that will name the permission in a scope — so the entry that answers may this request be honoured is the entry the request identifies. One client granted three permissions is three calls and three values; three clients granted one permission is one value on each of three entries. That is how one-to-many and many-to-one both work with no store of their own.
The permission must already be DEFINED, matched EXACTLY rather than as a prefix of a registered base — so a client cannot address a token to somebody’s API by inventing a word after their base URI. An application cannot be granted its own permission: the token would be addressed to itself, which is what an ID Token already is.
In product mode it is what lets the request through. In development it changes nothing about what is issued unless oauth2.delegatedPermissionsEnforced is on. With it off — the default — the request was already producing the audience and the scope, and what the grant changes is that the console stops marking it ungranted.
Mirrors POST /admin/delegation-settings 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 |
|---|---|---|---|
client |
string | yes | The application that WILL ASK — the one whose client_id appears on the token request. Not the one exposing the API. |
permission |
string | yes | The whole permission identifier, base URI and name together. |
200: The grant, and what an access token asking for it will carry.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
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 |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
GET /admin-api/permissions/groups
getPermissionGroups
Which applications are joined to each other by delegated permissions
The configured register PARTITIONED: a group is a set of applications that can be reached from one another by following grants, ignoring which way each grant points.
Direction is dropped for MEMBERSHIP and kept on every line of the picture. Following the arrows would answer what can this client eventually reach, which is a question about a chain, and a permission register has no chains in it: holding a permission on an API grants nobody that API’s own permissions. Following a grant either way is the only reading under which an API and the three front ends holding permissions on it come out as ONE group rather than as four.
The membership universe is what the CONFIGURED register touches: every application carrying a base URI or a permission of its own, and every application holding a grant. An entry in ou=applications that is neither is in no group, because this register has nothing to say about it.
Three states join no two applications, and each produces a group of ONE rather than being left out: a DANGLING grant (no application defines the permission, so there is no far end), a grant an application made to ITSELF (one application however it is drawn), and a resource nobody holds anything on — which is the most interesting group of one there is, since somebody described an API and nothing may reach it.
A group is NAMED after the identifier of its members that sorts first. That is a property of the SET, so adding a grant inside a group does not rename it.
With no application, every group with its counts and no rows, biggest first and paged on groupsPage — the shape /admin/delegation/allowed lists. With application, the ONE group that application is in, with its permissions paged on groupPermissionsPage, its grants paged on groupGrantsPage, and the graph /admin/delegation/cluster draws, in the shape GET /admin-api/delegation’s graph uses. An application the configured register has never heard of answers 200 with group: null, not 404: having no permissions configured is the ordinary state of most entries in this registry, and it is a fact rather than an error. The identifier is matched EXACTLY — nothing in this service case-folds one, so WebApp1 and webapp1 are two applications.
Mirrors GET /admin/delegation on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
application |
query | string | One application’s identifier. Answers the group it is in, with its rows and its graph, instead of the list of every group. Matched exactly. | |
groupsPage |
query | integer | Which page of the group LIST. The same name the console page uses, because a group list is one of several lists a delegation page can hold and a bare page would move them together. Not read when application is given. |
|
groupGrantsPage |
query | integer | Which page of the GRANTS inside one group. Read only when application is given. |
|
groupPermissionsPage |
query | integer | Which page of the PERMISSIONS the applications in one group expose, granted or not. Read only when application is given. |
|
per |
query | integer | Rows per page, shared by both lists above — one per per page is this console’s rule and this operation follows it. |
|
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: Every group with its members and counts, or the one group an application is in with its grants, its permissions and its graph.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
string, or null | ||
counts |
object | ||
counts.alone |
integer | ||
counts.applications |
integer | ||
counts.clusters |
integer | ||
counts.joined |
integer | ||
counts.largest |
integer | ||
grants |
list | ||
grants[].asked |
boolean | ||
grants[].baseUri |
string, or null | ||
grants[].client |
string | ||
grants[].clientName |
string | ||
grants[].dangling |
boolean | ||
grants[].description |
string, or null | ||
grants[].permissionId |
string | ||
grants[].permissionName |
string, or null | ||
grants[].resource |
string | ||
grants[].resourceName |
string | ||
grantsPaging |
object | ||
grantsPaging.firstRow |
integer | ||
grantsPaging.lastRow |
integer | ||
grantsPaging.noun |
string, or null | ||
grantsPaging.page |
integer | ||
grantsPaging.pages |
integer | ||
grantsPaging.param |
string, or null | ||
grantsPaging.perPage |
integer | ||
grantsPaging.total |
integer | ||
graph |
object | ||
graph.acts |
integer | ||
graph.chains |
integer | ||
graph.counts |
object | ||
graph.counts.edges |
integer | ||
graph.counts.grants |
integer | ||
graph.counts.nodes |
integer | ||
graph.credentials |
list | ||
graph.credentials[].at |
number, or null | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number, or null | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string, or null | ||
graph.credentials[].flowOidc |
string, or null | ||
graph.credentials[].flowProtocol |
string, or null | ||
graph.credentials[].flowSpec |
string, or null | ||
graph.credentials[].flowStated |
boolean | ||
graph.credentials[].holder |
string | ||
graph.credentials[].identifier |
string | ||
graph.credentials[].issuer |
string | ||
graph.credentials[].kind |
string | ||
graph.credentials[].revocable |
boolean | ||
graph.credentials[].revoked |
boolean | ||
graph.credentials[].scope |
string | ||
graph.credentials[].sessionId |
string | ||
graph.credentials[].state |
string, or null | ||
graph.credentialsOnDelegationLines |
integer | ||
graph.edges |
list | ||
graph.edges[].actor |
string, or null | ||
graph.edges[].acts |
integer | ||
graph.edges[].asked |
boolean | ||
graph.edges[].attribute |
string | ||
graph.edges[].audience |
string | ||
graph.edges[].audienceRegistered |
boolean | ||
graph.edges[].authentications |
list | ||
graph.edges[].authentications[].at |
number, or null | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number, or null | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string, or null | ||
graph.edges[].chainKey |
string | ||
graph.edges[].consumed |
list | ||
graph.edges[].consumed[].count |
integer | ||
graph.edges[].consumed[].identifiers |
list | ||
graph.edges[].consumed[].identifiers[] |
string | ||
graph.edges[].consumed[].kind |
string | ||
graph.edges[].consumed[].moreIdentifiers |
integer | ||
graph.edges[].consumed[].notes |
list | ||
graph.edges[].consumed[].notes[] |
string | ||
graph.edges[].consumedFold |
map | ||
graph.edges[].consumedFold.{key}.count |
integer | ||
graph.edges[].consumedFold.{key}.identifiers |
list | ||
graph.edges[].consumedFold.{key}.identifiers[] |
string | ||
graph.edges[].consumedFold.{key}.kind |
string | ||
graph.edges[].consumedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].consumedFold.{key}.notes |
list | ||
graph.edges[].consumedFold.{key}.notes[] |
string | ||
graph.edges[].credentials |
integer | ||
graph.edges[].description |
string, or null | ||
graph.edges[].firstAt |
number, or null | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number, or null | ||
graph.edges[].mechanism |
string | ||
graph.edges[].mode |
string | ||
graph.edges[].permissionId |
string | ||
graph.edges[].permissionName |
string | ||
graph.edges[].permissions |
list | ||
graph.edges[].permissions[] |
string | ||
graph.edges[].policed |
boolean | ||
graph.edges[].produced |
list | ||
graph.edges[].produced[].count |
integer | ||
graph.edges[].produced[].identifiers |
list | ||
graph.edges[].produced[].identifiers[] |
string | ||
graph.edges[].produced[].kind |
string | ||
graph.edges[].produced[].moreIdentifiers |
integer | ||
graph.edges[].produced[].notes |
list | ||
graph.edges[].produced[].notes[] |
string | ||
graph.edges[].producedFold |
map | ||
graph.edges[].producedFold.{key}.count |
integer | ||
graph.edges[].producedFold.{key}.identifiers |
list | ||
graph.edges[].producedFold.{key}.identifiers[] |
string | ||
graph.edges[].producedFold.{key}.kind |
string | ||
graph.edges[].producedFold.{key}.moreIdentifiers |
integer | ||
graph.edges[].producedFold.{key}.notes |
list | ||
graph.edges[].producedFold.{key}.notes[] |
string | ||
graph.edges[].protocol |
string, or null | ||
graph.edges[].protocols |
list | ||
graph.edges[].protocols[] |
string | ||
graph.edges[].reason |
string | ||
graph.edges[].refused |
integer | ||
graph.edges[].relation |
string | ||
graph.edges[].scopes |
list | ||
graph.edges[].scopes[] |
string | ||
graph.edges[].setOn |
string | ||
graph.edges[].skipped |
list | ||
graph.edges[].skipped[] |
string | ||
graph.edges[].spec |
string, or null | ||
graph.edges[].subject |
string, or null | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string, or null | ||
graph.edges[].typeLabel |
string, or null | ||
graph.edges[].used |
boolean | ||
graph.issuer |
string | ||
graph.maxTokenRows |
integer | ||
graph.nodes |
list | ||
graph.nodes[].acts |
integer | ||
graph.nodes[].aliases |
list | ||
graph.nodes[].aliases[] |
string | ||
graph.nodes[].application |
string | ||
graph.nodes[].authentications |
integer | ||
graph.nodes[].chiefRole |
string | ||
graph.nodes[].credentials |
integer | ||
graph.nodes[].dangling |
integer | ||
graph.nodes[].exposes |
integer | ||
graph.nodes[].firstAt |
number, or null | ||
graph.nodes[].flows |
list | ||
graph.nodes[].flows[] |
string | ||
graph.nodes[].grants |
integer | ||
graph.nodes[].id |
string | ||
graph.nodes[].isClient |
boolean | ||
graph.nodes[].isSubject |
boolean | ||
graph.nodes[].issued |
integer | ||
graph.nodes[].issuer |
string | ||
graph.nodes[].key |
string | ||
graph.nodes[].kind |
string | ||
graph.nodes[].kinds |
list | ||
graph.nodes[].kinds[] |
string | ||
graph.nodes[].lastAt |
number, or null | ||
graph.nodes[].presented |
string | ||
graph.nodes[].protocols |
list | ||
graph.nodes[].protocols[] |
string | ||
graph.nodes[].realm |
object | ||
graph.nodes[].realm.id |
string | ||
graph.nodes[].realm.isDefault |
boolean | ||
graph.nodes[].realm.name |
string, or null | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
number | ||
graph.nodes[].roles.intermediary |
number | ||
graph.nodes[].roles.target |
number | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string, or null | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string, or null | ||
graph.tokens[].at |
number, or null | ||
graph.tokens[].chainKey |
string | ||
graph.tokens[].identifier |
string | ||
graph.tokens[].kind |
string | ||
graph.tokens[].mode |
string | ||
graph.tokens[].note |
string | ||
graph.tokens[].protocol |
string | ||
graph.tokens[].seq |
number | ||
graph.tokens[].subject |
string, or null | ||
graph.tokens[].target |
string, or null | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
group |
object | ||
group.counts |
object | ||
group.counts.applications |
integer | ||
group.counts.asked |
integer | ||
group.counts.dangling |
integer | ||
group.counts.grants |
integer | ||
group.counts.lines |
integer | ||
group.counts.permissions |
integer | ||
group.counts.selfGrants |
integer | ||
group.counts.unused |
integer | ||
group.key |
string | ||
group.members |
list | ||
group.members[] |
string | ||
groups |
list | ||
groups[].counts |
object | ||
groups[].counts.applications |
integer | ||
groups[].counts.asked |
integer | ||
groups[].counts.dangling |
integer | ||
groups[].counts.grants |
integer | ||
groups[].counts.lines |
integer | ||
groups[].counts.permissions |
integer | ||
groups[].counts.selfGrants |
integer | ||
groups[].counts.unused |
integer | ||
groups[].key |
string | ||
groups[].members |
list | ||
groups[].members[] |
string | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string, or null | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string, or null | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
permissions |
list | ||
permissions[].baseUri |
string, or null | ||
permissions[].description |
string, or null | ||
permissions[].grantedTo |
list | ||
permissions[].grantedTo[].asked |
boolean | ||
permissions[].grantedTo[].identifier |
string | ||
permissions[].grantedTo[].name |
string | ||
permissions[].id |
string, or null | ||
permissions[].name |
string, or null | ||
permissions[].raw |
string, or null | ||
permissions[].resource |
string | ||
permissions[].resourceName |
string | ||
permissionsPaging |
object | ||
permissionsPaging.firstRow |
integer | ||
permissionsPaging.lastRow |
integer | ||
permissionsPaging.noun |
string, or null | ||
permissionsPaging.page |
integer | ||
permissionsPaging.pages |
integer | ||
permissionsPaging.param |
string, or null | ||
permissionsPaging.perPage |
integer | ||
permissionsPaging.total |
integer |
POST /admin-api/permissions/remove-permission
removePermission
Stop exposing a permission
Named by its NAME rather than by the raw attribute value, because that value is name|description and a caller holding a stale description would fail to remove anything.
Grants naming it are NOT revoked. They stay on the clients’ entries and become dangling, which GET /admin-api/permissions reports and the reply here counts. Revoking them would be this operation writing to entries the caller did not name; define the permission again and every one of them resolves exactly as before.
Mirrors POST /admin/delegation-settings 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 permission name. |
resource |
string | yes | The application that exposes it. |
200: What was removed, and how many grants it stranded.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
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 |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/permissions/revoke-permission
revokePermission
Take a permission away from a client application
The opposite of grant-permission. In product mode the client’s next request for the permission is refused. In development with the setting off it changes nothing about what is issued either: the permission still becomes an audience and a scope, and those requests are simply reported as UNGRANTED — which is the state oauth2.delegatedPermissionsEnforced turns into a refusal.
It is also how a DANGLING grant is cleared: send the identifier exactly as it appears on the entry, and it goes whether or not anything defines it.
Mirrors POST /admin/delegation-settings 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 |
|---|---|---|---|
client |
string | yes | The application holding it. |
permission |
string | yes | The whole permission identifier. |
200: What was revoked.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
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 |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/permissions/set-permission-base
setPermissionBase
Give an application the base URI its permissions hang off
The first step of exposing an API, and the one that makes every permission on the entry NAMEABLE: a permission is identified by this value followed by its name, so an application with permissions and no base has permissions no client can ever ask for.
It must be ABSOLUTE, because it becomes the aud of an access token and an audience that is not absolute is one nothing can compare against. A trailing separator is ADDED where there is none — https://example.com becomes https://example.com/ — because the identifier is a plain concatenation and the two would otherwise join into one word. An ldapmodify is not normalised and means exactly what it says.
Sending an empty value CLEARS it. The permissions stay on the entry with no identifier, which GET /admin-api/permissions reports, and grants already made become dangling on the clients holding them. Neither is tidied up: that would be this operation writing to entries the caller did not name.
Mirrors POST /admin/delegation-settings 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 |
|---|---|---|---|
baseUri |
string | An absolute URI. Empty clears it. | |
resource |
string | yes | The application that EXPOSES the API, by its identifier exactly as ou=applications holds it. |
200: The application as it now stands, and what a permission on it is now called.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
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 |
|---|---|---|---|
application |
object | ||
application.allowedProtocols |
list | ||
application.allowedProtocols[] |
string | ||
application.attributes |
map | ||
application.attributes.{key} |
list, or string, or number, or boolean, or null | ||
application.attributes.{key}[] |
string, or number, or boolean, or null | ||
application.authentications |
number | ||
application.createdAt |
string, or null | ||
application.declaredKinds |
list | ||
application.declaredKinds[] |
string | ||
application.description |
string, or null | ||
application.dn |
string, or null | ||
application.dnLabel |
string, or null | ||
application.fields |
map | ||
application.fields.{key} |
list, or string, or number, or boolean, or null | ||
application.fields.{key}[] |
string, or number, or boolean, or null | ||
application.firstSeen |
string | ||
application.identifier |
string | ||
application.kinds |
list | ||
application.kinds[] |
string | ||
application.lastSeen |
string | ||
application.modifiedAt |
string, or null | ||
application.name |
string, or null | ||
application.operational |
list | ||
application.operational[] |
string | ||
application.origin |
string, or null | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.recordedProtocols |
list | ||
application.recordedProtocols[] |
string | ||
application.registered |
boolean | ||
application.registeredBy |
string | ||
application.returnAddressesObserved |
list | ||
application.returnAddressesObserved[].attribute |
string | ||
application.returnAddressesObserved[].held |
boolean | ||
application.returnAddressesObserved[].trusted |
boolean | ||
application.returnAddressesObserved[].value |
string | ||
application.sessions |
number | ||
application.users |
number | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |