Sends one invitation per address given, as overlane team invite does, then marks the onboarding invite step done. Without an address it finishes the step and sends nothing. When email delivery is not configured the accept link is printed once for you to pass on.
Usage
overlane onboarding invite [email] [--role admin|member|viewer] [--dry-run]Arguments
| Argument | Required | Description |
|---|---|---|
email |
no | One or more email addresses |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--role |
one of admin, member, viewer |
no | member |
The role the invitations grant |
--dry-run |
boolean | no | Print the requests and file changes this command would make, then stop. Needs no credentials. |
Examples
overlane onboarding invite pat@example.com lee@example.com
overlane onboarding invite --role viewer pat@example.com
overlane onboarding inviteBehavior
- 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 onboarding 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": {
"invited": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"role": {
"type": "string"
},
"delivery": {
"type": "string",
"enum": [
"email",
"link"
]
},
"acceptUrl": {
"type": "string"
}
},
"required": [
"email",
"role",
"delivery"
],
"additionalProperties": false
}
},
"step": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"invited",
"step",
"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.