What this service has done since it started.
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/metrics
getMetrics
Every call, every artifact, and both kinds of session
Endpoint calls by matched route and status class, tokens and artifacts by kind with the state of each, and sessions counted BOTH ways — the browser sign-on sessions this process holds, and the sessions implied by what it has issued. The two disagree on purpose; the schema says why.
Mirrors GET /admin/metrics on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The snapshot.
| Member | Type | Required | What it is |
|---|---|---|---|
artifacts |
object | ||
artifacts.byKind |
list | ||
artifacts.byKind[].expired |
integer | ||
artifacts.byKind[].issued |
integer | ||
artifacts.byKind[].kind |
string | ||
artifacts.byKind[].noExpiry |
integer | ||
artifacts.byKind[].valid |
integer | ||
artifacts.cap |
integer | ||
artifacts.forgotten |
integer | ||
artifacts.held |
integer | ||
artifacts.heldHere |
integer | ||
calls |
object | Endpoint calls, in total and per matched route. | |
calls.byStatusClass |
map | ||
calls.byStatusClass.{key} |
number | ||
calls.healthProbes |
integer | ||
calls.paths |
integer | ||
calls.pathsCollapsed |
integer | ||
calls.pathsElsewhere |
integer | ||
calls.pathsHere |
integer | ||
calls.rows |
list | ||
calls.rows[].count |
number | ||
calls.rows[].lastAt |
number | ||
calls.rows[].lastStatus |
integer, or null | ||
calls.rows[].matched |
boolean | ||
calls.rows[].maxMs |
number | ||
calls.rows[].method |
string | ||
calls.rows[].path |
string | ||
calls.rows[].statuses |
map | ||
calls.rows[].statuses.{key} |
number | ||
calls.rows[].totalMs |
number | ||
calls.total |
integer | ||
claims |
list | The custom claim sets and how many claims each holds. | |
claims[].claims |
list | ||
claims[].claims[].attribute |
string | ||
claims[].claims[].multi |
boolean | ||
claims[].claims[].name |
string | ||
claims[].claims[].nameFormat |
string | ||
claims[].claims[].namespace |
string | ||
claims[].claims[].type |
string | ||
claims[].claims[].value |
list, or string, or number, or boolean, or null | ||
claims[].claims[].value[] |
string, or number, or boolean | ||
claims[].count |
integer | ||
claims[].id |
string | ||
claims[].label |
string | ||
now |
number | When this snapshot was taken, in milliseconds, so that every age in it can be worked out without trusting the caller’s clock. | |
sessions |
object | ||
sessions.distinctSubjects |
integer | ||
sessions.families |
list | ||
sessions.families[].family |
string | ||
sessions.families[].subjects |
integer | ||
sessions.families[].who |
list | ||
sessions.families[].who[] |
string | ||
signOnSessions |
object | ||
signOnSessions.active |
integer, or null | ||
signOnSessions.held |
integer, or null | ||
signOnSessions.rows |
list | ||
signOnSessions.rows[].accountSet |
string | ||
signOnSessions.rows[].acr |
string | ||
signOnSessions.rows[].amr |
string | ||
signOnSessions.rows[].authTime |
number | ||
signOnSessions.rows[].authentications |
integer | ||
signOnSessions.rows[].deviceBound |
object | ||
signOnSessions.rows[].deviceBound.alg |
string | ||
signOnSessions.rows[].deviceBound.bound |
boolean | ||
signOnSessions.rows[].deviceBound.boundAt |
number | ||
signOnSessions.rows[].deviceBound.fact |
string | ||
signOnSessions.rows[].deviceBound.reasons |
list | ||
signOnSessions.rows[].deviceBound.reasons[] |
string | ||
signOnSessions.rows[].deviceBound.refreshedAt |
number | ||
signOnSessions.rows[].deviceBound.refreshes |
number | ||
signOnSessions.rows[].expired |
boolean | ||
signOnSessions.rows[].expires |
number | ||
signOnSessions.rows[].id |
string | ||
signOnSessions.rows[].startedAt |
number | ||
signOnSessions.rows[].sub |
string | ||
signOnSessions.rows[].username |
string | ||
signOnSessions.rows[].wsfedRealms |
list | ||
signOnSessions.rows[].wsfedRealms[] |
string | ||
signOnSessions.unread |
boolean | ||
signOnSessions.windowed |
boolean | ||
startedAt |
number | Milliseconds since the epoch. | |
startedAtIso |
string | ||
tokens |
object | JWTs by kind, with the state of each. | |
tokens.byKind |
list | ||
tokens.byKind[].bound |
integer | ||
tokens.byKind[].expired |
integer | ||
tokens.byKind[].issued |
integer | ||
tokens.byKind[].kind |
string | ||
tokens.byKind[].noExpiry |
integer | ||
tokens.byKind[].notYetValid |
integer | ||
tokens.byKind[].revoked |
integer | ||
tokens.byKind[].valid |
integer | ||
tokens.cap |
integer | ||
tokens.forgotten |
integer | ||
tokens.held |
integer | ||
tokens.heldOnly |
boolean | ||
tokens.revoked |
integer | ||
uptimeMs |
number | ||
users |
object | ||
users.authenticatedHere |
integer | ||
users.authentications |
integer | ||
users.cap |
integer | ||
users.clients |
integer | ||
users.forgotten |
integer | ||
users.heldOnly |
boolean | ||
users.known |
integer |