oo permissions
API permissions of users, agents, services and teams.
See, add and remove the API permissions of a user, an agent, a service or a team, in the dashboard's choices, by area or as exact permissions. A deny wins over any allow. A team's permissions are held by each person in it who is not an administrator, while in it (oo teams).
These permissions add to the built-in role and agent access. --access view, chat or all with --agents is the dashboard's choice. AREA:view or AREA:manage is an area as the dashboard's editor shows it: view sees the area, manage also changes it; a deny of view stops both, a deny of manage only changing. With --agents, an area's actions on agents are on those agents. --permission ACTION:RESOURCE names one exact permission. oo permissions list shows each area so, or as custom with its exact permissions. --access all is the whole API, or with --agents chat plus what is done with those agents (their settings, model and jobs) and nothing else. You can pass on only access you hold yourself. An allow that a role check makes useless for its holder, such as requests.content for anyone who is not an administrator, is still added, with a note saying so.
--permission sunport.observe:* on an agent connected from elsewhere: let this agent read the Sunport's health: services, servers, updates and error counts. No messages, keys, people or spend (oo sunport health). It has none until an administrator gives it, and only an administrator may.
People change permissions. The one agent that may is Clem, for the person who asked it: it changes them as that person, with their own permissions, and some changes wait for an administrator's click.
oo permissions list
Explicit permissions; yours by default
oo permissions list [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--user NAME | no | a person with a login: their name, sign-in email, account ID or person ID (oo people list) | ||
--agent NAME | no | an agent's name or ID | ||
--service NAME | no | an enrolled machine's name or ID | ||
--team NAME | no | a team's name or ID: everyone in it who is not an administrator holds them | ||
--json | no | print the API's JSON |
It also takes the connection options.
oo permissions add
Allow or deny a choice or exact permissions
oo permissions add [options] [AREA:LEVEL ...]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--user NAME | no | a person with a login: their name, sign-in email, account ID or person ID (oo people list) | ||
--agent NAME | no | an agent's name or ID | ||
--service NAME | no | an enrolled machine's name or ID | ||
--team NAME | no | a team's name or ID: everyone in it who is not an administrator holds them | ||
AREA:LEVEL | no | areas to view or manage, written together, such as agents:manage billing:view | ||
--allow | no | allow (default) | ||
--deny | no | deny; a deny wins over any allow | ||
--access ACCESS | no | view, chat, all | view, chat or all | |
--agents A,B | no | agent IDs or names (default all agents) | ||
--permission ACTION:RESOURCE | no | an exact permission instead of --access and --agents; repeatable | ||
--json | no | print the API's JSON |
It also takes the connection options.
oo permissions remove
Remove permissions by ID
oo permissions remove [options] ID [ID ...]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
ID | yes | permission IDs from oo permissions list; commas also separate them | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--json | no | print the API's JSON |
It also takes the connection options.