Skip to main content

apiome teams

Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.

apiome teams​

Teams: who owns catalog entities and is notified about their findings.

apiome teams [OPTIONS] COMMAND [ARGS]...

Subcommands: assign, create, list, members, show.

apiome teams assign​

Make a team the confirmed owner of an entity (PUT …/owners/{kind}/{id}).

The previous confirmed owner, if any, is replaced; findings for the entity are routed to the new team. An unknown team or entity is refused with REST's message and exits 2; an unknown kind is a usage error (exit 2) caught before any call.

apiome teams assign [OPTIONS] KIND ENTITY_ID

Arguments

ArgumentTypeRequiredDescription
KINDtextyesEntity kind: project, catalog_item, mcp_endpoint, consumer, connector.
ENTITY_IDtextyesThe entity's id.

Options

OptionTypeDefaultRequiredDescription
--teamtextyesSlug of the team that will own it.
--formattexttableOutput: table (default) or json (the API response).

apiome teams create​

Create a team (POST …/teams). The slug cannot be changed afterwards.

A taken slug or a malformed field is refused by REST and exits 2.

apiome teams create [OPTIONS] NAME

Arguments

ArgumentTypeRequiredDescription
NAMEtextyesThe team's display name.

Options

OptionTypeDefaultRequiredDescription
--slugtextPermanent slug (default: derived from the name). Gateway tags owner:<slug> use it.
--descriptiontextWhat the team does.
--contact-emailtextThe team's contact address.
--chat-urltextChat channel link (absolute http(s) URL).
--oncall-urltextOn-call / paging link (absolute http(s) URL).
--docs-urltextTeam docs or runbook link (absolute http(s) URL).
--formattexttableOutput: table (default) or json (the API response).

apiome teams list​

List the workspace's teams with their member counts and owner links (GET …/teams).

apiome teams list [OPTIONS]

Options

OptionTypeDefaultRequiredDescription
--formattexttableOutput: table (default) or json (the API response).

apiome teams members​

List a team's members, or replace them (PUT …/teams/{slug}/members).

With no option the members are listed. --set sends the complete new membership — it does not add to the current one — and --clear empties the team. Every user must belong to the workspace, otherwise REST refuses the whole change (exit 2) and nothing changes.

apiome teams members [OPTIONS] SLUG

Arguments

ArgumentTypeRequiredDescription
SLUGtextyesTeam slug.

Options

OptionTypeDefaultRequiredDescription
--settext (repeatable)USER_ID[:lead|:member] (repeatable; default role member). Replaces the whole membership: anyone not listed is removed.
--clearflagRemove every member (cannot be combined with --set).
--formattexttableOutput: table (default) or json (the API response).

apiome teams show​

Show one team: its owner links and members, leads first (GET …/teams/{slug}).

apiome teams show [OPTIONS] SLUG

Arguments

ArgumentTypeRequiredDescription
SLUGtextyesTeam slug.

Options

OptionTypeDefaultRequiredDescription
--formattexttableOutput: table (default) or json (the API response).