Users are the individual accounts with access to an organization. Membership starts with an invitation, and what a user can do is determined by the groups they belong to.
Subcommands
list
List users in an organization, along with their state and the number of groups each belongs to.
Aliases: list, ls
Flags
| Flag | Description |
|---|
—org string | Organization ID |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq filter for value extraction (see Query output with -q) |
Example
invite
Invite a user into an organization. A user is identified by their canonical name, which is usually an email address.
Whether groups are accepted depends on how the organization authenticates its members:
- Private organizations — members are added explicitly, so at least one group is required. Omit
--group and the CLI presents a group picker.
- Public organizations — members sign in with an email address on the organization’s domain, and group membership is managed separately, so
--group is rejected.
To check which kind an organization is, read its type — adhoc for private, domain for public:
Use nscale groups list to discover the group IDs. For how groups and roles fit together, see Groups and roles.
--state sets the state of the user’s membership of this organization, which is what governs their access to it:
pending (the default) matches the Console flow — the member is listed as Pending and has no access until they join.active skips that step, so the membership is usable as soon as the person can sign in.suspended creates the membership with access already revoked.
--state active does not bypass account sign-up. If the person has no Nscale account yet, they must still complete the verification email before they can authenticate; the flag only decides whether their membership of this organization is waiting on them to join.
Flags
| Flag | Description |
|---|
—org string | Organization ID |
—email string | The user’s canonical name, usually an email address |
—group stringArray | Group ID to add the user to (repeatable) |
—state string | Membership state — active, pending, or suspended (default pending) |
—dry-run | Preview the request payload without persisting |
-y, —yes | Automatically confirm the invitation |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq filter for value extraction (see Query output with -q) |
Examples
delete
Delete an existing user from an organization.
Flags
