usergroup

usergroup create

usergroup create <GROUP_NAME> <GROUP_TYPE> [OPTIONS]

Create a user group.

Arguments

GROUP_NAME
Name of the group to create.
Type: text
Required: ✅

GROUP_TYPE
The type of user group to create.
Type: choice
Choices: LDAP, HTTP, OIDC
Required: ✅

Options

--ldap-group-dn <LDAP_GROUP_DN>
The DN of the LDAP group if group type is LDAP
Type: text

usergroup delete <GROUP_ID> [OPTIONS]

Delete a user group.

Arguments

GROUP_ID
ID of the user group to delete.
Type: integer
Required: ✅

Options

--force
Force deletion without confirmation.
Type: boolean (flag)
Default: False

usergroup get <GROUP_ID>

Get a user group.

Arguments

GROUP_ID
ID of the group to fetch.
Type: integer
Required: ✅

usergroup list [OPTIONS]

List user groups.

Options

--ldap-group-dn <LDAP_GROUP_DN>
LDAP group DN to filter by.
Type: text

--group-name <GROUP_NAME>
Group name to filter by (fuzzy matching).
Type: text

--page <PAGE>
(Advanced) Page to begin fetching from.
Type: integer
Default: 1

--page-size <PAGE_SIZE>
(Advanced) Results to fetch per API call.
Type: integer
Default: 10

--limit <LIMIT>
Maximum number of results to fetch.
Type: integer

usergroup search <GROUP_NAME> [OPTIONS]

Search for user groups by name.

Arguments

GROUP_NAME
Name of group to search for.
Type: text
Required: ✅

Options

--page <PAGE>
(Advanced) Page to begin fetching from.
Type: integer
Default: 1

--page-size <PAGE_SIZE>
(Advanced) Results to fetch per API call.
Type: integer
Default: 10

usergroup update <GROUP_ID> --name <GROUP_NAME>

Update a user group. Only the name can be updated currently.

Arguments

GROUP_ID
ID of the user group to update.
Type: integer
Required: ✅

Options

--name <GROUP_NAME>
New name for the user group.
Type: text
Required: ✅