enhancedocs
For agentsOpen Enhance ↗
CLI commands / enhance-dev organisation people add

Enhance documentation

enhance-dev organisation people add

Add an existing account by email; use organisation invites create when no account exists.

↓ Markdown

enhance-dev organisation people add

enhance-dev organisation people add [options]

Arguments

This command takes no positional arguments.

Options

OptionRequiredDefaultMeaning
--organisation-id <string>YesNoneTeam id, from enhance organisation list.
--email <string>YesNoneEmail address of the person to invite or add.
--role [string]NomemberTeam role to grant: admin or member.
--content-access [string]Nocan-commentTeam content access to grant independently of its administrative role: can-edit, can-comment, or can-view.
--json <json>NoNoneComplete procedure input as JSON; do not combine it with field flags.
--client-token <uuid>NoNoneStable UUID to reuse when retrying the exact same mutation.

Input

This command presents the capability organisation.people.add. It has write effect and single idempotency.

Show complete input JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"organisationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"role":{"default":"member","type":"string","enum":["admin","member"]},"contentAccess":{"default":"can-comment","type":"string","enum":["can-view","can-comment","can-edit"]}},"required":["organisationId","email"]}

Output

This command writes JSON records to standard output. Returns a typed organisation.people.add result from the Enhance API without transport-specific prose.

Show complete output JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["personId"],"additionalProperties":false}

Examples

enhance-dev organisation people add --organisation-id <string> --email <string>
Show example input
{
 "organisationId": "00000000-0000-4000-8000-000000000010",
 "email": "agent@example.test"
}
Show example output
{
 "personId": "00000000-0000-4000-8000-000000000010"
}

Exit behaviour

Exit codeMeaning
0The command succeeded.
1The command failed for another reason (INTERNAL). A write may have an unknown outcome.
2The command line was malformed. Nothing ran.
3The API refused the input (BAD_REQUEST).
4The credential is missing or expired (UNAUTHORIZED).
5The API refused the request (FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED).
6A batch finished only in part. Retry with the same --client-token.

Versions

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.