Skip to Content
Referenceoo CLI

oo people

People in this Sunport, their sign-ins, chat accounts and limits.

People in this Sunport, their sign-ins, chat accounts and limits. These commands call the /api/v1/people routes; oo api routes --path /api/v1/people shows their inputs and permissions.

An administrator also invites people, changes a person's name or contact email, manages their sign-in (its role, whether it signs in, a new sign-in link, which person it belongs to, deleting it), their pending invitation, their chat accounts and their limits, as Users and a person's page do, decides who asked an agent's bot for access (requests), and removes someone from the Sunport altogether (remove). Nobody changes their own sign-in that way (self_change): their own password is oo profile password. The Sunport owner's sign-in, and their invitation while it waits, are the owner's alone (owner_login_protected): it can only be made an administrator again or turned back on, and a new owner is set in the OpenOrange app. Teams are oo teams; their API permissions are oo permissions. Clem makes these changes for the administrator who asks; one that waits for their click, such as making someone an administrator, answers approval_required and exits with code 3 (oo clem waiting).

oo people list

List people

oo people list [options]
ArgumentRequiredDefaultChoicesDescription
--query NAME=VALUEno

It also takes the connection options.

oo people get

Show one by ID

oo people get [options] id
ArgumentRequiredDefaultChoicesDescription
idyesID from oo people list
--output OUTPUTnowrite response to a protected file (required for a new credential)
--overwriteno

It also takes the connection options.

oo people invite

Invite someone by email, as Users > Invite does: they get an email with a sign-up link, which works once and expires. A user can use the agents --agents names as soon as they sign up, at --level: chat (the default) sees an agent and chats with it; settings also does everything with it, as Chat and settings does. Each agent must be active. An admin uses every agent, so an admin invitation names none. --team puts them in a team when they register, so a user holds its permissions from their first sign-in (oo teams). --permission ACTION:RESOURCE gives a user an exact permission, and --deny-permission an exact deny, as oo permissions add does once they are here; with the agents' grants, at most 100. --apps lets a user sign in to hosted apps (oo apps list) besides those everyone signs in to. In an app that keeps its own accounts, such as Mattermost, their account is made now, and the invitation's email waits for it, to carry its address, login and temporary password: the invitation then prints delivery_status waiting. --language writes its email in English (en, the default), Russian (ru), Spanish (es), German (de) or Japanese (ja): Clem uses the language of the person who asked it, and sending it again keeps it. Inviting an address again replaces its pending invitation. Like every change to who signs in, it needs unrestricted credentials (an administrator's own key, or Clem in administrator mode), and the Sunport's mail set up. It calls POST /api/v1/dashboard-invites and prints the invitation as JSON, with its agents, team and permissions; never its link.

oo people invite [options] email
ArgumentRequiredDefaultChoicesDescription
emailyestheir email address, which they sign in with
--role ROLEnouseruser, adminuser (the default) or admin
--name NAMEnotheir name, if you know it; otherwise they enter it when they sign up
--agents ID,IDnothe agents a user can use, by ID from oo agents list, separated by commas
--level LEVELnochatchat, settingswhat they can do with those agents: chat (the default) or settings
--apps APP_ID,APP_IDnohosted apps a user may sign in to, by ID from oo apps list, separated by commas
--team TEAMnothe team they join when they register, by name or ID
--permission ACTION:RESOURCEnoan exact permission a user holds once they register; repeatable
--deny-permission ACTION:RESOURCEnoan exact deny a user holds once they register; repeatable
--language LANGUAGEnoen, ru, es, de, jathe language of the invitation's email: en (the default), ru, es, de or ja

It also takes the connection options.

oo people update

Change a person's name or contact email, as Edit profile on their page does. The contact email is where they are reached, not the address they sign in with; another person's contact email is refused (employee_email_conflict). Two people may have the same name: name a person by their ID, and where two match a name, ask which one, by email. oo teams join and leave change their team. It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls PATCH /api/v1/employees/PERSON_ID and prints the person.

oo people update [options] PERSON_ID
ArgumentRequiredDefaultChoicesDescription
PERSON_IDyesthe person's ID: employeeId in oo people list
--name NAMEnotheir name
--email EMAILnotheir contact email
--no-emailnoremove their contact email

It also takes the connection options.

oo people agents

Print the agents a person can use as JSON, as Agents on their page shows them: each with its level, where the access comes from (their own grants, their team's, or owning it), the grants that taking it away removes, and how their chat accounts stand on its messenger bots. oo permissions add and remove --user change it. It needs people.read on the person and calls GET /api/v1/people/PERSON_ID/agents.

oo people agents PERSON_ID
ArgumentRequiredDefaultChoicesDescription
PERSON_IDyesthe person's ID: employeeId in oo people list

It also takes the connection options.

oo people role

Make a login an administrator or a user, as Make admin and Make user on the person's page do. The last active administrator's login can't be made a user (last_active_admin), nor the Sunport owner's (owner_login_protected). It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls PUT /api/v1/dashboard-accounts/LOGIN_ID/role and prints the login.

oo people role [options] LOGIN_ID role
ArgumentRequiredDefaultChoicesDescription
LOGIN_IDyesthe login's ID: account.id in oo people list or oo people get PERSON_ID
roleyesadmin, useradmin or user
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people disable

Turn a login's sign-in off, as Disable sign-in on the person's page does: it can't sign in, and the person, their chats and their agents stay. The last active administrator's login can't be turned off (last_active_admin), nor the Sunport owner's (owner_login_protected). It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls PUT /api/v1/dashboard-accounts/LOGIN_ID/status and prints the login.

oo people disable [options] LOGIN_ID
ArgumentRequiredDefaultChoicesDescription
LOGIN_IDyesthe login's ID: account.id in oo people list or oo people get PERSON_ID
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people enable

Turn a disabled login's sign-in back on, as Enable sign-in on the person's page does. It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls PUT /api/v1/dashboard-accounts/LOGIN_ID/status and prints the login.

oo people enable LOGIN_ID
ArgumentRequiredDefaultChoicesDescription
LOGIN_IDyesthe login's ID: account.id in oo people list or oo people get PERSON_ID

It also takes the connection options.

Email a person's login a link to set a new password, as Send a new sign-in link on their page does. The link works once and expires; their password and passkeys keep working until they use it. Nobody sees the link, and this command doesn't print it. The login must be on (account_disabled) and the Sunport's mail set up (mail_unavailable), and it is never the Sunport owner's (owner_login_protected). It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls POST /api/v1/employees/PERSON_ID/password-reset and prints where it went and when it expires.

oo people sign-in-link PERSON_ID
ArgumentRequiredDefaultChoicesDescription
PERSON_IDyesthe person's ID: employeeId in oo people list

It also takes the connection options.

Move a login to another person, as Move sign-in to another person does, when it belongs to a different person record. Agent access, chats and usage follow the person record, not the login. The person must be active (invalid_employee), and the last active administrator's login stays theirs (last_active_admin), as the Sunport owner's does (owner_login_protected). It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls PUT /api/v1/dashboard-accounts/LOGIN_ID/employee and prints the login.

oo people relink LOGIN_ID PERSON_ID
ArgumentRequiredDefaultChoicesDescription
LOGIN_IDyesthe login's ID: account.id in oo people list or oo people get PERSON_ID
PERSON_IDyesthe person it moves to: employeeId in oo people list

It also takes the connection options.

oo people delete-login

Delete a login, as Delete account on the person's page does: it can't sign in anymore. Their person record, chats and usage history stay, so they can be invited again. The last active administrator's login can't be deleted (last_active_admin), nor the Sunport owner's (owner_login_protected), nor one that records still name, such as a pairing it approved (dashboard_account_in_use). It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls DELETE /api/v1/dashboard-accounts/LOGIN_ID.

oo people delete-login [options] LOGIN_ID
ArgumentRequiredDefaultChoicesDescription
LOGIN_IDyesthe login's ID: account.id in oo people list or oo people get PERSON_ID
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people remove

Remove a person from the Sunport, as Remove from Sunport on their page does. Their logins stop signing in, and their grants, sessions, CLI sign-ins and keys are revoked. Every chat account linked to them is unlinked and taken off every agent's allowlist and pairing approvals on Telegram, Mattermost and Slack, the entries someone added by hand included; an agent whose updates are held takes its allowlist change once the hold is released. The agents they own become yours and keep running, with their memory and settings; agents they connected from elsewhere are disconnected. Their person record stays, archived, with their chats and web usage; spend from their chat app accounts stays on an unnamed row. --preview prints what it would do, as the dialog lists it, and changes nothing; it needs access.manage on them. Nobody removes themselves (self_change), nor the Sunport's owner (owner_login_protected), whose owner is set in the OpenOrange app. Removing someone takes unrestricted credentials: an administrator's own key, or Clem in administrator mode, which then waits for the administrator's click. It calls GET (--preview) or POST /api/v1/people/PERSON_ID/removal and prints the JSON.

oo people remove [options] PERSON_ID
ArgumentRequiredDefaultChoicesDescription
PERSON_IDyesthe person's ID: employeeId in oo people list
--previewnoprint what removing them does, and change nothing
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people invites

Act on a pending invitation, as its row in Users does: send it again, send it to a corrected address, revoke it, or give its person chat access now. oo people invite makes one, and oo people list shows those that wait. It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. Sending needs the Sunport's mail set up (mail_unavailable). The Sunport owner's invitation, while it waits for them, is theirs alone (owner_login_protected). Each prints the invitation as JSON, never its link.

oo people invites [COMMAND]

It also takes the connection options.

oo people invites resend

Email the invitation again: it gets a new link, the old one stops working, and it expires later. It calls POST /api/v1/dashboard-invites/INVITE_ID/resend.

oo people invites resend INVITE_ID
ArgumentRequiredDefaultChoicesDescription
INVITE_IDyesthe invitation's ID: invite.id in oo people list

It also takes the connection options.

oo people invites email

Send the invitation to a corrected address: a new link goes there, and the old link stops working. The new invitation keeps the role, agents and person; its ID is new (replaced_invite_id names the old one). It calls PUT /api/v1/dashboard-invites/INVITE_ID/email.

oo people invites email INVITE_ID email
ArgumentRequiredDefaultChoicesDescription
INVITE_IDyesthe invitation's ID: invite.id in oo people list
emailyesthe corrected address

It also takes the connection options.

oo people invites revoke

Revoke the invitation: its link stops working. It calls POST /api/v1/dashboard-invites/INVITE_ID/revoke.

oo people invites revoke INVITE_ID
ArgumentRequiredDefaultChoicesDescription
INVITE_IDyesthe invitation's ID: invite.id in oo people list

It also takes the connection options.

oo people invites chat-access

Give the invitation's person, whose chat accounts are linked but who never registered, what registering would: a login without a password under the invitation's address, with its role, agents, team and permissions. Until then the agents give them no tools in chat (Read-only in chat in Users); their next message works with them, and they can open the dashboard later with an emailed code. The invitation is accepted. A person with no chat account linked gets it when they register (no_chat_accounts). It calls POST /api/v1/dashboard-invites/INVITE_ID/chat-access.

oo people invites chat-access [options] INVITE_ID
ArgumentRequiredDefaultChoicesDescription
INVITE_IDyesthe invitation's ID: invite.id in oo people list
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people chats

A person's Telegram, Mattermost and Slack accounts are links to that person: their limits apply to the accounts, the accounts' usage shows under them, and the bots of the agents they can use let them in. A person links their own with a code from oo profile link-code. These commands list the accounts the Sunport saw, and link one to a person or unlink it, as a person's Chats section and Link to a person do. Listing needs people.read on everyone; linking and unlinking change the person. It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode.

oo people chats [COMMAND]

It also takes the connection options.

oo people chats list

Print the chat accounts that wrote to an agent, are in the Mattermost directory or wait for a bot's approval, most recently seen first, as JSON: each with its user_id (APP:ID), handle, name, where it was seen and the person it is linked to (person), or null. --query filters them: q=TEXT (a handle, name, ID or person's name), platform=APP, linked=linked or unlinked, employee_id=PERSON_ID (one person's), match_employee_id=PERSON_ID (Mattermost members with that person's email first), admitted=true (only accounts an agent's bot lets in, seen_in approved, or that wrote to an agent) and limit=N; truncated says more matched. Whose each account is, an administrator decides: a chat app's name or email can be anyone's, so nothing here says. It calls GET /api/v1/chat-accounts.

oo people chats list [options]
ArgumentRequiredDefaultChoicesDescription
--query NAME=VALUEno

It also takes the connection options.

Link a chat account to a person, as Link to a person does: their limits and allowed models apply to it within a minute, its spend counts toward their limits, its past usage shows under them, and the bots of the agents they can use let it in. A Telegram ID is a number, not the @username; Mattermost's has 26 letters and digits; Slack's starts with U or W. An account another person holds is refused (identity_conflict): unlink it there first. To link an account to someone not here yet, invite them with their name (oo people invite EMAIL --name NAME) and link it to the employee_id the invitation prints. It calls POST /api/v1/employees/PERSON_ID/chat-accounts.

oo people chats link [options] PERSON_ID APP:ID
ArgumentRequiredDefaultChoicesDescription
PERSON_IDyesthe person's ID: employeeId in oo people list
APP:IDyesthe chat account as APP:ID, such as telegram:123456789: user_id in oo people chats list
--handle HANDLEnoits @handle, if you know it
--display-name NAMEnoits own display name, if you know it

It also takes the connection options.

Link several chat accounts at once, each to its own person, as Link approved accounts in Users does: such as the ones oo people chats list --query admitted=true lists, once you know whose each is. Each links as oo people chats link does; one that can't (identity_conflict, held by someone else) leaves the others linked, and the answer says what happened to each, in order. It calls POST /api/v1/chat-accounts/links.

oo people chats link-many APP:ID=PERSON_ID [APP:ID=PERSON_ID ...]
ArgumentRequiredDefaultChoicesDescription
APP:ID=PERSON_IDyesa chat account and its person's ID; repeat for more

It also takes the connection options.

oo people chats email-matches

The Mattermost members linked to nobody whose email their Mattermost server proves (from its sign-in service, verified there, or on a server that requires verifying emails) is the login or contact email of exactly one person here who has no Mattermost account yet: each with that person, never the email. As Users' Chat accounts linked to nobody offers them. The emails come from the Mattermost identity sync, which an administrator runs on the Sunport. It calls GET /api/v1/chat-accounts/email-matches.

oo people chats email-matches

It also takes the connection options.

Link Mattermost members, each to the person oo people chats email-matches showed with it, as Link them in Users does: only a pair that still matches links (match_changed when the email is someone else's now, no_email_match when it matches nobody). Each links as oo people chats link does, and nothing a bot lets the account do today is taken away. It calls POST /api/v1/chat-accounts/email-matches.

oo people chats link-by-email MATTERMOST_ID=PERSON_ID [MATTERMOST_ID=PERSON_ID ...]
ArgumentRequiredDefaultChoicesDescription
MATTERMOST_ID=PERSON_IDyesa Mattermost user ID and its person's ID from oo people chats email-matches; repeat for more

It also takes the connection options.

Unlink a chat account from a person: their limits stop applying to it within a minute, bots that let it in for them stop letting it in, and its usage shows on its own instead of under them. It calls DELETE /api/v1/employees/PERSON_ID/chat-accounts/APP/ID.

oo people chats unlink [options] PERSON_ID APP:ID
ArgumentRequiredDefaultChoicesDescription
PERSON_IDyesthe person's ID: employeeId in oo people list
APP:IDyesthe chat account as APP:ID, such as telegram:123456789: user_id in oo people chats list
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people moves

A /link code sent from an account that a person without a sign-in holds doesn't link it: it asks to move the account, and waits here for an administrator. Approving moves it, with its usage and limits, to the person whose code asked, while they still have an active sign-in (dashboard_account_required); a person without a sign-in left with no chat account, sign-in or invitation is retired. An account that a person with a sign-in holds is never moved this way (identity_conflict). Listing needs people.read on everyone; deciding changes the people. It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode.

oo people moves [COMMAND]

It also takes the connection options.

oo people moves list

Print the moves that wait as JSON: each with its id, the account, the person who holds it (from) and the person whose code asked for it (to). --query employee_id=PERSON_ID lists one person's. It calls GET /api/v1/chat-account-moves.

oo people moves list [options]
ArgumentRequiredDefaultChoicesDescription
--query NAME=VALUEno

It also takes the connection options.

oo people moves decide

Approve a move, which moves the account, or refuse it, which leaves it where it is. It calls POST /api/v1/chat-account-moves/MOVE_ID/decision.

oo people moves decide [options] MOVE_ID
ArgumentRequiredDefaultChoicesDescription
MOVE_IDyesthe move's ID: id in oo people moves list
--decision DECISIONyesapprove, refuse

It also takes the connection options.

oo people requests

Someone the Sunport doesn't know who writes to an agent's bot gets one private link from it to ask for access. What they send waits here 14 days for an administrator: their name and email, confirmed with an emailed code or by their sign-in, or not; the chat account they wrote from, as its app named it; and the agent. Nobody becomes a person before it is approved. Approving makes the person, or takes the one the request names (whose chat account it is, who signed in, or whose confirmed email it is), gives them a login without a password when they have none, the agents (the one they wrote to without --agent) or the administrator role, and links the chat account: chat works without signing in. An email nobody confirmed that is someone's here links to them only with --person (email_not_confirmed). Declining lets nobody in, and that account can't ask for that agent again for 14 days. It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode.

oo people requests [COMMAND]

It also takes the connection options.

oo people requests list

Print the requests that wait as JSON, newest first: each with its id, the agent, the chat account, the name and email sent, whether the email was confirmed, and the person it names (person, with via: chat_account, sign_in or email). --all adds the ones decided or expired lately. It calls GET /api/v1/access-requests.

oo people requests list [options]
ArgumentRequiredDefaultChoicesDescription
--allnoalso the requests decided or expired lately

It also takes the connection options.

oo people requests approve

Let them in, as a user with the agents given or as an administrator, who uses every agent. It calls POST /api/v1/access-requests/REQUEST_ID/approve and prints the request, the person, the login and the agents.

oo people requests approve [options] REQUEST_ID
ArgumentRequiredDefaultChoicesDescription
REQUEST_IDyesthe request's ID: id in oo people requests list
--adminnomake them a Sunport administrator
--agent AGENT[:settings]noan agent a user gets, at chat, or with :settings also everything done with it; the agent they wrote to without any
--emailnoemail them that they're in, with where they sign in
--person PERSON_IDnothe person whose unconfirmed email the request names: your word that the account is theirs
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people requests decline

Decline the request: nobody is let in, and that chat account can't ask for that agent again for 14 days. It calls POST /api/v1/access-requests/REQUEST_ID/decline.

oo people requests decline REQUEST_ID
ArgumentRequiredDefaultChoicesDescription
REQUEST_IDyesthe request's ID: id in oo people requests list

It also takes the connection options.

oo people chat-access

Give a chat-only person what an access request's approval would, as Give chat access in Users does: someone whose chat account is linked to a person with no sign-in and no invitation (--person), or linked to nobody (--account, with --name for the person it makes). Until then the agents give them no tools in chat. They get a login without a password under --email (or the person's contact email), the agents given (the ones their account wrote to lately without --agent) or the administrator role with --admin, and the account linked. Their next message works with the agents, and they can open the dashboard later with an emailed code. An address nobody confirmed goes only as the person it vouches for, named with --person: one that is someone else's here, or a new one for a person with no sign-in (email_not_confirmed). A person with an invitation takes oo people invites chat-access (invite_pending). It asks first. It needs unrestricted credentials: an administrator's own key, or Clem in administrator mode. It calls POST /api/v1/chat-access.

oo people chat-access [options]
ArgumentRequiredDefaultChoicesDescription
--person PERSON_IDnothe person: the chat account's, or the one whose email an unconfirmed address is
--account APP:IDnothe chat account as APP:ID, such as telegram:123456789: user_id in oo people chats list
--name NAMEnothe name of the person it makes, for an account linked to nobody
--email EMAILnothe address they sign in with; without, the person's contact email
--adminnomake them a Sunport administrator
--agent AGENT[:settings]noan agent a user gets, at chat, or with :settings also everything done with it; the agents their account wrote to lately without any
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo people limits

A person's limits, as Limits on their page shows and changes them: spending caps on their model requests per day, week and month in US dollars, caps for single models, the models they may use, and whether their requests are blocked. They cover every account of theirs, whichever names them. Reading needs billing.read; changing them needs billing.write and is an administrator's, as on their page (admin_required). A chat account no person holds has none (chat_account_not_linked): link it first (oo people chats link).

oo people limits [COMMAND]

It also takes the connection options.

oo people limits get

Print the person's limits and who they are as JSON, or limits null when they have none. model_budgets_usd holds the caps for single models, and model_spends what each of those models has cost them in the same periods. It calls GET /api/v1/user-limits/ACCOUNT.

oo people limits get ACCOUNT
ArgumentRequiredDefaultChoicesDescription
ACCOUNTyesone of the person's accounts, from usageIds in oo people get PERSON_ID: a chat account such as telegram:123456789, or webchat:LOGIN_ID for their sign-in

It also takes the connection options.

oo people limits set

Change what you give and keep the rest, as saving the Limits card does: --daily, --weekly and --monthly set a cap in US dollars, or none removes it; requests stop once the spend in that period reaches it, and the month is the calendar month in UTC. --models allows only those models; --all-models allows every model, including ones added later. --model-cap caps one model by itself, inside their overall caps: requests to that model stop once what it has cost them in that period reaches the cap, and their other models keep working; none removes the cap, and it can be given more than once. A model with a cap has to be one they may use (model_budget_not_allowed). --clear-model-caps removes every model cap. --block stops all their model requests, whatever the caps; --unblock allows them again. It takes effect within 30 seconds. It calls PUT /api/v1/user-limits/ACCOUNT, after reading the current caps when you change one, and prints the limits.

oo people limits set [options] ACCOUNT
ArgumentRequiredDefaultChoicesDescription
--daily USDnothe daily cap in US dollars, or none
--weekly USDnothe weekly cap in US dollars, or none
--monthly USDnothe monthly cap in US dollars, or none
--model-cap MODEL PERIOD USDnoa cap for one model: its period (daily, weekly or monthly) and US dollars, or none; can be given more than once
--clear-model-capsnoremove every model cap
--models MODEL,MODELnoallow only these models, separated by commas
--all-modelsnoallow every model
--blocknostop all their model requests
--unblocknoallow their model requests again
ACCOUNTyesone of the person's accounts, from usageIds in oo people get PERSON_ID: a chat account such as telegram:123456789, or webchat:LOGIN_ID for their sign-in

It also takes the connection options.

oo people limits clear

Remove all of the person's limits, as Clear all limits does. It calls DELETE /api/v1/user-limits/ACCOUNT.

oo people limits clear ACCOUNT
ArgumentRequiredDefaultChoicesDescription
ACCOUNTyesone of the person's accounts, from usageIds in oo people get PERSON_ID: a chat account such as telegram:123456789, or webchat:LOGIN_ID for their sign-in

It also takes the connection options.

On this page