Users Commands
The users command group manages Users — administrative individuals who sign in to the UDMG Admin UI or UDMG REST API to configure and manage UDMG. Users are distinct from Accounts: Users are administrative identities, while Accounts are the credentials that partners and external clients use for file transfer.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
users list | Returns all Users. | Any |
users get <name> | Retrieves the full definition of a User identified by username. | Any |
users create | Creates a User. |
|
users update <name> | Updates one or more properties of an existing User. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged. |
|
users delete <name> | Permanently deletes a User. |
|
users enable <name> | Enables a User. |
|
users disable <name> | Disables a User. |
|
users set-password <name> | Administratively sets the password for a User without requiring the User's current password. |
|
users reset-2fa <name> | Clears the two-factor authentication configuration for a User, requiring them to re-enroll on next login. |
|
users auth-unlock <name> | Clears active authentication blocks for a User, allowing them to log in again after exceeding the failed-login attempt limit. |
|
users get-roles <name> | Returns all Roles and their permissions assigned to a User. | Any |
users list-tokens <name> | Returns all API tokens belonging to a User. | Any |
users create-token <name> | Creates a new API token for a User. |
|
users delete-token <name> <token> | Permanently deletes an API token from a User. |
|
Authentication
Every udmg-client command authenticates to the UDMG Server using a UDMG username and password. Supply them with the --auth-username and --auth-password flags, or set the UDMG_CLI_AUTH_USERNAME and UDMG_CLI_AUTH_PASSWORD environment variables. For details and examples, see Authentication.
Commands Reference
list
Description
Returns all Users.
Required role
- Any
Command line syntax
udmg-client [global options] users list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--enabled | Filter by enabled state. Accepted values: true, false. | No | (none) |
--login-type | Filter by login type. Accepted values: standard, ldap, oidc, oauth, openid, saml. | No | (none) |
--role | Filter by Role. Accepted values: admin, operator, pipeline, readonly, system. | No | (none) |
--page | Page number. | No | (none) |
--page-size | Number of items per page. | No | (none) |
--order | Sort direction. Accepted values: asc, desc. | No | (none) |
--order-by | Field to sort results by. Accepted values: name, role, enabled, createdAt, updatedAt. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users list --enabled true --login-type standard --role admin --page 1 --page-size 10 --order asc --order-by name
get
Description
Retrieves the full definition of a User identified by username.
Required role
- Any
Command line syntax
udmg-client [global options] users get <name>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users get john.doe
create
Description
Creates a User.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users create [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--username | Username for the new User. | Yes | N/A |
--password | Password for the new User. | Yes | N/A |
--first-name | First name. | Yes | N/A |
--login-method | Login type. Accepted values: standard. | Yes | N/A |
--role | Role assigned to the User. Accepted values: admin, operator, pipeline, readonly, system. | Yes | N/A |
--last-name | Last name. | No | (none) |
--email | Email address. | No | (none) |
--description | The description of the User. | No | (none) |
--business-services | Comma-separated list of Business Service names to assign to the User. | No | (none) |
--totp-required | Require TOTP two-factor authentication for this User. | No | false |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users create --username john.doe --password Passw0rd! --first-name John --login-method standard --role admin --last-name Doe --email john.doe@example.com --description "Operations team member" --business-services my-service --totp-required false
update
Description
Updates one or more properties of an existing User. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users update <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--username | New username (renames the User). | No | (none) |
--first-name | First name. | No | (none) |
--last-name | Last name. | No | (none) |
--email | Email address. | No | (none) |
--role | New Role assigned to the User. Accepted values: admin, operator, pipeline, readonly, system. | No | (none) |
--login-method | Login type. Accepted values: ldap, oidc, oauth, openid, saml, standard. | No | (none) |
--description | The new description of the User. | No | (none) |
--business-services | Comma-separated list of Business Service names. Replaces all current Business Service assignments. | No | (none) |
--totp-required | Require TOTP two-factor authentication. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users update john.doe --username john.doe --first-name John --last-name Doe --email john.doe@example.com --role admin --login-method standard --description "Operations team member" --business-services my-service --totp-required false
delete
Description
Permanently deletes a User.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users delete <name>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users delete john.doe
enable
Description
Enables a User.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users enable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users enable john.doe
disable
Description
Disables a User.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users disable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users disable john.doe
set-password
Description
Administratively sets the password for a User without requiring the User's current password.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users set-password <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--password | New password for the User. | Yes | N/A |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users set-password john.doe --password NewPassw0rd!
reset-2fa
Description
Clears the two-factor authentication configuration for a User, requiring them to re-enroll on next login.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users reset-2fa <name>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users reset-2fa john.doe
auth-unlock
This command clears the authentication-locked state set automatically by the failed-login threshold. It does not clear the administrative locked state set by the user-lock command on the udmg-server CLI; for that, use user-unlock.
Description
Clears active authentication blocks for a User, allowing them to log in again after exceeding the failed-login attempt limit.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users auth-unlock <name>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users auth-unlock john.doe
get-roles
Description
Returns all Roles and their permissions assigned to a User.
Required role
- Any
Command line syntax
udmg-client [global options] users get-roles <name>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users get-roles john.doe
list-tokens
Description
Returns all API tokens belonging to a User.
Required role
- Any
Command line syntax
udmg-client [global options] users list-tokens <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--page | Page number. | No | (none) |
--page-size | Number of items per page. | No | (none) |
--order | Sort direction. Accepted values: asc, desc. | No | (none) |
--order-by | Field to sort results by. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users list-tokens john.doe --page 1 --page-size 10 --order asc --order-by createdAt
create-token
Description
Creates a new API token for a User.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users create-token <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Name for the new token. | Yes | N/A |
--description | The description of the User. | No | (none) |
--expires-at | Expiration date for the token, in YYYY-MM-DD format. If omitted, the token does not expire. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users create-token john.doe --name ci-token --description "Operations team member" --expires-at 2027-12-31
delete-token
Description
Permanently deletes an API token from a User.
Required role
- System Administrator
- Domain Administrator
Command line syntax
udmg-client [global options] users delete-token <name> <token>
Arguments
| Argument | Description |
|---|---|
<name> | Username. |
<token> | Token name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client users delete-token john.doe ci-token