This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.
The operations that exist to draw the console. They are not the management API, and a machine client has no use for them.
These are the admin console’s own operations, not the management API. They exist to draw the static console at /admin — its frame, its drawings and its form helpers — and answer in the shape its pages want, which changes when a page does. They take admin:console, issued only to the console’s client through the ADMIN_CONSOLE role it confers, and a page that shows realm data takes ADMIN_READ too. Every control the console has is a management operation, described by /admin-api/openapi.json.
The management API of IYA STS: everything the /admin console shows and everything it can change, over JSON, with no browser.
Every operation here requires an OAuth 2.0 access token, and this document says which scope each one needs. Ask this service’s own token endpoint for one: grant_type=client_credentials as the seeded client sts-api-client (its secret is adminApi.clientSecret), scope=admin:read admin:write, and resource=<this server>/admin-api — that last parameter is what puts this API in the token’s aud, and a token audienced at anything else is refused however good it is. A GET needs admin:read and everything else needs admin:write; they are checked as a XACML access decision against the built-in ADMIN_READ and ADMIN_WRITE roles, so the requirement is stated in the same policy document as every other access decision in this service. The credential is service-wide: the token is verified against the DEFAULT realm’s key and audienced without a realm prefix wherever it is presented, for the reason the console’s two roles are groups in the default realm — a per-realm one would let anybody who can create a realm mint themselves an administrator. A trust realm’s own administrators have a narrower token of their own: issued to that realm’s sts-api-client client, accepted only under /realm/<id>/admin-api, and refused every service-wide operation. adminApi.authRequired turns this off and restores the open API exactly; what follows is what that means. AND IT IS STILL WORTH STATING PLAINLY: a holder of this token can revoke every token this service has issued and change what the next one contains. That is fine on a laptop or a compose network and is not fine on a public address, which was already true of /oauth2/token — it will mint a token for any username asked of it.
Many operations change what the protocol endpoints do, rather than only reporting on them; four examples. Revoking a token is the same revocation RFC 7009’s /oauth2/revoke performs, so introspection, UserInfo and the refresh grant all honour it immediately. A custom claim reaches every access token, ID Token and SAML assertion issued from then on. The credential claim set reaches every Verifiable Credential AND sweeps the embedded LDAP directory. And the verifier request reaches the dcql_query of the next OID4VP Authorization Request. Nothing already issued ever changes — a signed document cannot be reached into.
Every operation here mirrors a control on the /admin console and calls the same function behind it. They are not two implementations of one idea: admin_api.js holds no opinion about what a revocation means that the console does not. The mirrors line on each operation says which control it is.
In the default memory persistence mode all state is in memory and dies with the process; GET /admin-api/persistence says what this process writes down.
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/console
getConsoleShell
What the console draws around every page, for this caller
The gate as it stands for the caller and the labels of the roles it names, the trust realm and the realms to choose between, where the realm’s root and the user portal are, the console sections the caller may see and every page’s label, a realm’s removal in progress, what this process runs as, what is persisted, and the build. The static console fetches it once after sign-in. With catalogs=files, the language member names the static catalog files rather than carrying the catalogs.
Mirrors GET /admin on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
catalogs |
query | one of files |
files: name the static catalog files instead of carrying the catalogs. | |
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 shell answer.
| Member | Type | Required | What it is |
|---|---|---|---|
gate |
object | ||
gate.authority |
string, or null | ||
gate.available |
boolean | ||
gate.bootstrap |
object | ||
gate.bootstrap.claimedAt |
string | ||
gate.bootstrap.seeded |
boolean | ||
gate.bootstrap.username |
string, or null | ||
gate.bootstrapPasswordRequired |
boolean | ||
gate.closed |
boolean | ||
gate.empty |
boolean | ||
gate.enforced |
boolean | ||
gate.identityRealm |
string, or null | ||
gate.open |
boolean | ||
gate.read |
boolean | ||
gate.readGroup |
string, or null | ||
gate.roles |
list | ||
gate.roles[] |
string | ||
gate.security |
boolean | ||
gate.session |
boolean | ||
gate.username |
string | ||
gate.windowOpens |
boolean | ||
gate.write |
boolean | ||
gate.writeGroup |
string, or null | ||
locale |
object | ||
locale.catalogFiles |
map | Each static catalog, by language tag. | |
locale.catalogFiles.{key} |
string | ||
locale.catalogs |
map | Each catalog along the chain, by language tag. | |
locale.catalogs.{key} |
map | A translated message by its key. | |
locale.catalogs.{key}.{key} |
string | ||
locale.negotiated |
object | ||
locale.negotiated.catalog |
string | ||
locale.negotiated.chain |
list | ||
locale.negotiated.chain[] |
string | ||
locale.negotiated.direction |
one of ltr, rtl |
||
locale.negotiated.locale |
string | ||
locale.negotiated.matched |
boolean | ||
locale.offered |
list | ||
locale.offered[].name |
string | ||
locale.offered[].tag |
string | ||
navAuthority |
string | ||
navLabels |
map | Every console page’s label, by its path. | |
navLabels.{key} |
string | ||
persistence |
object | ||
persistence.enabled |
boolean | ||
persistence.mode |
string | ||
portalHref |
string | ||
realm |
object | ||
realm.id |
string | ||
realm.name |
string | ||
realmRoot |
string | ||
realms |
list | ||
realms[].id |
string | ||
realms[].name |
string | ||
realms[].prefix |
string | ||
retiring |
object | ||
retiring.finish |
string | ||
retiring.finishesBy |
number | ||
retiring.inProgress |
boolean | ||
retiring.interrupted |
boolean | ||
retiring.refusing |
string | ||
retiring.since |
number | ||
retiring.sinceIso |
string | ||
retiring.why |
string | ||
roleLabels |
map | Each role the gate names, by its id. | |
roleLabels.{key} |
string | ||
runtime |
object | ||
runtime.database |
string | ||
runtime.databasePassword |
string | ||
runtime.keyEncryptionKey |
string | ||
runtime.mode |
string | ||
runtime.process |
string | ||
sections |
list | ||
sections[].items |
list | ||
sections[].items[].blurb |
string | ||
sections[].items[].hidden |
boolean | ||
sections[].items[].items |
list | ||
sections[].items[].items[].blurb |
string | ||
sections[].items[].items[].hidden |
boolean | ||
sections[].items[].items[].items |
list | ||
sections[].items[].items[].items[].blurb |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].hidden |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].label |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].path |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].title |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].what |
object | Nested deeper than this page draws. | |
sections[].items[].items[].label |
string | ||
sections[].items[].items[].path |
string | ||
sections[].items[].items[].title |
string | ||
sections[].items[].items[].what |
string | ||
sections[].items[].label |
string | ||
sections[].items[].path |
string | ||
sections[].items[].title |
string | ||
sections[].items[].what |
string | ||
sections[].title |
string | ||
sections[].what |
string | ||
version |
object | ||
version.buildInfo |
string | ||
version.stamped |
boolean | ||
version.version |
string | ||
wsTrustIssuer |
string, or null |
GET /admin-api/console/api-explorer
getApiExplorer
What the console’s API explorer reads, and what you may drive
The explorer is a page of the ADMIN CONSOLE at /admin/api-explorer — it was /admin-api/docs until 2026-09-09, when this API began requiring an access token a browser cannot carry. This operation reports where the document is, how many paths and operations it describes, and the audience a token for this API must name. It does NOT repeat the document: GET /admin-api/openapi.json is the document.
The scope member is what the CONSOLE SESSION’s roles would grant — it is what the page puts in the token it mints for the person reading it, so a reader holding Admin Read alone sees admin:read and knows before pressing anything that a write would be refused. It is EMPTY when this operation is called with an access token rather than read off the page, which is the ordinary case here: there is no console session on such a request, and reporting the token’s own scopes back to the caller that sent them would be telling somebody what they just said.
Mirrors GET /admin/api-explorer on the admin console.
Scope: admin:console.
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: Where the explorer reads from, and what the caller may drive.
| Member | Type | Required | What it is |
|---|---|---|---|
api |
string | ||
audience |
string, or null | ||
document |
string | ||
operations |
integer | ||
page |
string | ||
paths |
integer | ||
realmPrefix |
string | ||
scope |
string | ||
script |
string | ||
tokenInReply |
boolean | ||
version |
string | ||
who |
string |
POST /admin-api/console/applications/generate-secret
generateClientSecret
Mint a client secret for an application about to be created, writing nothing
Mints a secret exactly as regenerate-secret and POST /oauth2/register do — oauth2.registeredSecretBytes random bytes, base64url — and hands it back. IT NAMES NO APPLICATION AND WRITES NOTHING: pass the value to create in fields.oauthClientSecret and it becomes that application’s credential, with oauthTokenEndpointAuthMethod written as client_secret_basic unless create names another. The token endpoint accepts the secret by an Authorization: Basic header or a client_secret form parameter for that method.
Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners on the admin console.
Scope: admin:console.
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 (optional)
An empty object.
200: The secret in clientSecret.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
clientSecret |
string | ||
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 |
|---|---|---|---|
changed |
boolean | ||
clientSecret |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
GET /admin-api/console/applications/new
getConsoleNewApplicationForm
Everything the new application form is drawn from
The vocabulary GET /admin-api/applications/new answers, with how the form lays it out: its field groups, the combined protocol choices, the long text fields, the persistence note and the RFC 9728 import tab.
Mirrors GET /admin/applications/new on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The two vocabularies, the fields a create may carry, the container and the realm.
| Member | Type | Required | What it is |
|---|---|---|---|
applicationCount |
integer | ||
container |
string, or null | ||
declarations |
list | ||
declarations[].attribute |
string | ||
declarations[].editable |
string or boolean, or null | ||
declarations[].everyFamily |
boolean | ||
declarations[].families |
list | ||
declarations[].families[].id |
string | ||
declarations[].families[].label |
string | ||
declarations[].kind |
string | ||
declarations[].role |
string | ||
declarations[].sensitive |
boolean | ||
declarations[].what |
string | ||
defaultSecretLifetimeDays |
number | ||
directory |
boolean | ||
editable |
list | ||
editable[].families |
list | ||
editable[].families[] |
string | ||
editable[].mode |
string or boolean, or null | ||
editable[].name |
string | ||
editable[].sensitive |
boolean | ||
familyChoices |
list | ||
familyChoices[].families |
list | ||
familyChoices[].families[] |
string | ||
familyChoices[].id |
string | ||
familyChoices[].kind |
string | ||
familyChoices[].label |
string | ||
familyChoices[].what |
string | ||
fieldGroups |
list | ||
fieldGroups[].families |
list | ||
fieldGroups[].families[] |
string | ||
fieldGroups[].id |
string | ||
fieldGroups[].label |
string | ||
fields |
list | ||
fields[].attribute |
string | ||
fields[].choices |
list | ||
fields[].choices[] |
string | ||
fields[].declaration |
boolean | ||
fields[].described |
object | ||
fields[].described.appconfigPath |
string | ||
fields[].described.csvValueNotes |
map | A sentence per value of the row. | |
fields[].described.csvValueNotes.{key} |
string | ||
fields[].described.csvValues |
list | ||
fields[].described.csvValues[] |
string | ||
fields[].described.default |
list | ||
fields[].described.default[] |
string or number or boolean | ||
fields[].described.description |
string | ||
fields[].described.editRefusal |
string, or null | ||
fields[].described.editable |
boolean | ||
fields[].described.enumValues |
list | ||
fields[].described.enumValues[] |
string | ||
fields[].described.env |
string, or null | ||
fields[].described.group |
string | ||
fields[].described.key |
string | ||
fields[].described.label |
string | ||
fields[].described.legacyEnv |
list, or string, or null | ||
fields[].described.legacyEnv[] |
string | ||
fields[].described.masked |
boolean | ||
fields[].described.max |
number | ||
fields[].described.min |
number | ||
fields[].described.ordered |
boolean | ||
fields[].described.overridden |
boolean | ||
fields[].described.realmSettable |
boolean | ||
fields[].described.restartReason |
string, or null | ||
fields[].described.selectAll |
object | ||
fields[].described.selectAll.aloneWhileOn |
list | ||
fields[].described.selectAll.aloneWhileOn[].canBeOn |
boolean | ||
fields[].described.selectAll.aloneWhileOn[].on |
boolean | ||
fields[].described.selectAll.aloneWhileOn[].setting |
string | ||
fields[].described.selectAll.aloneWhileOn[].values |
list | ||
fields[].described.selectAll.aloneWhileOn[].values[] |
string | ||
fields[].described.selectAll.onlyWhileOn |
list | ||
fields[].described.selectAll.onlyWhileOn[].canBeOn |
boolean | ||
fields[].described.selectAll.onlyWhileOn[].on |
boolean | ||
fields[].described.selectAll.onlyWhileOn[].setting |
string | ||
fields[].described.selectAll.onlyWhileOn[].values |
list | ||
fields[].described.selectAll.onlyWhileOn[].values[] |
string | ||
fields[].described.source |
string | ||
fields[].described.step |
number | ||
fields[].described.text |
string, or null | ||
fields[].described.type |
string | ||
fields[].described.value |
list | ||
fields[].described.value[] |
string or number or boolean | ||
fields[].editable |
string or boolean, or null | ||
fields[].everyFamily |
boolean | ||
fields[].example |
string, or null | ||
fields[].families |
list | ||
fields[].families[] |
string | ||
fields[].group |
string | ||
fields[].inSimple |
boolean | ||
fields[].long |
boolean | ||
fields[].overrides |
string | ||
fields[].primaryName |
boolean | ||
fields[].section |
string | ||
fields[].sectionLabel |
string | ||
fields[].sensitive |
boolean | ||
fields[].simple |
boolean | ||
fields[].type |
string | ||
fields[].what |
string | ||
kinds |
list | ||
kinds[].kind |
string | ||
kinds[].label |
string | ||
kinds[].what |
string | ||
longTextAttributes |
list | ||
longTextAttributes[] |
string | ||
max |
number, or null | ||
persistence |
object | ||
persistence.mode |
string, or null | ||
persistence.persistsDirectory |
boolean | ||
protocols |
list | ||
protocols[].deliveryAttribute |
string | ||
protocols[].eventsAttribute |
string | ||
protocols[].id |
string | ||
protocols[].identifierAttribute |
string | ||
protocols[].kind |
string | ||
protocols[].kinds |
list | ||
protocols[].kinds[] |
string | ||
protocols[].label |
string | ||
protocols[].logoutAttribute |
string | ||
protocols[].redirectAttribute |
string | ||
protocols[].secretAttribute |
string | ||
protocols[].what |
string | ||
realm |
object | ||
realm.id |
string | ||
realm.name |
string | ||
resourceMetadataImport |
object | ||
resourceMetadataImport.acceptsNonconforming |
boolean | ||
resourceMetadataImport.dialsInternalAddresses |
boolean | ||
resourceMetadataImport.wellKnown |
string |
GET /admin-api/console/dashboard
getConsoleDashboard
What the console’s front page draws
The totals GET /admin-api/status answers, with the base URL, what is persisted, whether this realm is in development mode and so draws what the console deliberately does not do (testDouble) and the console sections the caller may see, which is what /admin draws.
Mirrors GET /admin on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The current totals.
| Member | Type | Required | What it is |
|---|---|---|---|
artifactsHeld |
number | ||
base |
string | ||
calls |
number | ||
issuer |
string, or null | ||
pages |
list | ||
pages[] |
string | ||
persistence |
object | ||
persistence.enabled |
boolean | ||
persistence.mode |
string | ||
sections |
list | ||
sections[].items |
list | ||
sections[].items[].blurb |
string | ||
sections[].items[].hidden |
boolean | ||
sections[].items[].items |
list | ||
sections[].items[].items[].blurb |
string | ||
sections[].items[].items[].hidden |
boolean | ||
sections[].items[].items[].items |
list | ||
sections[].items[].items[].items[].blurb |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].hidden |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].label |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].path |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].title |
object | Nested deeper than this page draws. | |
sections[].items[].items[].items[].what |
object | Nested deeper than this page draws. | |
sections[].items[].items[].label |
string | ||
sections[].items[].items[].path |
string | ||
sections[].items[].items[].title |
string | ||
sections[].items[].items[].what |
string | ||
sections[].items[].label |
string | ||
sections[].items[].path |
string | ||
sections[].items[].title |
string | ||
sections[].items[].what |
string | ||
sections[].title |
string | ||
sections[].what |
string | ||
signOnSessions |
number | ||
startedAt |
string | ||
testDouble |
boolean | ||
tokensHeld |
number | ||
tokensHeldOnly |
boolean | ||
tokensRevoked |
number | ||
uptimeMs |
number | ||
usersAuthenticatedHere |
number | ||
usersKnown |
number |
GET /admin-api/console/delegation-settings
getDelegationSettings
The configured permissions register, as its page shows it
The delegated permissions register searched and paged as the page shows it — permq and grantq search the permissions and the grants, permissionsPage and grantsPage page them (listState) — with every application in the registry for the two selects (allApplications) and the page’s settings block. allowed is the register with its filter and paging, as the page answered it before.
Mirrors GET /admin/delegation-settings on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
permq |
query | string | Part of a permission’s resource. | |
grantq |
query | string | Part of a grant’s client or resource. | |
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. | |
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. | |
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 register, its list state, the applications and the settings block.
| Member | Type | Required | What it is |
|---|---|---|---|
allApplications |
list | ||
allApplications[].identifier |
string | ||
allApplications[].name |
string | ||
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 | ||
allowed.grants[].client |
string | ||
allowed.grants[].clientName |
string | ||
allowed.grants[].dangling |
boolean | ||
allowed.grants[].description |
string | ||
allowed.grants[].permissionId |
string | ||
allowed.grants[].permissionName |
string | ||
allowed.grants[].resource |
string | ||
allowed.grants[].resourceName |
string | ||
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 | ||
allowed.permissions[].description |
string | ||
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 | ||
allowed.permissions[].raw |
string | ||
allowed.permissions[].resource |
string | ||
allowed.permissions[].resourceName |
string | ||
allowed.resources |
list | ||
allowed.resources[].baseUri |
string | ||
allowed.resources[].grantsHeld |
integer | ||
allowed.resources[].identifier |
string | ||
allowed.resources[].name |
string | ||
allowed.resources[].permissions |
list | ||
allowed.resources[].permissions[].description |
string | ||
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 | ||
allowed.resources[].permissions[].raw |
string | ||
allowed.resources[].rawBaseUri |
string | ||
listState |
object | ||
listState.grantPage |
object | ||
listState.grantPage.paging |
object | ||
listState.grantPage.paging.firstRow |
integer | ||
listState.grantPage.paging.lastRow |
integer | ||
listState.grantPage.paging.noun |
string, or null | ||
listState.grantPage.paging.page |
integer | ||
listState.grantPage.paging.pages |
integer | ||
listState.grantPage.paging.param |
string, or null | ||
listState.grantPage.paging.perPage |
integer | ||
listState.grantPage.paging.total |
integer | ||
listState.grantPage.shown |
list | ||
listState.grantPage.shown[].asked |
boolean | ||
listState.grantPage.shown[].baseUri |
string | ||
listState.grantPage.shown[].client |
string | ||
listState.grantPage.shown[].clientName |
string | ||
listState.grantPage.shown[].dangling |
boolean | ||
listState.grantPage.shown[].description |
string | ||
listState.grantPage.shown[].permissionId |
string | ||
listState.grantPage.shown[].permissionName |
string | ||
listState.grantPage.shown[].resource |
string | ||
listState.grantPage.shown[].resourceName |
string | ||
listState.grantWanted |
string | ||
listState.permPage |
object | ||
listState.permPage.paging |
object | ||
listState.permPage.paging.firstRow |
integer | ||
listState.permPage.paging.lastRow |
integer | ||
listState.permPage.paging.noun |
string, or null | ||
listState.permPage.paging.page |
integer | ||
listState.permPage.paging.pages |
integer | ||
listState.permPage.paging.param |
string, or null | ||
listState.permPage.paging.perPage |
integer | ||
listState.permPage.paging.total |
integer | ||
listState.permPage.shown |
list | ||
listState.permPage.shown[].baseUri |
string | ||
listState.permPage.shown[].description |
string | ||
listState.permPage.shown[].grantedTo |
list | ||
listState.permPage.shown[].grantedTo[].asked |
boolean | ||
listState.permPage.shown[].grantedTo[].identifier |
string | ||
listState.permPage.shown[].grantedTo[].name |
string | ||
listState.permPage.shown[].id |
string, or null | ||
listState.permPage.shown[].name |
string | ||
listState.permPage.shown[].raw |
string | ||
listState.permPage.shown[].resource |
string | ||
listState.permPage.shown[].resourceName |
string | ||
listState.permWanted |
string | ||
register |
object | ||
register.counts |
object | ||
register.counts.clients |
integer | ||
register.counts.dangling |
integer | ||
register.counts.grants |
integer | ||
register.counts.permissions |
integer | ||
register.counts.resources |
integer | ||
register.counts.ungranted |
integer | ||
register.counts.unidentified |
integer | ||
register.counts.unused |
integer | ||
register.grants |
list | ||
register.grants[].asked |
boolean | ||
register.grants[].baseUri |
string | ||
register.grants[].client |
string | ||
register.grants[].clientName |
string | ||
register.grants[].dangling |
boolean | ||
register.grants[].description |
string | ||
register.grants[].permissionId |
string | ||
register.grants[].permissionName |
string | ||
register.grants[].resource |
string | ||
register.grants[].resourceName |
string | ||
register.permissions |
list | ||
register.permissions[].baseUri |
string | ||
register.permissions[].description |
string | ||
register.permissions[].grantedTo |
list | ||
register.permissions[].grantedTo[].asked |
boolean | ||
register.permissions[].grantedTo[].identifier |
string | ||
register.permissions[].grantedTo[].name |
string | ||
register.permissions[].id |
string, or null | ||
register.permissions[].name |
string | ||
register.permissions[].raw |
string | ||
register.permissions[].resource |
string | ||
register.permissions[].resourceName |
string | ||
register.resources |
list | ||
register.resources[].baseUri |
string | ||
register.resources[].grantsHeld |
integer | ||
register.resources[].identifier |
string | ||
register.resources[].name |
string | ||
register.resources[].permissions |
list | ||
register.resources[].permissions[].description |
string | ||
register.resources[].permissions[].grantedTo |
list | ||
register.resources[].permissions[].grantedTo[].asked |
boolean | ||
register.resources[].permissions[].grantedTo[].identifier |
string | ||
register.resources[].permissions[].grantedTo[].name |
string | ||
register.resources[].permissions[].id |
string, or null | ||
register.resources[].permissions[].name |
string | ||
register.resources[].permissions[].raw |
string | ||
register.resources[].rawBaseUri |
string | ||
settings |
object | ||
settings.context |
object | ||
settings.context.configFile |
string, or null | ||
settings.context.defaultsFile |
string, or null | ||
settings.context.inRealm |
boolean | ||
settings.context.persistenceMode |
string | ||
settings.context.persistsAppconfig |
boolean | ||
settings.context.persistsRealms |
boolean | ||
settings.context.realmId |
string | ||
settings.editableCount |
integer | ||
settings.groups |
list | ||
settings.groups[].group |
string | ||
settings.groups[].settings |
list | ||
settings.groups[].settings[].appconfigPath |
string | ||
settings.groups[].settings[].csvValueNotes |
map | A sentence per value of the row. | |
settings.groups[].settings[].csvValueNotes.{key} |
string | ||
settings.groups[].settings[].csvValues |
list | ||
settings.groups[].settings[].csvValues[] |
string | ||
settings.groups[].settings[].default |
list | ||
settings.groups[].settings[].default[] |
string or number or boolean | ||
settings.groups[].settings[].description |
string | ||
settings.groups[].settings[].editRefusal |
string, or null | ||
settings.groups[].settings[].editable |
boolean | ||
settings.groups[].settings[].enumValues |
list | ||
settings.groups[].settings[].enumValues[] |
string | ||
settings.groups[].settings[].env |
string, or null | ||
settings.groups[].settings[].group |
string | ||
settings.groups[].settings[].key |
string | ||
settings.groups[].settings[].label |
string | ||
settings.groups[].settings[].legacyEnv |
list, or string, or null | ||
settings.groups[].settings[].legacyEnv[] |
string | ||
settings.groups[].settings[].masked |
boolean | ||
settings.groups[].settings[].max |
number | ||
settings.groups[].settings[].min |
number | ||
settings.groups[].settings[].ordered |
boolean | ||
settings.groups[].settings[].overridden |
boolean | ||
settings.groups[].settings[].realmSettable |
boolean | ||
settings.groups[].settings[].restartReason |
string, or null | ||
settings.groups[].settings[].selectAll |
object | ||
settings.groups[].settings[].selectAll.aloneWhileOn |
list | ||
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn |
list | ||
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].source |
string | ||
settings.groups[].settings[].step |
number | ||
settings.groups[].settings[].text |
string, or null | ||
settings.groups[].settings[].type |
string | ||
settings.groups[].settings[].value |
list | ||
settings.groups[].settings[].value[] |
string or number or boolean | ||
settings.overridden |
list | ||
settings.overridden[] |
string | ||
settings.page |
string | ||
settings.setWith |
string | ||
settings.settingCount |
integer | ||
settings.sharedWith |
map | The other pages a settings group is drawn on. | |
settings.sharedWith.{key} |
list | ||
settings.sharedWith.{key}[].label |
string | ||
settings.sharedWith.{key}[].path |
string |
GET /admin-api/console/delegation/allowed
getDelegationAllowed
The configured delegated permissions, drawn, and groups
Every delegated permission somebody configured — a client granted a permission a resource exposes — as a graph with, as for /delegation/map, looks, the drawing (svg) and its size. groups are the sets of applications the grants join, paged on groupsPage as GET /admin-api/permissions/groups summarises them; shownGroups are those groups in full and clusters all of them, which is what the page’s chooser searches.
With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/delegation/allowed on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
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. | |
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
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. | |
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 graph, the groups, the register and the drawing.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
apps |
map | Each name in the answer the registry holds. | |
apps.{key}.dnLabel |
string | ||
apps.{key}.name |
string | ||
clusters |
object | ||
clusters.clusters |
list | ||
clusters.clusters[].counts |
object | ||
clusters.clusters[].counts.applications |
integer | ||
clusters.clusters[].counts.asked |
integer | ||
clusters.clusters[].counts.dangling |
integer | ||
clusters.clusters[].counts.grants |
integer | ||
clusters.clusters[].counts.lines |
integer | ||
clusters.clusters[].counts.permissions |
integer | ||
clusters.clusters[].counts.selfGrants |
integer | ||
clusters.clusters[].counts.unused |
integer | ||
clusters.clusters[].grants |
list | ||
clusters.clusters[].grants[].asked |
boolean | ||
clusters.clusters[].grants[].baseUri |
string | ||
clusters.clusters[].grants[].client |
string | ||
clusters.clusters[].grants[].clientName |
string | ||
clusters.clusters[].grants[].dangling |
boolean | ||
clusters.clusters[].grants[].description |
string | ||
clusters.clusters[].grants[].permissionId |
string | ||
clusters.clusters[].grants[].permissionName |
string | ||
clusters.clusters[].grants[].resource |
string | ||
clusters.clusters[].grants[].resourceName |
string | ||
clusters.clusters[].key |
string | ||
clusters.clusters[].members |
list | ||
clusters.clusters[].members[] |
string | ||
clusters.clusters[].permissions |
list | ||
clusters.clusters[].permissions[].baseUri |
string | ||
clusters.clusters[].permissions[].description |
string | ||
clusters.clusters[].permissions[].grantedTo |
list | ||
clusters.clusters[].permissions[].grantedTo[].asked |
boolean | ||
clusters.clusters[].permissions[].grantedTo[].identifier |
string | ||
clusters.clusters[].permissions[].grantedTo[].name |
string | ||
clusters.clusters[].permissions[].id |
string, or null | ||
clusters.clusters[].permissions[].name |
string | ||
clusters.clusters[].permissions[].raw |
string | ||
clusters.clusters[].permissions[].resource |
string | ||
clusters.clusters[].permissions[].resourceName |
string | ||
clusters.counts |
object | ||
clusters.counts.alone |
integer | ||
clusters.counts.applications |
integer | ||
clusters.counts.clusters |
integer | ||
clusters.counts.joined |
integer | ||
clusters.counts.largest |
integer | ||
clusters.memberOf |
map | Each application, to its group’s key. | |
clusters.memberOf.{key} |
string | ||
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 | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.width |
number | ||
facts |
object | ||
facts.apps |
map | Each name in the answer the registry holds. | |
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | Each name in the answer that is a known person. | |
facts.users.{key} |
boolean | ||
grants |
list | ||
grants[].asked |
boolean | ||
grants[].baseUri |
string | ||
grants[].client |
string | ||
grants[].clientName |
string | ||
grants[].dangling |
boolean | ||
grants[].description |
string | ||
grants[].permissionId |
string | ||
grants[].permissionName |
string | ||
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 | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string | ||
graph.credentials[].flowOidc |
string | ||
graph.credentials[].flowProtocol |
string | ||
graph.credentials[].flowSpec |
string | ||
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 | ||
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 | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string | ||
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 | ||
graph.edges[].firstAt |
number | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number | ||
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 | ||
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 | ||
graph.edges[].subject |
string | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string | ||
graph.edges[].typeLabel |
string | ||
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 | ||
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 | ||
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 | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
integer | ||
graph.nodes[].roles.intermediary |
integer | ||
graph.nodes[].roles.target |
integer | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string | ||
graph.tokens[].at |
number | ||
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 | ||
graph.tokens[].target |
string | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
groupCounts |
object | ||
groupCounts.alone |
integer | ||
groupCounts.applications |
integer | ||
groupCounts.clusters |
integer | ||
groupCounts.joined |
integer | ||
groupCounts.largest |
integer | ||
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 | ||
groupsPaging |
object | ||
groupsPaging.firstRow |
integer | ||
groupsPaging.lastRow |
integer | ||
groupsPaging.noun |
string, or null | ||
groupsPaging.page |
integer | ||
groupsPaging.pages |
integer | ||
groupsPaging.param |
string, or null | ||
groupsPaging.perPage |
integer | ||
groupsPaging.total |
integer | ||
label |
string | ||
looks |
map | Each node’s look, by node id. | |
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string, or null | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string, or null | ||
looks.{key}.title |
string | ||
register |
object | ||
register.counts |
object | ||
register.counts.clients |
integer | ||
register.counts.dangling |
integer | ||
register.counts.grants |
integer | ||
register.counts.permissions |
integer | ||
register.counts.resources |
integer | ||
register.counts.ungranted |
integer | ||
register.counts.unidentified |
integer | ||
register.counts.unused |
integer | ||
register.grants |
list | ||
register.grants[].asked |
boolean | ||
register.grants[].baseUri |
string | ||
register.grants[].client |
string | ||
register.grants[].clientName |
string | ||
register.grants[].dangling |
boolean | ||
register.grants[].description |
string | ||
register.grants[].permissionId |
string | ||
register.grants[].permissionName |
string | ||
register.grants[].resource |
string | ||
register.grants[].resourceName |
string | ||
register.permissions |
list | ||
register.permissions[].baseUri |
string | ||
register.permissions[].description |
string | ||
register.permissions[].grantedTo |
list | ||
register.permissions[].grantedTo[].asked |
boolean | ||
register.permissions[].grantedTo[].identifier |
string | ||
register.permissions[].grantedTo[].name |
string | ||
register.permissions[].id |
string, or null | ||
register.permissions[].name |
string | ||
register.permissions[].raw |
string | ||
register.permissions[].resource |
string | ||
register.permissions[].resourceName |
string | ||
register.resources |
list | ||
register.resources[].baseUri |
string | ||
register.resources[].grantsHeld |
integer | ||
register.resources[].identifier |
string | ||
register.resources[].name |
string | ||
register.resources[].permissions |
list | ||
register.resources[].permissions[].description |
string | ||
register.resources[].permissions[].grantedTo |
list | ||
register.resources[].permissions[].grantedTo[].asked |
boolean | ||
register.resources[].permissions[].grantedTo[].identifier |
string | ||
register.resources[].permissions[].grantedTo[].name |
string | ||
register.resources[].permissions[].id |
string, or null | ||
register.resources[].permissions[].name |
string | ||
register.resources[].permissions[].raw |
string | ||
register.resources[].rawBaseUri |
string | ||
shownGroups |
list | ||
shownGroups[].counts |
object | ||
shownGroups[].counts.applications |
integer | ||
shownGroups[].counts.asked |
integer | ||
shownGroups[].counts.dangling |
integer | ||
shownGroups[].counts.grants |
integer | ||
shownGroups[].counts.lines |
integer | ||
shownGroups[].counts.permissions |
integer | ||
shownGroups[].counts.selfGrants |
integer | ||
shownGroups[].counts.unused |
integer | ||
shownGroups[].grants |
list | ||
shownGroups[].grants[].asked |
boolean | ||
shownGroups[].grants[].baseUri |
string | ||
shownGroups[].grants[].client |
string | ||
shownGroups[].grants[].clientName |
string | ||
shownGroups[].grants[].dangling |
boolean | ||
shownGroups[].grants[].description |
string | ||
shownGroups[].grants[].permissionId |
string | ||
shownGroups[].grants[].permissionName |
string | ||
shownGroups[].grants[].resource |
string | ||
shownGroups[].grants[].resourceName |
string | ||
shownGroups[].key |
string | ||
shownGroups[].members |
list | ||
shownGroups[].members[] |
string | ||
shownGroups[].permissions |
list | ||
shownGroups[].permissions[].baseUri |
string | ||
shownGroups[].permissions[].description |
string | ||
shownGroups[].permissions[].grantedTo |
list | ||
shownGroups[].permissions[].grantedTo[].asked |
boolean | ||
shownGroups[].permissions[].grantedTo[].identifier |
string | ||
shownGroups[].permissions[].grantedTo[].name |
string | ||
shownGroups[].permissions[].id |
string, or null | ||
shownGroups[].permissions[].name |
string | ||
shownGroups[].permissions[].raw |
string | ||
shownGroups[].permissions[].resource |
string | ||
shownGroups[].permissions[].resourceName |
string | ||
svg |
string |
As image/svg+xml.
GET /admin-api/console/delegation/application
getConsoleDelegationApplication
One application’s delegations, drawn
What GET /admin-api/delegation/application answers, with every node’s look, the drawing (svg) and its size, and the page’s chooser, key and facts. With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/delegation/application on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
application |
query | string | The application, as a protocol presented it or normalised. | |
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
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 | ||
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, or null | ||
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 | ||
application.identifier |
string | ||
application.identityKey |
string | ||
application.issued |
integer | ||
application.key |
string | ||
application.lastAt |
number | ||
application.protocols |
list | ||
application.protocols[] |
string | ||
application.refused |
integer | ||
application.roles |
object | ||
application.roles.initial |
integer | ||
application.roles.intermediary |
integer | ||
application.roles.target |
integer | ||
application.spellings |
list | ||
application.spellings[] |
string | ||
applications |
list | ||
applications[].acts |
integer | ||
applications[].chains |
integer | ||
applications[].credentials |
integer | ||
applications[].firstAt |
number | ||
applications[].identifier |
string | ||
applications[].identityKey |
string | ||
applications[].issued |
integer | ||
applications[].key |
string | ||
applications[].lastAt |
number | ||
applications[].protocols |
list | ||
applications[].protocols[] |
string | ||
applications[].refused |
integer | ||
applications[].roles |
object | ||
applications[].roles.initial |
integer | ||
applications[].roles.intermediary |
integer | ||
applications[].roles.target |
integer | ||
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 | ||
chooser.search |
one of contains, exact |
||
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.width |
number | ||
facts |
object | ||
facts.apps |
map | Each name in the answer the registry holds. | |
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | Each name in the answer that is a known person. | |
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 | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string | ||
graph.credentials[].flowOidc |
string | ||
graph.credentials[].flowProtocol |
string | ||
graph.credentials[].flowSpec |
string | ||
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 | ||
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 | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string | ||
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 | ||
graph.edges[].firstAt |
number | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number | ||
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 | ||
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 | ||
graph.edges[].subject |
string | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string | ||
graph.edges[].typeLabel |
string | ||
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 | ||
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 | ||
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 | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
integer | ||
graph.nodes[].roles.intermediary |
integer | ||
graph.nodes[].roles.target |
integer | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string | ||
graph.tokens[].at |
number | ||
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 | ||
graph.tokens[].target |
string | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
held |
integer | ||
key |
string | ||
label |
string | ||
looks |
map | Each node’s look, by node id. | |
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string, or null | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string, or null | ||
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 | The roles played, by the act’s seq. |
|
rolesBySeq.{key} |
list | ||
rolesBySeq.{key}[] |
string | ||
svg |
string |
As image/svg+xml.
GET /admin-api/console/delegation/chain
getDelegationChain
One delegation relationship: its acts, graph and drawing
One chain — (mechanism, initial identity, intermediary, target) — named by its chain key, as GET /admin-api/delegation lists them in chains. The answer is the chain, every act on it (not paged), the graph of those acts and, as for /delegation/map, looks, the drawing (svg, laid out on the server, with its links) and its size.
A KEY NO ACT IS HELD UNDER IS NOT AN ERROR: the store is capped and drops the oldest, so the answer is found: false with maxRecords.
With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/delegation/chain on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
chain |
query | string | The chain’s key, chainKey on a chain of GET /admin-api/delegation. |
|
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
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 chain, 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 | ||
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, or null | ||
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 | ||
chain |
object | ||
chain.acts |
integer | ||
chain.authorizedBy |
string | ||
chain.chainKey |
string | ||
chain.firstAt |
number | ||
chain.initial |
object | ||
chain.initial.application |
string | ||
chain.initial.key |
string | ||
chain.initial.presented |
string | ||
chain.initial.what |
string | ||
chain.intermediary |
object | ||
chain.intermediary.application |
string | ||
chain.intermediary.key |
string | ||
chain.intermediary.presented |
string | ||
chain.intermediary.what |
string | ||
chain.issued |
integer | ||
chain.lastAt |
number | ||
chain.mode |
string | ||
chain.protocol |
string | ||
chain.reason |
string | ||
chain.refused |
integer | ||
chain.target |
object | ||
chain.target.application |
string | ||
chain.target.key |
string | ||
chain.target.presented |
string | ||
chain.target.what |
string | ||
chain.type |
string | ||
chain.typeLabel |
string | ||
chainKey |
string | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.width |
number | ||
facts |
object | ||
facts.apps |
map | Each name in the answer the registry holds. | |
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | Each name in the answer that is a known person. | |
facts.users.{key} |
boolean | ||
found |
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 | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string | ||
graph.credentials[].flowOidc |
string | ||
graph.credentials[].flowProtocol |
string | ||
graph.credentials[].flowSpec |
string | ||
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 | ||
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 | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string | ||
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 | ||
graph.edges[].firstAt |
number | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number | ||
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 | ||
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 | ||
graph.edges[].subject |
string | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string | ||
graph.edges[].typeLabel |
string | ||
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 | ||
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 | ||
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 | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
integer | ||
graph.nodes[].roles.intermediary |
integer | ||
graph.nodes[].roles.target |
integer | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string | ||
graph.tokens[].at |
number | ||
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 | ||
graph.tokens[].target |
string | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
held |
integer | ||
label |
string | ||
looks |
map | Each node’s look, by node id. | |
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string, or null | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string, or null | ||
looks.{key}.title |
string | ||
mapKey |
string | ||
maxRecords |
integer | ||
svg |
string |
As image/svg+xml.
GET /admin-api/console/delegation/cluster
getDelegationCluster
One group of applications joined by permissions, drawn
The group an application is in — the applications reachable from it by following delegated permissions either way — as GET /admin-api/permissions/groups?application= answers it, with the group whole (cluster), its grants and permissions paged (groupGrantsPage, groupPermissionsPage), the graph and, as for /delegation/map, looks, the drawing (svg) and its size. With no application, or one the register does not hold, the groups are paged instead (groupPage).
With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/delegation/cluster on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
application |
query | string | The application’s identifier, exactly. | |
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
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. | |
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. | |
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 group, its pages, the chooser’s data and the drawing.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
application |
string, or null | ||
apps |
map | Each name in the answer the registry holds. | |
apps.{key}.dnLabel |
string | ||
apps.{key}.name |
string | ||
asked |
string | ||
cluster |
object | ||
cluster.counts |
object | ||
cluster.counts.applications |
integer | ||
cluster.counts.asked |
integer | ||
cluster.counts.dangling |
integer | ||
cluster.counts.grants |
integer | ||
cluster.counts.lines |
integer | ||
cluster.counts.permissions |
integer | ||
cluster.counts.selfGrants |
integer | ||
cluster.counts.unused |
integer | ||
cluster.grants |
list | ||
cluster.grants[].asked |
boolean | ||
cluster.grants[].baseUri |
string | ||
cluster.grants[].client |
string | ||
cluster.grants[].clientName |
string | ||
cluster.grants[].dangling |
boolean | ||
cluster.grants[].description |
string | ||
cluster.grants[].permissionId |
string | ||
cluster.grants[].permissionName |
string | ||
cluster.grants[].resource |
string | ||
cluster.grants[].resourceName |
string | ||
cluster.key |
string | ||
cluster.members |
list | ||
cluster.members[] |
string | ||
cluster.permissions |
list | ||
cluster.permissions[].baseUri |
string | ||
cluster.permissions[].description |
string | ||
cluster.permissions[].grantedTo |
list | ||
cluster.permissions[].grantedTo[].asked |
boolean | ||
cluster.permissions[].grantedTo[].identifier |
string | ||
cluster.permissions[].grantedTo[].name |
string | ||
cluster.permissions[].id |
string, or null | ||
cluster.permissions[].name |
string | ||
cluster.permissions[].raw |
string | ||
cluster.permissions[].resource |
string | ||
cluster.permissions[].resourceName |
string | ||
clusters |
object | ||
clusters.clusters |
list | ||
clusters.clusters[].counts |
object | ||
clusters.clusters[].counts.applications |
integer | ||
clusters.clusters[].counts.asked |
integer | ||
clusters.clusters[].counts.dangling |
integer | ||
clusters.clusters[].counts.grants |
integer | ||
clusters.clusters[].counts.lines |
integer | ||
clusters.clusters[].counts.permissions |
integer | ||
clusters.clusters[].counts.selfGrants |
integer | ||
clusters.clusters[].counts.unused |
integer | ||
clusters.clusters[].grants |
list | ||
clusters.clusters[].grants[].asked |
boolean | ||
clusters.clusters[].grants[].baseUri |
string | ||
clusters.clusters[].grants[].client |
string | ||
clusters.clusters[].grants[].clientName |
string | ||
clusters.clusters[].grants[].dangling |
boolean | ||
clusters.clusters[].grants[].description |
string | ||
clusters.clusters[].grants[].permissionId |
string | ||
clusters.clusters[].grants[].permissionName |
string | ||
clusters.clusters[].grants[].resource |
string | ||
clusters.clusters[].grants[].resourceName |
string | ||
clusters.clusters[].key |
string | ||
clusters.clusters[].members |
list | ||
clusters.clusters[].members[] |
string | ||
clusters.clusters[].permissions |
list | ||
clusters.clusters[].permissions[].baseUri |
string | ||
clusters.clusters[].permissions[].description |
string | ||
clusters.clusters[].permissions[].grantedTo |
list | ||
clusters.clusters[].permissions[].grantedTo[].asked |
boolean | ||
clusters.clusters[].permissions[].grantedTo[].identifier |
string | ||
clusters.clusters[].permissions[].grantedTo[].name |
string | ||
clusters.clusters[].permissions[].id |
string, or null | ||
clusters.clusters[].permissions[].name |
string | ||
clusters.clusters[].permissions[].raw |
string | ||
clusters.clusters[].permissions[].resource |
string | ||
clusters.clusters[].permissions[].resourceName |
string | ||
clusters.counts |
object | ||
clusters.counts.alone |
integer | ||
clusters.counts.applications |
integer | ||
clusters.counts.clusters |
integer | ||
clusters.counts.joined |
integer | ||
clusters.counts.largest |
integer | ||
clusters.memberOf |
map | Each application, to its group’s key. | |
clusters.memberOf.{key} |
string | ||
counts |
object | ||
counts.alone |
integer | ||
counts.applications |
integer | ||
counts.clusters |
integer | ||
counts.joined |
integer | ||
counts.largest |
integer | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.width |
number | ||
facts |
object | ||
facts.apps |
map | Each name in the answer the registry holds. | |
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | Each name in the answer that is a known person. | |
facts.users.{key} |
boolean | ||
grantPage |
object | ||
grantPage.paging |
object | ||
grantPage.paging.firstRow |
integer | ||
grantPage.paging.lastRow |
integer | ||
grantPage.paging.noun |
string, or null | ||
grantPage.paging.page |
integer | ||
grantPage.paging.pages |
integer | ||
grantPage.paging.param |
string, or null | ||
grantPage.paging.perPage |
integer | ||
grantPage.paging.total |
integer | ||
grantPage.shown |
list | ||
grantPage.shown[].asked |
boolean | ||
grantPage.shown[].baseUri |
string | ||
grantPage.shown[].client |
string | ||
grantPage.shown[].clientName |
string | ||
grantPage.shown[].dangling |
boolean | ||
grantPage.shown[].description |
string | ||
grantPage.shown[].permissionId |
string | ||
grantPage.shown[].permissionName |
string | ||
grantPage.shown[].resource |
string | ||
grantPage.shown[].resourceName |
string | ||
grants |
list | ||
grants[].asked |
boolean | ||
grants[].baseUri |
string | ||
grants[].client |
string | ||
grants[].clientName |
string | ||
grants[].dangling |
boolean | ||
grants[].description |
string | ||
grants[].permissionId |
string | ||
grants[].permissionName |
string | ||
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 | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string | ||
graph.credentials[].flowOidc |
string | ||
graph.credentials[].flowProtocol |
string | ||
graph.credentials[].flowSpec |
string | ||
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 | ||
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 | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string | ||
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 | ||
graph.edges[].firstAt |
number | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number | ||
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 | ||
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 | ||
graph.edges[].subject |
string | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string | ||
graph.edges[].typeLabel |
string | ||
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 | ||
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 | ||
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 | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
integer | ||
graph.nodes[].roles.intermediary |
integer | ||
graph.nodes[].roles.target |
integer | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string | ||
graph.tokens[].at |
number | ||
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 | ||
graph.tokens[].target |
string | ||
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 | ||
groupPage |
object | ||
groupPage.paging |
object | ||
groupPage.paging.firstRow |
integer | ||
groupPage.paging.lastRow |
integer | ||
groupPage.paging.noun |
string, or null | ||
groupPage.paging.page |
integer | ||
groupPage.paging.pages |
integer | ||
groupPage.paging.param |
string, or null | ||
groupPage.paging.perPage |
integer | ||
groupPage.paging.total |
integer | ||
groupPage.shown |
list | ||
groupPage.shown[].counts |
object | ||
groupPage.shown[].counts.applications |
integer | ||
groupPage.shown[].counts.asked |
integer | ||
groupPage.shown[].counts.dangling |
integer | ||
groupPage.shown[].counts.grants |
integer | ||
groupPage.shown[].counts.lines |
integer | ||
groupPage.shown[].counts.permissions |
integer | ||
groupPage.shown[].counts.selfGrants |
integer | ||
groupPage.shown[].counts.unused |
integer | ||
groupPage.shown[].grants |
list | ||
groupPage.shown[].grants[].asked |
boolean | ||
groupPage.shown[].grants[].baseUri |
string | ||
groupPage.shown[].grants[].client |
string | ||
groupPage.shown[].grants[].clientName |
string | ||
groupPage.shown[].grants[].dangling |
boolean | ||
groupPage.shown[].grants[].description |
string | ||
groupPage.shown[].grants[].permissionId |
string | ||
groupPage.shown[].grants[].permissionName |
string | ||
groupPage.shown[].grants[].resource |
string | ||
groupPage.shown[].grants[].resourceName |
string | ||
groupPage.shown[].key |
string | ||
groupPage.shown[].members |
list | ||
groupPage.shown[].members[] |
string | ||
groupPage.shown[].permissions |
list | ||
groupPage.shown[].permissions[].baseUri |
string | ||
groupPage.shown[].permissions[].description |
string | ||
groupPage.shown[].permissions[].grantedTo |
list | ||
groupPage.shown[].permissions[].grantedTo[].asked |
boolean | ||
groupPage.shown[].permissions[].grantedTo[].identifier |
string | ||
groupPage.shown[].permissions[].grantedTo[].name |
string | ||
groupPage.shown[].permissions[].id |
string, or null | ||
groupPage.shown[].permissions[].name |
string | ||
groupPage.shown[].permissions[].raw |
string | ||
groupPage.shown[].permissions[].resource |
string | ||
groupPage.shown[].permissions[].resourceName |
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 | ||
label |
string | ||
looks |
map | Each node’s look, by node id. | |
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string, or null | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string, or null | ||
looks.{key}.title |
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 | ||
permissionPage |
object | ||
permissionPage.paging |
object | ||
permissionPage.paging.firstRow |
integer | ||
permissionPage.paging.lastRow |
integer | ||
permissionPage.paging.noun |
string, or null | ||
permissionPage.paging.page |
integer | ||
permissionPage.paging.pages |
integer | ||
permissionPage.paging.param |
string, or null | ||
permissionPage.paging.perPage |
integer | ||
permissionPage.paging.total |
integer | ||
permissionPage.shown |
list | ||
permissionPage.shown[].baseUri |
string | ||
permissionPage.shown[].description |
string | ||
permissionPage.shown[].grantedTo |
list | ||
permissionPage.shown[].grantedTo[].asked |
boolean | ||
permissionPage.shown[].grantedTo[].identifier |
string | ||
permissionPage.shown[].grantedTo[].name |
string | ||
permissionPage.shown[].id |
string, or null | ||
permissionPage.shown[].name |
string | ||
permissionPage.shown[].raw |
string | ||
permissionPage.shown[].resource |
string | ||
permissionPage.shown[].resourceName |
string | ||
permissions |
list | ||
permissions[].baseUri |
string | ||
permissions[].description |
string | ||
permissions[].grantedTo |
list | ||
permissions[].grantedTo[].asked |
boolean | ||
permissions[].grantedTo[].identifier |
string | ||
permissions[].grantedTo[].name |
string | ||
permissions[].id |
string, or null | ||
permissions[].name |
string | ||
permissions[].raw |
string | ||
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 | ||
register |
object | ||
register.counts |
object | ||
register.counts.clients |
integer | ||
register.counts.dangling |
integer | ||
register.counts.grants |
integer | ||
register.counts.permissions |
integer | ||
register.counts.resources |
integer | ||
register.counts.ungranted |
integer | ||
register.counts.unidentified |
integer | ||
register.counts.unused |
integer | ||
register.grants |
list | ||
register.grants[].asked |
boolean | ||
register.grants[].baseUri |
string | ||
register.grants[].client |
string | ||
register.grants[].clientName |
string | ||
register.grants[].dangling |
boolean | ||
register.grants[].description |
string | ||
register.grants[].permissionId |
string | ||
register.grants[].permissionName |
string | ||
register.grants[].resource |
string | ||
register.grants[].resourceName |
string | ||
register.permissions |
list | ||
register.permissions[].baseUri |
string | ||
register.permissions[].description |
string | ||
register.permissions[].grantedTo |
list | ||
register.permissions[].grantedTo[].asked |
boolean | ||
register.permissions[].grantedTo[].identifier |
string | ||
register.permissions[].grantedTo[].name |
string | ||
register.permissions[].id |
string, or null | ||
register.permissions[].name |
string | ||
register.permissions[].raw |
string | ||
register.permissions[].resource |
string | ||
register.permissions[].resourceName |
string | ||
register.resources |
list | ||
register.resources[].baseUri |
string | ||
register.resources[].grantsHeld |
integer | ||
register.resources[].identifier |
string | ||
register.resources[].name |
string | ||
register.resources[].permissions |
list | ||
register.resources[].permissions[].description |
string | ||
register.resources[].permissions[].grantedTo |
list | ||
register.resources[].permissions[].grantedTo[].asked |
boolean | ||
register.resources[].permissions[].grantedTo[].identifier |
string | ||
register.resources[].permissions[].grantedTo[].name |
string | ||
register.resources[].permissions[].id |
string, or null | ||
register.resources[].permissions[].name |
string | ||
register.resources[].permissions[].raw |
string | ||
register.resources[].rawBaseUri |
string | ||
svg |
string |
As image/svg+xml.
GET /admin-api/console/delegation/map
getDelegationMap
The delegation picture: the graph, each box, the drawing
The same acts as GET /admin-api/delegation, with the time taken out and the parties shared: a party that is the intermediary of six chains is ONE node with six edges. Drawn from everything that MATCHED the filter, not from one page of it.
nodes and edges are the graph. looks says what each node IS, by node id: its label, its shape, the identifier a protocol would present for it, and the console page it links to — which the directory and the application registry decide. svg is the drawing, laid out on the server, with its links in it; drawing is its size, and says so if the layout failed. summary carries the counts by mechanism, kind and outcome that the filter’s choices show.
With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/delegation/map on the admin console.
Scope: admin:console.
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. | |
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
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 graph, every node’s look, the counts and the drawing.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
acts |
integer | ||
all |
integer | ||
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 | ||
applicationChooser.search |
one of contains, exact |
||
applicationChooser.slice |
object | ||
applicationChooser.slice.from |
integer | ||
applicationChooser.slice.matched |
integer | ||
applicationChooser.total |
integer | ||
chains |
integer | ||
directoryLoaded |
boolean | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.width |
number | ||
edges |
list | ||
edges[].actor |
string | ||
edges[].acts |
integer | ||
edges[].asked |
boolean | ||
edges[].attribute |
string | ||
edges[].audience |
string | ||
edges[].audienceRegistered |
boolean | ||
edges[].authentications |
list | ||
edges[].authentications[].at |
number | ||
edges[].authentications[].count |
integer | ||
edges[].authentications[].lastAt |
number | ||
edges[].authentications[].method |
string | ||
edges[].authentications[].protocol |
string | ||
edges[].authorizedBy |
string | ||
edges[].baseUri |
string | ||
edges[].chainKey |
string | ||
edges[].consumed |
list | ||
edges[].consumed[].count |
integer | ||
edges[].consumed[].identifiers |
list | ||
edges[].consumed[].identifiers[] |
string | ||
edges[].consumed[].kind |
string | ||
edges[].consumed[].moreIdentifiers |
integer | ||
edges[].consumed[].notes |
list | ||
edges[].consumed[].notes[] |
string | ||
edges[].consumedFold |
map | ||
edges[].consumedFold.{key}.count |
integer | ||
edges[].consumedFold.{key}.identifiers |
list | ||
edges[].consumedFold.{key}.identifiers[] |
string | ||
edges[].consumedFold.{key}.kind |
string | ||
edges[].consumedFold.{key}.moreIdentifiers |
integer | ||
edges[].consumedFold.{key}.notes |
list | ||
edges[].consumedFold.{key}.notes[] |
string | ||
edges[].credentials |
integer | ||
edges[].description |
string | ||
edges[].firstAt |
number | ||
edges[].from |
string | ||
edges[].fromRole |
string | ||
edges[].id |
string | ||
edges[].issued |
integer | ||
edges[].lastAt |
number | ||
edges[].mechanism |
string | ||
edges[].mode |
string | ||
edges[].permissionId |
string | ||
edges[].permissionName |
string | ||
edges[].permissions |
list | ||
edges[].permissions[] |
string | ||
edges[].policed |
boolean | ||
edges[].produced |
list | ||
edges[].produced[].count |
integer | ||
edges[].produced[].identifiers |
list | ||
edges[].produced[].identifiers[] |
string | ||
edges[].produced[].kind |
string | ||
edges[].produced[].moreIdentifiers |
integer | ||
edges[].produced[].notes |
list | ||
edges[].produced[].notes[] |
string | ||
edges[].producedFold |
map | ||
edges[].producedFold.{key}.count |
integer | ||
edges[].producedFold.{key}.identifiers |
list | ||
edges[].producedFold.{key}.identifiers[] |
string | ||
edges[].producedFold.{key}.kind |
string | ||
edges[].producedFold.{key}.moreIdentifiers |
integer | ||
edges[].producedFold.{key}.notes |
list | ||
edges[].producedFold.{key}.notes[] |
string | ||
edges[].protocol |
string | ||
edges[].protocols |
list | ||
edges[].protocols[] |
string | ||
edges[].reason |
string | ||
edges[].refused |
integer | ||
edges[].relation |
string | ||
edges[].scopes |
list | ||
edges[].scopes[] |
string | ||
edges[].setOn |
string | ||
edges[].skipped |
list | ||
edges[].skipped[] |
string | ||
edges[].spec |
string | ||
edges[].subject |
string | ||
edges[].to |
string | ||
edges[].toRole |
string | ||
edges[].type |
string | ||
edges[].typeLabel |
string | ||
edges[].used |
boolean | ||
facts |
object | ||
facts.apps |
map | Each name in the answer the registry holds. | |
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | Each name in the answer that is a known person. | |
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 | ||
held |
integer | ||
issuer |
string | ||
label |
string | ||
looks |
map | Each node’s look, by node id. | |
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string, or null | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string, or null | ||
looks.{key}.title |
string | ||
mapKey |
string | ||
matched |
integer | ||
maxTokenRows |
integer | ||
modes |
list | ||
modes[].label |
string | ||
modes[].mode |
string | ||
modes[].what |
string | ||
nodes |
list | ||
nodes[].acts |
integer | ||
nodes[].aliases |
list | ||
nodes[].aliases[] |
string | ||
nodes[].application |
string | ||
nodes[].authentications |
integer | ||
nodes[].chiefRole |
string | ||
nodes[].credentials |
integer | ||
nodes[].dangling |
integer | ||
nodes[].exposes |
integer | ||
nodes[].firstAt |
number | ||
nodes[].flows |
list | ||
nodes[].flows[] |
string | ||
nodes[].grants |
integer | ||
nodes[].id |
string | ||
nodes[].isClient |
boolean | ||
nodes[].isSubject |
boolean | ||
nodes[].issued |
integer | ||
nodes[].issuer |
string | ||
nodes[].key |
string | ||
nodes[].kind |
string | ||
nodes[].kinds |
list | ||
nodes[].kinds[] |
string | ||
nodes[].lastAt |
number | ||
nodes[].presented |
string | ||
nodes[].protocols |
list | ||
nodes[].protocols[] |
string | ||
nodes[].realm |
object | ||
nodes[].realm.id |
string | ||
nodes[].realm.isDefault |
boolean | ||
nodes[].realm.name |
string | ||
nodes[].refused |
integer | ||
nodes[].roles |
object | ||
nodes[].roles.initial |
integer | ||
nodes[].roles.intermediary |
integer | ||
nodes[].roles.target |
integer | ||
nodes[].selfTarget |
boolean | ||
nodes[].what |
string | ||
outcomes |
list | ||
outcomes[] |
string | ||
realm |
object | ||
realm.id |
string | ||
realm.isDefault |
boolean | ||
realm.name |
string | ||
summary |
object | ||
summary.byMode |
map | Acts per mode. | |
summary.byMode.{key} |
integer | ||
summary.byOutcome |
map | Acts per outcome. | |
summary.byOutcome.{key} |
integer | ||
summary.byProtocol |
map | Acts per protocol. | |
summary.byProtocol.{key} |
integer | ||
summary.byType |
map | Acts per mechanism. | |
summary.byType.{key} |
integer | ||
summary.chains |
integer | ||
summary.dropped |
integer | ||
summary.held |
integer | ||
summary.heldHere |
integer | ||
summary.maxRecords |
integer | ||
summary.newestSeq |
number | ||
summary.oldestSeq |
number | ||
summary.processes |
integer | ||
summary.recorded |
integer | ||
svg |
string | ||
tokens |
list | ||
tokens[].actor |
string | ||
tokens[].at |
number | ||
tokens[].chainKey |
string | ||
tokens[].identifier |
string | ||
tokens[].kind |
string | ||
tokens[].mode |
string | ||
tokens[].note |
string | ||
tokens[].protocol |
string | ||
tokens[].seq |
number | ||
tokens[].subject |
string | ||
tokens[].target |
string | ||
tokens[].type |
string | ||
tokens[].typeLabel |
string | ||
tokensLeftOff |
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 | ||
userChooser.search |
one of contains, exact |
||
userChooser.slice |
object | ||
userChooser.slice.from |
integer | ||
userChooser.slice.matched |
integer | ||
userChooser.total |
integer |
As image/svg+xml.
GET /admin-api/console/delegation/user
getConsoleDelegationUser
One person’s delegations, drawn
What GET /admin-api/delegation/user answers, with every node’s look, the drawing (svg) and its size, and the page’s chooser, key and facts. With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/delegation/user on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | string | The person, under any spelling this service has seen them under. | |
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
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 | ||
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, or null | ||
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 | ||
chooser.search |
one of contains, exact |
||
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 | ||
credentials[].audience |
string | ||
credentials[].detail |
string | ||
credentials[].expiresAtMs |
number | ||
credentials[].family |
string | ||
credentials[].flow |
string | ||
credentials[].flowLabel |
string | ||
credentials[].flowOidc |
string | ||
credentials[].flowProtocol |
string | ||
credentials[].flowSpec |
string | ||
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.width |
number | ||
facts |
object | ||
facts.apps |
map | Each name in the answer the registry holds. | |
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | Each name in the answer that is a known person. | |
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 | ||
graph.credentials[].audience |
string | ||
graph.credentials[].detail |
string | ||
graph.credentials[].expiresAtMs |
number | ||
graph.credentials[].family |
string | ||
graph.credentials[].flow |
string | ||
graph.credentials[].flowLabel |
string | ||
graph.credentials[].flowOidc |
string | ||
graph.credentials[].flowProtocol |
string | ||
graph.credentials[].flowSpec |
string | ||
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 | ||
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 | ||
graph.edges[].authentications[].count |
integer | ||
graph.edges[].authentications[].lastAt |
number | ||
graph.edges[].authentications[].method |
string | ||
graph.edges[].authentications[].protocol |
string | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].baseUri |
string | ||
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 | ||
graph.edges[].firstAt |
number | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number | ||
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 | ||
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 | ||
graph.edges[].subject |
string | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string | ||
graph.edges[].typeLabel |
string | ||
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 | ||
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 | ||
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 | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
integer | ||
graph.nodes[].roles.intermediary |
integer | ||
graph.nodes[].roles.target |
integer | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string | ||
graph.subject |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string | ||
graph.tokens[].at |
number | ||
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 | ||
graph.tokens[].target |
string | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
key |
string | ||
label |
string | ||
looks |
map | Each node’s look, by node id. | |
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string, or null | ||
looks.{key}.identifier |
string, or null | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string, or null | ||
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 | ||
user.isClient |
boolean | ||
user.issued |
integer | ||
user.key |
string | ||
user.lastAt |
number | ||
user.name |
string | ||
user.presented |
string | ||
user.protocols |
list | ||
user.protocols[] |
string | ||
user.refused |
integer | ||
user.roles |
object | ||
user.roles.initial |
integer | ||
user.roles.intermediary |
integer | ||
user.roles.target |
integer | ||
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 | ||
users[].isClient |
boolean | ||
users[].issued |
integer | ||
users[].key |
string | ||
users[].lastAt |
number | ||
users[].name |
string | ||
users[].presented |
string | ||
users[].protocols |
list | ||
users[].protocols[] |
string | ||
users[].refused |
integer | ||
users[].roles |
object | ||
users[].roles.initial |
integer | ||
users[].roles.intermediary |
integer | ||
users[].roles.target |
integer | ||
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/console/federation/map
getFederationMap
This realm’s federation relationships, drawn
Every federation relationship of the trust realm, filtered by role, protocol and text, as a graph — the partners, this service and the applications behind each relationship — with the relationships and their sign-ins, the drawing (svg, laid out on the server, with its links), its size, the filter’s vocabulary and the key.
With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/federation/map on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
role |
query | string | Only relationships in this role. | |
protocol |
query | string | Only relationships in this protocol. | |
q |
query | string | Text anywhere in a relationship. | |
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
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 relationships, the graph and the drawing.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
counts |
object | ||
counts.applications |
integer | ||
counts.authentications |
integer | ||
counts.identityProvider |
integer | ||
counts.partners |
integer | ||
counts.relationships |
integer | ||
counts.serviceProvider |
integer | ||
counts.usable |
integer | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.width |
number | ||
edges |
list | ||
edges[].brokeredTo |
string | ||
edges[].from |
string | ||
edges[].id |
string | ||
edges[].relation |
string | ||
edges[].relationship |
string | ||
edges[].to |
string | ||
edges[].use |
object | ||
edges[].use.application |
string | ||
edges[].use.authentications |
integer | ||
edges[].use.configured |
boolean | ||
edges[].use.lastSeen |
string | ||
edges[].use.lastUser |
string | ||
edges[].use.source |
string | ||
edges[].use.users |
integer | ||
edges[].use.via |
string | ||
empty |
boolean | ||
filter |
object | ||
filter.protocol |
string | ||
filter.q |
string | ||
filter.role |
string | ||
filtered |
boolean | ||
label |
string | ||
mapKey |
string | ||
nodes |
list | ||
nodes[].id |
string | ||
nodes[].kind |
string | ||
nodes[].label |
string | ||
nodes[].relationships |
list | ||
nodes[].relationships[] |
string | ||
protocols |
list | ||
protocols[].family |
string | ||
protocols[].label |
string | ||
protocols[].needs |
list | ||
protocols[].needs[] |
string | ||
protocols[].protocol |
string | ||
protocols[].signalsOnly |
boolean | ||
protocols[].spec |
string | ||
protocols[].what |
string | ||
realm |
object | ||
realm.id |
string | ||
realm.isDefault |
boolean | ||
realm.name |
string | ||
relationships |
list | ||
relationships[].application |
string | ||
relationships[].applicationCount |
integer | ||
relationships[].applications |
list | ||
relationships[].applications[].application |
string | ||
relationships[].applications[].authentications |
integer | ||
relationships[].applications[].configured |
boolean | ||
relationships[].applications[].lastSeen |
string | ||
relationships[].applications[].lastUser |
string | ||
relationships[].applications[].source |
string | ||
relationships[].applications[].users |
integer | ||
relationships[].applications[].via |
string | ||
relationships[].attributed |
integer | ||
relationships[].authentications |
integer | ||
relationships[].brokerProblem |
string | ||
relationships[].brokerUsable |
boolean | ||
relationships[].brokeredUse |
object | ||
relationships[].brokeredUse.application |
string | ||
relationships[].brokeredUse.authentications |
integer | ||
relationships[].brokeredUse.configured |
boolean | ||
relationships[].brokeredUse.lastSeen |
string | ||
relationships[].brokeredUse.lastUser |
string | ||
relationships[].brokeredUse.source |
string | ||
relationships[].brokeredUse.users |
integer | ||
relationships[].brokeredUse.via |
string | ||
relationships[].brokersTo |
string | ||
relationships[].dn |
string | ||
relationships[].enabled |
boolean | ||
relationships[].id |
string | ||
relationships[].lastError |
string | ||
relationships[].lastErrorAt |
string | ||
relationships[].lastSeen |
string | ||
relationships[].lastUser |
string | ||
relationships[].mechanism |
string | ||
relationships[].mechanismConfigured |
boolean | ||
relationships[].mechanismKnown |
boolean | ||
relationships[].mechanismLabel |
string | ||
relationships[].missing |
list | ||
relationships[].missing[] |
string | ||
relationships[].name |
string | ||
relationships[].peer |
string | ||
relationships[].protocol |
string | ||
relationships[].protocolLabel |
string | ||
relationships[].ready |
boolean | ||
relationships[].releases |
list | ||
relationships[].releases[] |
string | ||
relationships[].role |
string | ||
relationships[].roleLabel |
string | ||
relationships[].signalsEnabled |
boolean | ||
relationships[].signsIn |
boolean | ||
relationships[].unattributed |
integer | ||
relationships[].usable |
boolean | ||
relationships[].users |
integer | ||
roles |
list | ||
roles[].label |
string | ||
roles[].role |
string | ||
roles[].short |
string | ||
roles[].what |
string | ||
svg |
string |
As image/svg+xml.
POST /admin-api/console/language
setConsoleLanguage
Set the language the console is drawn in, for yourself
Writes the signed-in person’s own preferredLanguage (RFC 2798), or removes it when lang is empty, and answers the console’s catalogs in the language now in force. A tag no catalog answers is refused (400, STS-I18N-0008).
Mirrors GET /admin on the admin console.
Scope: admin:console.
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 (optional)
| Member | Type | Required | What it is |
|---|---|---|---|
lang |
string | A BCP 47 tag a catalog answers, such as fr-CA, or empty to follow the browser. |
200: The console’s language and catalogs.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
locale |
object | ||
locale.catalogFiles |
map | Each static catalog, by language tag. | |
locale.catalogFiles.{key} |
string | ||
locale.catalogs |
map | Each catalog along the chain, by language tag. | |
locale.catalogs.{key} |
map | A translated message by its key. | |
locale.catalogs.{key}.{key} |
string | ||
locale.negotiated |
object | ||
locale.negotiated.catalog |
string | ||
locale.negotiated.chain |
list | ||
locale.negotiated.chain[] |
string | ||
locale.negotiated.direction |
one of ltr, rtl |
||
locale.negotiated.locale |
string | ||
locale.negotiated.matched |
boolean | ||
locale.offered |
list | ||
locale.offered[].name |
string | ||
locale.offered[].tag |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing was handed over.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
locale |
object | ||
locale.catalogFiles |
map | Each static catalog, by language tag. | |
locale.catalogFiles.{key} |
string | ||
locale.catalogs |
map | Each catalog along the chain, by language tag. | |
locale.catalogs.{key} |
map | A translated message by its key. | |
locale.catalogs.{key}.{key} |
string | ||
locale.negotiated |
object | ||
locale.negotiated.catalog |
string | ||
locale.negotiated.chain |
list | ||
locale.negotiated.chain[] |
string | ||
locale.negotiated.direction |
one of ltr, rtl |
||
locale.negotiated.locale |
string | ||
locale.negotiated.matched |
boolean | ||
locale.offered |
list | ||
locale.offered[].name |
string | ||
locale.offered[].tag |
string | ||
ok |
boolean | yes |
GET /admin-api/console/openapi.json
getConsoleOpenApi
The OpenAPI 3.1 document for the console’s operations
The operations under /admin-api/console, built from the same table as GET /admin-api/openapi.json, which describes the management operations alone. For maintainers and tests: these answers follow the console’s pages and are not a contract.
Mirrors GET /admin/sts-metadata on the admin console.
Scope: admin:console.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The document.
| Member | Type | Required | What it is |
|---|---|---|---|
components |
any JSON | The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. | |
info |
object | yes | |
info.description |
string | ||
info.license |
object | ||
info.license.name |
string | ||
info.title |
string | ||
info.version |
string | ||
openapi |
string | yes | |
paths |
any JSON | yes | The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. |
security |
list | ||
security[] |
map | The scopes a security scheme needs, by the scheme’s name. | |
security[].{key} |
list | ||
security[].{key}[] |
string | ||
servers |
list | ||
servers[].description |
string | ||
servers[].url |
string | ||
tags |
list | ||
tags[].description |
string | ||
tags[].name |
string |
GET /admin-api/console/operations
getConsoleOperations
Every operation of both kinds, for the console’s forms
Every operation this API registers, management and console alike, with the console control it mirrors and its kind: the table the static console resolves a form to the operation it posts to through. The index, GET /admin-api, lists the management operations alone.
Mirrors GET /admin on the admin console.
Scope: admin:console.
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 operation.
| Member | Type | Required | What it is |
|---|---|---|---|
operations |
list | ||
operations[].drawnOn |
list | ||
operations[].drawnOn[] |
string | ||
operations[].kind |
string | ||
operations[].method |
string | ||
operations[].mirrors |
string | ||
operations[].operationId |
string | ||
operations[].path |
string | ||
operations[].query |
list | ||
operations[].query[] |
string | ||
operations[].summary |
string |
POST /admin-api/console/pki/apply-profile
applyPkiProfile
Fill the certificate form in from a profile
Rewrites the twenty-two extension boxes, the default validity and the profile’s Common Name from the profile named in pki_profile, and narrows the two algorithm menus to the approach in pki_pq_mode. Nothing is issued.
A COMMON NAME SOMEBODY TYPED IS NEVER OVERWRITTEN — an empty one, or one still holding ANY profile’s own default, is replaced. Picking Intermediate CA after Root CA would otherwise issue an intermediate called “RootCA”, which chains correctly and reads as a bug for as long as it takes somebody to notice.
Post the whole form back; anything omitted falls to its default rather than being kept.
Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.
Scope: admin:console.
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 (optional)
An empty object.
200: The form, as it should now be drawn, in draft.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |
POST /admin-api/console/pki/generate-alt-keys
generatePkiAltKeyPair
Generate the alternative (hybrid) key pair
The second key of a hybrid certificate — ITU-T X.509 (2019) clause 9.8’s subjectAltPublicKeyInfo. The list is the post-quantum algorithms that can sign, because a hybrid certificate whose second key is also RSA is a certificate signed twice by the same century. Issuing with pki_pq_mode=hybrid generates one anyway if the boxes are empty.
Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.
Scope: admin:console.
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 (optional)
An empty object.
200: The form with the alternative pair in it.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |
POST /admin-api/console/pki/generate-keys
generatePkiKeyPair
Generate a key pair into the form without issuing anything
Puts a fresh pair in pki_private_key and pki_public_key, in the algorithm named by pki_key_alg.
IT EXISTS BECAUSE GENERATION CAN BE SLOW. An SLH-DSA pair takes seconds and this process is single-threaded, so making one and then issuing four certificates from it (with pki_reuse_key) is the difference between a usable surface and one that stalls the whole service four times over.
Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.
Scope: admin:console.
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 (optional)
An empty object.
200: The form with the new pair in it, in draft.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |
POST /admin-api/console/pki/use-key
usePkiStoredKey
Load a stored object’s key pair back into the form
What a CA renewing its own certificate does. It ticks pki_reuse_key itself, because a pair loaded into the boxes and then silently replaced by a fresh one at the next issue is the most confusing thing this surface could do. Everything else on the form is kept.
Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.
Scope: admin:console.
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 |
|---|---|---|---|
objectId |
string | yes | The id of a row in workbench.objects. |
200: The form with that key pair in it.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
draft |
map | The certificate form, by field name. | |
draft.{key} |
string or boolean or number, or null | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | yes | |
why |
string | ||
workbench |
object | ||
workbench.accessMethods |
list | ||
workbench.accessMethods[] |
string | ||
workbench.alternativeKeyAlgorithms |
list | ||
workbench.alternativeKeyAlgorithms[].family |
string | ||
workbench.alternativeKeyAlgorithms[].id |
string | ||
workbench.alternativeKeyAlgorithms[].kind |
string | ||
workbench.alternativeKeyAlgorithms[].label |
string | ||
workbench.alternativeKeyAlgorithms[].signs |
boolean | ||
workbench.alternativeKeyAlgorithms[].slow |
boolean | ||
workbench.dnFields |
list | ||
workbench.dnFields[].attr |
string | ||
workbench.dnFields[].field |
string | ||
workbench.draft |
map | The certificate form, by field name. | |
workbench.draft.{key} |
string or boolean or number, or null | ||
workbench.extendedKeyUsages |
list | ||
workbench.extendedKeyUsages[].name |
string | ||
workbench.extendedKeyUsages[].oid |
string | ||
workbench.fields |
list | ||
workbench.fields[] |
string | ||
workbench.issuers |
list | ||
workbench.issuers[].hasAlternativeKey |
boolean | ||
workbench.issuers[].id |
string | ||
workbench.issuers[].keyAlg |
string | ||
workbench.issuers[].label |
string | ||
workbench.issuers[].notAfter |
string | ||
workbench.issuers[].subject |
string | ||
workbench.keyAlgorithms |
list | ||
workbench.keyAlgorithms[].family |
string | ||
workbench.keyAlgorithms[].id |
string | ||
workbench.keyAlgorithms[].kind |
string | ||
workbench.keyAlgorithms[].label |
string | ||
workbench.keyAlgorithms[].signs |
boolean | ||
workbench.keyAlgorithms[].slow |
boolean | ||
workbench.keyUsageBits |
list | ||
workbench.keyUsageBits[].name |
string | ||
workbench.keyUsageBits[].what |
string | ||
workbench.keystoreFormats |
list | ||
workbench.keystoreFormats[] |
string | ||
workbench.maxObjects |
integer | ||
workbench.netscapeTypes |
list | ||
workbench.netscapeTypes[].name |
string | ||
workbench.objects |
list | ||
workbench.objects[].altKeyAlg |
string, or null | ||
workbench.objects[].altSigned |
boolean | ||
workbench.objects[].ca |
boolean | ||
workbench.objects[].certificatePem |
string, or null | ||
workbench.objects[].createdAt |
string, or number, or null | ||
workbench.objects[].csrPem |
string | ||
workbench.objects[].expired |
boolean | ||
workbench.objects[].hasCsr |
boolean | ||
workbench.objects[].hasPrivateKey |
boolean | ||
workbench.objects[].id |
string | ||
workbench.objects[].issuerId |
string, or null | ||
workbench.objects[].issuerSubject |
string, or null | ||
workbench.objects[].keyAlg |
string | ||
workbench.objects[].keyAlgLabel |
string, or null | ||
workbench.objects[].notAfter |
string, or null | ||
workbench.objects[].notBefore |
string, or null | ||
workbench.objects[].pqMode |
string, or null | ||
workbench.objects[].profile |
string, or null | ||
workbench.objects[].profileLabel |
string, or null | ||
workbench.objects[].selfSigned |
boolean | ||
workbench.objects[].serialHex |
string, or null | ||
workbench.objects[].signatureAlg |
string, or null | ||
workbench.objects[].signatureAlgLabel |
string, or null | ||
workbench.objects[].subject |
string | ||
workbench.objects[].thumbprint |
string, or null | ||
workbench.pqMode |
string | ||
workbench.pqModes |
list | ||
workbench.pqModes[].classical |
boolean | ||
workbench.pqModes[].families |
list | ||
workbench.pqModes[].families[] |
string | ||
workbench.pqModes[].id |
string | ||
workbench.pqModes[].label |
string | ||
workbench.pqModes[].note |
string | ||
workbench.profiles |
list | ||
workbench.profiles[].ca |
boolean | ||
workbench.profiles[].extKeyUsage |
list | ||
workbench.profiles[].extKeyUsage[] |
string | ||
workbench.profiles[].id |
string | ||
workbench.profiles[].keyUsage |
list | ||
workbench.profiles[].keyUsage[] |
string | ||
workbench.profiles[].label |
string | ||
workbench.profiles[].note |
string | ||
workbench.profiles[].pathLen |
number, or null | ||
workbench.profiles[].selfSigned |
boolean | ||
workbench.profiles[].years |
number | ||
workbench.signatureAlgorithms |
list | ||
workbench.signatureAlgorithms[].id |
string | ||
workbench.signatureAlgorithms[].kind |
string | ||
workbench.signatureAlgorithms[].label |
string | ||
workbench.signatureAlgorithms[].weak |
boolean | ||
workbench.signerLabel |
string | ||
workbench.slowFamilies |
list | ||
workbench.slowFamilies[] |
string |