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

getOwnership

Who owns an object, and whether its owners may administer it

One role, group, service account or application (#607): found, its dn, its owners (DNs as stored), protected — whether it is CLOSED to its owners, who may then not administer it through this API with owner:read and owner:write — with reasons, one sentence each, and marked, whether an administrator’s mark is one of them. An object is closed when it is a native or built-in role, a role authorizing a permission of this service, a group this service grants through by its name or a member of such a role, one of this service’s own applications or one declaring or holding such a permission, a service account holding one, or marked.

Mirrors no console form — the owner rule's facts; the mark is stsOwnerProtected on the entry on the admin console.

Scope: admin:read.

Parameters

Name In Type Required What it is
kind query one of role, group, service-account, application yes Which kind of object.
name query string yes A role’s name, a group’s cn or DN, a service account’s username, an application’s identifier.
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 object’s ownership facts.

Member Type Required What it is
dn string    
found boolean    
kind string    
marked boolean    
name string    
owners list    
owners[] string    
protected boolean    
reasons list    
reasons[] string    

400: The answer.

Member Type Required What it is
error string    
error_description string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/ownership/set-protected

setOwnerProtected

Close an object to its owners, or open it again

Writes stsOwnerProtected on the object’s own entry (#607, rcbj’s decision 4), keeping everything else: protected true closes it — its owners may no longer read or change it through this API with owner:read and owner:write — and false takes the mark off, which opens it unless another reason closes it (GET /admin-api/ownership). An owner stays an owner either way.

Mirrors POST /admin/roles/owners, POST /admin/groups/owners, POST /admin/applications/owners, POST /admin/users/service-account 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
kind one of role, group, service-account, application yes Which kind of object.
name string yes The object, as GET /admin-api/ownership names it.
protected boolean or string yes true closes it to its owners; false opens it again.

200: Whether it changed, and the mark as it now stands (ownerProtected).

Member Type Required What it is
account object    
account.destination string    
account.dn string    
account.ownerProtected boolean    
account.owners list    
account.owners[].dn string    
account.owners[].kind string    
account.owners[].name string    
account.owners[].present boolean    
account.policy string    
account.previousPasswordExpires number    
account.rotatedAt string    
account.rotation object    
account.rotation.failures number    
account.rotation.lastAttempt number    
account.rotation.lastError string    
account.secretName string    
account.serviceAccount boolean    
account.username string    
changed boolean    
errors list    
errors[] string    
kind string    
message string    
name string    
ok boolean yes  
ownerProtected boolean    
reason string    
why string    

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

Member Type Required What it is
account object    
account.destination string    
account.dn string    
account.ownerProtected boolean    
account.owners list    
account.owners[].dn string    
account.owners[].kind string    
account.owners[].name string    
account.owners[].present boolean    
account.policy string    
account.previousPasswordExpires number    
account.rotatedAt string    
account.rotation object    
account.rotation.failures number    
account.rotation.lastAttempt number    
account.rotation.lastError string    
account.secretName string    
account.serviceAccount boolean    
account.username string    
changed boolean    
errors list    
errors[] string    
kind string    
message string    
name string    
ok boolean yes  
ownerProtected boolean    
reason string    
why string