OperatorAPI opus:list

newadmapi (Operator API) function. Available to: Operator.

Description

Lists the ADMIN ACCOUNTS of the adm application - wad_admins, the table every caller authenticates against. READ-ONLY, and both reasons are recorded: the legacy's editable set is password (credential-class, held on console's write-only-field ruling with pas.secret and three others) and groups (a PRIVILEGE GRANT read straight into the session). Its row lock is privilege separation rather than tidiness - "rootadmin = false" is what stops an operator admin reaching the platform's super-root accounts, carried in Extra and failed on by check-row-restrictions.sh if it is ever dropped. Delete is off too and deliberately not shipped alone: a screen that removes an admin but cannot create or edit one is worse than no screen. Paginated. Sorting and searching are restricted to the declared fields; anything else is rejected and named. Read audience is provisional pending operator confirmation.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=opus:list

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

None beyond the API key and func=opus:list.

Example

https://host:port/newadm?func=opus:list

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: {"ok":true,"data":{"rows":[{"login":s,"groups":s}],"page":n,"pagesize":n,"fields":[s],"available":[s],"order":s,"dir":s,"filterby":s?,"filter":s?}}.

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

Back to OperatorAPI