overlane team invite | Overlane Docs

Creates a single-use invitation bound to one email address that expires in 7 days. The service emails the invitation when email delivery is configured. Otherwise it returns the one-time secret and accept link once, to you; pass it on yourself. The invitee accepts it while signed in with that verified email. An agent with a team token can invite (policy change class).

Usage

overlane team invite email [--service URL] [--team TENANT_ID] [--role admin|member|viewer] [--dry-run]

Arguments

Argument	Required	Description
`email`	yes	The email address to invite

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no		The team (tenant) to act on (default: the one your token belongs to)
`--role`	one of `admin`, `member`, `viewer`	no	`member`	The role the invitation grants
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane team invite pat@example.com
overlane team invite pat@example.com --role viewer --dry-run

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema team invite.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "invitationId": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "role": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string"
        },
        "delivery": {
          "type": "string",
          "enum": [
            "email",
            "link"
          ]
        },
        "secret": {
          "type": "string"
        },
        "acceptUrl": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "invitationId",
        "email",
        "role",
        "expiresAt",
        "delivery",
        "next"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.