Skip to main content
Groups allow you to organize users and control access to resources within an organization.

​
Subcommands

  • list — List groups
  • get — Get group details
  • create — Create a new group
  • update — Update an existing group
  • delete — Delete a group

​
list

List groups in an organization. 
nscale groups list --org <org-id> [flags]

​
Flags

FlagDescription
--org stringOrganization ID
--jsonOutput in JSON format

​
get

Get details for a specific group in JSON format. 
nscale groups get --id <group-id> --org <org-id>

​
Flags

FlagDescription
--id stringGroup ID
--org stringOrganization ID

​
create

Create a new group in the specified organization. Supports interactive mode or JSON input. 
nscale groups create --org <org-id> [flags]

​
Flags

FlagDescription
--org stringOrganization ID
-f, --file stringPath to a JSON file
--stdinRead JSON from standard input
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm creation

​
Examples

nscale groups create --org <org-id> --file group.json
nscale groups create --org <org-id> --stdin < group.json
# Interactive mode
nscale groups create

​
update

Update an existing group. 
nscale groups update --org <org-id> --id <group-id> [flags]

​
Flags

FlagDescription
--id stringGroup ID
--org stringOrganization ID
-f, --file stringPath to a JSON file
--stdinRead JSON from standard input
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm update

​
Examples

nscale groups update --org <org-id> --id <group-id> --file group.json
nscale groups update --org <org-id> --id <group-id> --stdin < group.json

​
delete

Delete an existing group. 
nscale groups delete --org <org-id> --id <group-id> [flags]

​
Flags

FlagDescription
--id stringGroup ID
--org stringOrganization ID
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm deletion