This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.

Management API

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/uma

getUma

UMA 2.0: resource servers, resources, tickets, RPTs, pending approvals, an owner, the what-if, settings

Everything /admin/uma draws: whether UMA answers in this realm, its endpoints, the applications declared for uma with umaOwnsResources and the delegated permission grant a PAT needs, the registered resources (paged, resourcesPage; filtered by resourceServer and owner), the live permission tickets (ticketsPage, by the first characters of a hash, never the ticket), the live RPTs (rptsPage), the requests waiting for an owner (pendingPage), the UMA PEP’s counts, and the uma.* settings, written through POST /admin-api/config/set-many. ?owner=<username or application> adds that owner’s resources, document and waiting requests; an application’s owner asking about it is answered with that alone. ?resource=&scope= (with party and client) adds the what-if: every layer’s answer for that permission, asked as a dry run that is neither audited nor counted.

Mirrors GET /admin/uma on the admin console.

Scope: admin:read.

Parameters

Name In Type Required What it is
resourceServer query string   Narrows the registered resources to one resource server.
owner query string   A username or application: adds that owner’s resources, document and waiting requests.
resource query string   With scope, asks the what-if about this resource.
scope query string   The scope the what-if asks about.
party query string   The requesting party of the what-if.
client query string   The client of the what-if.
per query integer   Rows per page, shared by the four lists.
resourcesPage query integer   Which page of resources to return.
ticketsPage query integer   Which page of tickets to return.
rptsPage query integer   Which page of rpts to return.
pendingPage query integer   Which page of pending to return.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: enabled, endpoints, resourceServers, resources, tickets, rpts, pending, owner, whatIf, monitor, actions, settings.

Member Type Required What it is
actions list    
actions[] string    
enabled boolean    
endpoints any JSON   The realm’s RFC 8414 authorization server metadata with UMA’s members added (oauth2.asMetadata()), or nothing when UMA is off. Its members are an IANA registry’s and each is conditional on a setting, and GET /.well-known/uma2-configuration is where it is specified. The realm’s RFC 8414 authorization server metadata with UMA’s members added (oauth2.asMetadata()), or nothing when UMA is off. Its members are an IANA registry’s and each is conditional on a setting, and GET /.well-known/uma2-configuration is where it is specified.
filter object    
filter.owner string    
filter.resourceServer string    
monitor object    
monitor.allowed integer, or null    
monitor.bias string, or null    
monitor.decisions integer    
monitor.deny integer, or null    
monitor.dischargesObligations boolean    
monitor.enforces boolean    
monitor.guards string    
monitor.id string    
monitor.indeterminate integer, or null    
monitor.kind string    
monitor.label string    
monitor.lastAllowed boolean, or null    
monitor.lastAt string, or number, or null    
monitor.lastDecision string, or null    
monitor.module string    
monitor.notApplicable integer, or null    
monitor.other integer, or null    
monitor.permit integer, or null    
monitor.refused integer, or null    
monitor.remote object    
monitor.remote.authenticated boolean    
monitor.remote.certificateSubject string    
monitor.remote.current boolean    
monitor.remote.enabled boolean    
monitor.remote.lastNotify string    
monitor.remote.lastSeen string, or null    
monitor.remote.policyCount integer, or null    
monitor.remote.registeredAt string, or null    
monitor.remote.stale boolean    
monitor.remote.syncToken string    
monitor.remote.version string    
monitor.undischargeable integer    
monitor.where string    
owner object    
owner.asked string    
owner.document object    
owner.document.alfa string    
owner.document.alfaEditing boolean    
owner.document.custom list    
owner.document.custom[].alfa string    
owner.document.custom[].description string    
owner.document.custom[].id string    
owner.document.ok boolean    
owner.document.rules integer    
owner.document.shares list    
owner.document.shares[].acr string    
owner.document.shares[].askMe boolean    
owner.document.shares[].expires string    
owner.document.shares[].id string    
owner.document.shares[].recipient object    
owner.document.shares[].recipient.claim string    
owner.document.shares[].recipient.kind string    
owner.document.shares[].recipient.label string    
owner.document.shares[].recipient.value string    
owner.document.shares[].resourceId string    
owner.document.shares[].scopes list    
owner.document.shares[].scopes[] string    
owner.document.stored boolean    
owner.document.version string, or number    
owner.document.why string    
owner.documentXml string    
owner.editable boolean    
owner.found boolean    
owner.kind string    
owner.owner string    
owner.ownsResources boolean    
owner.pending list    
owner.pending[].client string    
owner.pending[].createdAt number    
owner.pending[].expiresAt number    
owner.pending[].id string    
owner.pending[].owner string    
owner.pending[].ownerKind string    
owner.pending[].permissions list    
owner.pending[].permissions[].name string    
owner.pending[].permissions[].resource string    
owner.pending[].permissions[].scopes list    
owner.pending[].permissions[].scopes[] string    
owner.pending[].requester string, or null    
owner.pending[].resourceServer string    
owner.pending[].state string    
owner.resources list    
owner.resources[].createdAt number    
owner.resources[].id string    
owner.resources[].name string    
owner.resources[].owner string    
owner.resources[].ownerKind string    
owner.resources[].resourceServer string    
owner.resources[].scopes list    
owner.resources[].scopes[] string    
owner.resources[].type string    
page string    
pending object    
pending.paging object    
pending.paging.firstRow integer    
pending.paging.lastRow integer    
pending.paging.noun string, or null    
pending.paging.page integer    
pending.paging.pages integer    
pending.paging.param string, or null    
pending.paging.perPage integer    
pending.paging.total integer    
pending.rows list    
pending.rows[].client string    
pending.rows[].createdAt number    
pending.rows[].expiresAt number    
pending.rows[].id string    
pending.rows[].owner string    
pending.rows[].ownerKind string    
pending.rows[].permissions list    
pending.rows[].permissions[].name string    
pending.rows[].permissions[].resource string    
pending.rows[].permissions[].scopes list    
pending.rows[].permissions[].scopes[] string    
pending.rows[].requester string, or null    
pending.rows[].resourceServer string    
pending.rows[].state string    
pending.total integer    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
resourceServers list    
resourceServers[].identifier string    
resourceServers[].name string    
resourceServers[].ownsResources boolean    
resourceServers[].pending integer    
resourceServers[].protectionGranted boolean    
resourceServers[].resources integer    
resourceServers[].rpts integer    
resourceServers[].tickets integer    
resources object    
resources.paging object    
resources.paging.firstRow integer    
resources.paging.lastRow integer    
resources.paging.noun string, or null    
resources.paging.page integer    
resources.paging.pages integer    
resources.paging.param string, or null    
resources.paging.perPage integer    
resources.paging.total integer    
resources.rows list    
resources.rows[].createdAt number    
resources.rows[].id string    
resources.rows[].name string    
resources.rows[].owner string    
resources.rows[].ownerKind string    
resources.rows[].resourceServer string    
resources.rows[].scopes list    
resources.rows[].scopes[] string    
resources.rows[].type string    
resources.total integer    
rpts object    
rpts.paging object    
rpts.paging.firstRow integer    
rpts.paging.lastRow integer    
rpts.paging.noun string, or null    
rpts.paging.page integer    
rpts.paging.pages integer    
rpts.paging.param string, or null    
rpts.paging.perPage integer    
rpts.paging.total integer    
rpts.rows list    
rpts.rows[].client string    
rpts.rows[].createdAt number    
rpts.rows[].exp number    
rpts.rows[].jti string    
rpts.rows[].permissions list    
rpts.rows[].permissions[].name string    
rpts.rows[].permissions[].resource string    
rpts.rows[].permissions[].scopes list    
rpts.rows[].permissions[].scopes[] string    
rpts.rows[].requestingParty string    
rpts.rows[].resourceServer string    
rpts.rows[].upgradedFrom string    
rpts.total integer    
settings object    
settings.context object    
settings.context.configFile string, or null    
settings.context.defaultsFile string, or null    
settings.context.inRealm boolean    
settings.context.persistenceMode string    
settings.context.persistsAppconfig boolean    
settings.context.persistsRealms boolean    
settings.context.realmId string    
settings.editableCount integer    
settings.groups list    
settings.groups[].group string    
settings.groups[].settings list    
settings.groups[].settings[].appconfigPath string    
settings.groups[].settings[].csvValueNotes map    
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string    
settings.groups[].settings[].default list, or string, or number, or boolean, or null    
settings.groups[].settings[].default[] string, or number, or boolean, or null    
settings.groups[].settings[].description string    
settings.groups[].settings[].editRefusal string, or null    
settings.groups[].settings[].editable boolean    
settings.groups[].settings[].enumValues list    
settings.groups[].settings[].enumValues[] string    
settings.groups[].settings[].env list, or string, or null    
settings.groups[].settings[].env[] string    
settings.groups[].settings[].group string    
settings.groups[].settings[].key string    
settings.groups[].settings[].label string    
settings.groups[].settings[].legacyEnv list, or string, or null    
settings.groups[].settings[].legacyEnv[] string    
settings.groups[].settings[].masked boolean    
settings.groups[].settings[].max number    
settings.groups[].settings[].min number    
settings.groups[].settings[].ordered boolean    
settings.groups[].settings[].overridden boolean    
settings.groups[].settings[].realmSettable boolean    
settings.groups[].settings[].restartReason string, or null    
settings.groups[].settings[].selectAll object    
settings.groups[].settings[].selectAll.aloneWhileOn list    
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn list    
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].source string    
settings.groups[].settings[].step number    
settings.groups[].settings[].text string, or number, or boolean, or null    
settings.groups[].settings[].type string    
settings.groups[].settings[].value list, or string, or number, or boolean, or null    
settings.groups[].settings[].value[] string, or number, or boolean, or null    
settings.overridden list    
settings.overridden[] string    
settings.page string    
settings.setWith string    
settings.settingCount integer    
settings.sharedWith map    
settings.sharedWith.{key} list    
settings.sharedWith.{key}[].label string, or null    
settings.sharedWith.{key}[].path string    
specifications list    
specifications[] string    
tickets object    
tickets.paging object    
tickets.paging.firstRow integer    
tickets.paging.lastRow integer    
tickets.paging.noun string, or null    
tickets.paging.page integer    
tickets.paging.pages integer    
tickets.paging.param string, or null    
tickets.paging.perPage integer    
tickets.paging.total integer    
tickets.rows list    
tickets.rows[].expiresAt number    
tickets.rows[].issuedAt number    
tickets.rows[].key string    
tickets.rows[].owner string    
tickets.rows[].pending string    
tickets.rows[].permissions list    
tickets.rows[].permissions[].name string    
tickets.rows[].permissions[].resource string    
tickets.rows[].permissions[].scopes list    
tickets.rows[].permissions[].scopes[] string    
tickets.rows[].resourceServer string    
tickets.rows[].state string    
tickets.total integer    
title string    
whatIf object    
whatIf.asked object    
whatIf.asked.client string    
whatIf.asked.party string    
whatIf.asked.resource string    
whatIf.asked.scope string    
whatIf.code string    
whatIf.layers list    
whatIf.layers[].approval boolean    
whatIf.layers[].decision string    
whatIf.layers[].layer string    
whatIf.layers[].missing list    
whatIf.layers[].missing[] string    
whatIf.layers[].outcome string    
whatIf.layers[].policy string    
whatIf.layers[].why string    
whatIf.outcome string    
whatIf.problem string    

POST /admin-api/uma/delete-resource

deleteUmaResource

Delete a registered UMA resource

Removes the resource as its resource server’s DELETE would, and revokes every live RPT carrying a permission over it. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
resource string yes The resource’s _id.

200: The resource, and how many RPTs were revoked.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
resource string    
revoked integer    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
resource string    
revoked integer    

POST /admin-api/uma/disable-resource-server

disableUmaResourceServer

Stop an application being a UMA resource server

Takes uma and the uma_protection grant off the application, and revokes every live RPT issued for it. Its registered resources stay, unreachable, until it is enabled again or they are deleted. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
application string yes The application’s identifier.

200: The application, and how many RPTs were revoked.

Member Type Required What it is
application string    
changed boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
ownsResources boolean    
revoked integer    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
application string    
changed boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
ownsResources boolean    
revoked integer    

POST /admin-api/uma/enable-resource-server

enableUmaResourceServer

Make an application a UMA resource server

Adds uma to the application’s appAllowedProtocol and the delegated permission grant of urn:sts:uma-protection-api:uma_protection, which a PAT needs. A value already there is left. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
application string yes The application’s identifier.

200: The application, and whether it changed.

Member Type Required What it is
application string    
changed boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
ownsResources boolean    
revoked integer    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
application string    
changed boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
ownsResources boolean    
revoked integer    

GET /admin-api/uma/monitor

getUmaMonitor

The UMA PEP’s counts and what each resource server holds

The uma row of /admin/xacml/monitor (decisions, allowed, refused, since the process started) and, per resource server, its resources, live tickets, live RPTs and waiting requests. Per trust realm, and with no reset: the durable record is GET /admin-api/audit.

Mirrors GET /admin/uma#uma-tab-servers 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: pep, resourceServers, totals.

Member Type Required What it is
pep object    
pep.allowed integer, or null    
pep.bias string, or null    
pep.decisions integer    
pep.deny integer, or null    
pep.dischargesObligations boolean    
pep.enforces boolean    
pep.guards string    
pep.id string    
pep.indeterminate integer, or null    
pep.kind string    
pep.label string    
pep.lastAllowed boolean, or null    
pep.lastAt string, or number, or null    
pep.lastDecision string, or null    
pep.module string    
pep.notApplicable integer, or null    
pep.other integer, or null    
pep.permit integer, or null    
pep.refused integer, or null    
pep.remote object    
pep.remote.authenticated boolean    
pep.remote.certificateSubject string    
pep.remote.current boolean    
pep.remote.enabled boolean    
pep.remote.lastNotify string    
pep.remote.lastSeen string, or null    
pep.remote.policyCount integer, or null    
pep.remote.registeredAt string, or null    
pep.remote.stale boolean    
pep.remote.syncToken string    
pep.remote.version string    
pep.undischargeable integer    
pep.where string    
resourceServers list    
resourceServers[].identifier string    
resourceServers[].name string    
resourceServers[].ownsResources boolean    
resourceServers[].pending integer    
resourceServers[].protectionGranted boolean    
resourceServers[].resources integer    
resourceServers[].rpts integer    
resourceServers[].tickets integer    
totals object    
totals.pending integer    
totals.resources integer    
totals.rpts integer    
totals.tickets integer    

POST /admin-api/uma/owner-approve

approveUmaRequest

Approve a request waiting for an application

Approves a request_submitted waiting for an application that owns resources: a rule for it is written into the document. The client’s next try with its ticket is decided afresh. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
owner string yes The application whose document it is; it must carry umaOwnsResources TRUE.
pending string yes The waiting request’s id.

200: The request as it now is.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
pending object    
pending.client string    
pending.createdAt number    
pending.expiresAt number    
pending.id string    
pending.owner string    
pending.ownerKind string    
pending.permissions list    
pending.permissions[].resource_id string    
pending.permissions[].resource_scopes list    
pending.permissions[].resource_scopes[] string    
pending.requester string, or null    
pending.requestingParty string    
pending.resourceServer string    
pending.state string    
pending.ticketKey string    
pending.updatedAt number    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
pending object    
pending.client string    
pending.createdAt number    
pending.expiresAt number    
pending.id string    
pending.owner string    
pending.ownerKind string    
pending.permissions list    
pending.permissions[].resource_id string    
pending.permissions[].resource_scopes list    
pending.permissions[].resource_scopes[] string    
pending.requester string, or null    
pending.requestingParty string    
pending.resourceServer string    
pending.state string    
pending.ticketKey string    
pending.updatedAt number    

POST /admin-api/uma/owner-refuse

refuseUmaRequest

Refuse a request waiting for an application

Refuses a request_submitted waiting for an application that owns resources. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
owner string yes The application whose document it is; it must carry umaOwnsResources TRUE.
pending string yes The waiting request’s id.

200: The request as it now is.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
pending object    
pending.client string    
pending.createdAt number    
pending.expiresAt number    
pending.id string    
pending.owner string    
pending.ownerKind string    
pending.permissions list    
pending.permissions[].resource_id string    
pending.permissions[].resource_scopes list    
pending.permissions[].resource_scopes[] string    
pending.requester string, or null    
pending.requestingParty string    
pending.resourceServer string    
pending.state string    
pending.ticketKey string    
pending.updatedAt number    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
pending object    
pending.client string    
pending.createdAt number    
pending.expiresAt number    
pending.id string    
pending.owner string    
pending.ownerKind string    
pending.permissions list    
pending.permissions[].resource_id string    
pending.permissions[].resource_scopes list    
pending.permissions[].resource_scopes[] string    
pending.requester string, or null    
pending.requestingParty string    
pending.resourceServer string    
pending.state string    
pending.ticketKey string    
pending.updatedAt number    

POST /admin-api/uma/owner-share

shareUmaResource

Share an application’s resource

Adds a share to the document of an application that owns UMA resources, as a person does on /portal/shared. An application’s owners may call it under the owner rule. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
acr string   An authentication context the requesting party must have.
askMe string   on: ask the owner each time.
claim string   For a claim share, its name.
expires string   When it ends (a date), or empty.
owner string yes The application whose document it is; it must carry umaOwnsResources TRUE.
recipient string   A username, a group, or a claim’s value; nothing for realm.
recipientKind one of person, group, realm, claim yes Who it is shared with.
resource string yes The resource’s _id.
scope list, or string yes  
scope[] string    

200: The share as written.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
revoked integer    
share object    
share.acr string    
share.askMe boolean    
share.expires string    
share.id string    
share.recipient object    
share.recipient.claim string    
share.recipient.kind string    
share.recipient.label string    
share.recipient.value string    
share.resourceId string    
share.scopes list    
share.scopes[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
revoked integer    
share object    
share.acr string    
share.askMe boolean    
share.expires string    
share.id string    
share.recipient object    
share.recipient.claim string    
share.recipient.kind string    
share.recipient.label string    
share.recipient.value string    
share.resourceId string    
share.scopes list    
share.scopes[] string    

POST /admin-api/uma/owner-unshare

unshareUmaResource

Remove a share from an application’s document

Removes one share and revokes the RPTs it permitted. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
owner string yes The application whose document it is; it must carry umaOwnsResources TRUE.
share string yes The share’s id.

200: What was removed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
revoked integer    
share object    
share.acr string    
share.askMe boolean    
share.expires string    
share.id string    
share.recipient object    
share.recipient.claim string    
share.recipient.kind string    
share.recipient.label string    
share.recipient.value string    
share.resourceId string    
share.scopes list    
share.scopes[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
revoked integer    
share object    
share.acr string    
share.askMe boolean    
share.expires string    
share.id string    
share.recipient object    
share.recipient.claim string    
share.recipient.kind string    
share.recipient.label string    
share.recipient.value string    
share.resourceId string    
share.scopes list    
share.scopes[] string    

POST /admin-api/uma/revoke-rpt

revokeUmaRpt

Revoke one RPT

Revokes a live RPT by its jti: introspection answers inactive from then on. Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
rpt string yes The RPT’s jti.

200: The jti, and how many were revoked.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
revoked integer    
rpt string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
revoked integer    
rpt string    

POST /admin-api/uma/set-owns-resources

setUmaOwnsResources

Let an application own UMA resources, or not

Sets umaOwnsResources (rcbj’s decision 5): TRUE lets a PAT the application obtained as itself register resources it owns; anything else clears it, after which such a PAT is refused (STS-UMA-0105). Audited.

Mirrors POST /admin/uma on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
application string yes The application’s identifier.
value one of TRUE, FALSE yes TRUE, or FALSE to clear it.

200: The application and its value now.

Member Type Required What it is
application string    
changed boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
ownsResources boolean    
revoked integer    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
application string    
changed boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
ownsResources boolean    
revoked integer