osmo user#

usage: osmo user [-h] {list,create,update,delete,get} ...

Positional Arguments#

command#: Possible choices: list, create, update, delete, get

Sub-commands#

list#

List users with optional filtering.

osmo user list [-h] [--id-prefix ID_PREFIX] [--roles ROLES [ROLES ...]]
               [--count COUNT] [--format-type {json,text}]

Named Arguments#

--id-prefix, -p#

Filter users whose ID starts with this prefix.

--roles, -r#

Filter users who have ANY of these roles.

--count, -c#

Number of results per page (default: 100).

Default: 100

--format-type, -t#

Possible choices: json, text

Specify the output format type (Default text).

Default: 'text'

Ex. osmo user list Ex. osmo user list –id-prefix service- Ex. osmo user list –roles osmo-admin osmo-user

create#

Create a new user with optional roles.

osmo user create [-h] [--roles ROLES [ROLES ...]] [--format-type {json,text}]
                 user_id

Positional Arguments#

user_id#: User ID (e.g., email or username).

Named Arguments#

--roles, -r#

Initial roles to assign to the user.

--format-type, -t#

Possible choices: json, text

Specify the output format type (Default text).

Default: 'text'

Ex. osmo user create myuser@example.com Ex. osmo user create service-account –roles osmo-user osmo-ml-team

update#

Add or remove roles from a user.

osmo user update [-h] [--add-roles ADD_ROLES [ADD_ROLES ...]]
                 [--remove-roles REMOVE_ROLES [REMOVE_ROLES ...]]
                 [--format-type {json,text}]
                 user_id

Positional Arguments#

user_id#: User ID to update.

Named Arguments#

--add-roles, -a#

Roles to add to the user.

--remove-roles, -r#

Roles to remove from the user.

--format-type, -t#

Possible choices: json, text

Specify the output format type (Default text).

Default: 'text'

Ex. osmo user update myuser@example.com –add-roles osmo-admin Ex. osmo user update myuser@example.com –remove-roles osmo-ml-team Ex. osmo user update myuser@example.com –add-roles admin –remove-roles guest

delete#

Delete a user and all associated data (tokens, roles, profile).

osmo user delete [-h] [--force] user_id

Positional Arguments#

user_id#: User ID to delete.

Named Arguments#

--force, -f#

Skip confirmation prompt.

Default: False

Ex. osmo user delete myuser@example.com

get#

Get detailed information about a user including their roles.

osmo user get [-h] [--format-type {json,text}] user_id

Positional Arguments#

user_id#: User ID to get details for.

Named Arguments#

--format-type, -t#

Possible choices: json, text

Specify the output format type (Default text).

Default: 'text'

Ex. osmo user get myuser@example.com