Accounts Commands
The accounts command group manages Accounts, the login credentials that partners and external clients use to exchange files with UDMG. Accounts are distinct from Users: Users are administrative identities that manage UDMG, while Accounts are the identities used for file transfer.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
accounts list | Returns all Accounts. | Any |
accounts get <name> | Retrieves the full definition of an Account identified by name. | Any |
accounts create | Creates an Account. |
|
accounts update <name> | Updates one or more properties of an existing Account. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged. |
|
accounts delete <name> | Permanently deletes an Account. |
|
accounts enable <name> | Enables an Account. |
|
accounts disable <name> | Disables an Account. |
|
accounts set-password <name> | Administratively sets the password for an Account. |
|
accounts reset-2fa <name> | Clears the two-factor authentication configuration for an Account, requiring re-enrollment on next login. |
|
accounts auth-unlock <name> | Clears active authentication blocks for an Account, allowing it to connect again after exceeding the failed-login attempt limit. |
|
accounts list-credentials <name> | Returns all Credentials assigned to an Account. | Any |
accounts allow-credential <account> <credential> | Grants a Credential to an Account. |
|
accounts revoke-credential <account> <credential> | Revokes a Credential from an Account. |
|
accounts list-pipelines <name> | Returns all Pipelines that the Account has access to. | Any |
accounts list-account-groups <name> | Returns all Account Groups that the Account belongs to. | Any |
accounts allow-account-group <account> <group> | Adds an Account to an Account Group. |
|
accounts revoke-account-group <account> <group> | Removes an Account from an Account Group. |
|
accounts get-quota <name> | Returns the quota policy configured for an Account. | Any |
accounts set-quota <name> | Creates or replaces the bytes-transferred quota policy for an Account. |
|
accounts delete-quota <name> | Removes the quota policy from an Account. |
|
accounts quota-history <name> | Returns paginated history of completed quota reset periods for an Account. | Any |
accounts quota-summary | Returns the quota utilization for every Account that has a quota policy configured. | Any |
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 Accounts.
Required role
- Any
Command line syntax
udmg-client [global options] accounts list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--enabled | Filter by enabled state. Accepted values: true, false. | No | (none) |
--auth-type | Filter by authentication type. Accepted values: standard, ldap, oauth2, openid, saml. | 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, 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 accounts list --enabled true --auth-type standard --page 1 --page-size 10 --order asc --order-by name
get
Description
Retrieves the full definition of an Account identified by name.
Required role
- Any
Command line syntax
udmg-client [global options] accounts get <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts get acme-corp
create
Description
Creates an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts create [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Account name. | Yes | N/A |
--username | Login username for the new Account. | Yes | N/A |
--password | Password for the new Account. | Yes | N/A |
--login-method | Authentication type. Accepted values: standard. | Yes | N/A |
--description | The description of the Account. | No | (none) |
--first-name | First name of the Account contact. | No | (none) |
--last-name | Last name of the Account contact. | No | (none) |
--email | Email address. | No | (none) |
--totp-required | Require TOTP two-factor authentication for this Account. | No | false |
--business-service | Business Service name to assign to the Account. | No | (none) |
--as2-id | AS2 ID for the Account. | 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 accounts create --name acme-corp --username acme --password Passw0rd! --login-method standard --description "Managed by the operations team" --first-name John --last-name Doe --email john.doe@example.com --totp-required false --business-service my-service --as2-id acme-as2
update
Description
Updates one or more properties of an existing Account. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts update <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Account name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | New name for the Account. | No | (none) |
--username | New login username for the Account. | No | (none) |
--login-method | Authentication type. Accepted values: standard, ldap. | No | (none) |
--description | The new description of the Account. | No | (none) |
--first-name | First name. | No | (none) |
--last-name | Last name. | No | (none) |
--email | Email address. | No | (none) |
--totp-required | Require TOTP two-factor authentication. | No | (none) |
--business-service | Business Service name. Replaces the current Business Service assignment. | No | (none) |
--as2-id | AS2 ID for the Account. | 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 accounts update acme-corp --name acme-corp-updated --username acme --login-method standard --description "Managed by the operations team" --first-name John --last-name Doe --email john.doe@example.com --totp-required false --business-service my-service --as2-id acme-as2
delete
Description
Permanently deletes an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts delete <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts delete acme-corp
enable
Description
Enables an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
- Operator
Command line syntax
udmg-client [global options] accounts enable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts enable acme-corp
disable
Description
Disables an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
- Operator
Command line syntax
udmg-client [global options] accounts disable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts disable acme-corp
set-password
Description
Administratively sets the password for an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts set-password <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Account name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--password | New password for the Account. | 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 accounts set-password acme-corp --password NewPassw0rd!
reset-2fa
Description
Clears the two-factor authentication configuration for an Account, requiring re-enrollment on next login.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts reset-2fa <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts reset-2fa acme-corp
auth-unlock
Description
Clears active authentication blocks for an Account, allowing it to connect again after exceeding the failed-login attempt limit.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
- Operator
Command line syntax
udmg-client [global options] accounts auth-unlock <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts auth-unlock acme-corp
list-credentials
Description
Returns all Credentials assigned to an Account.
Required role
- Any
Command line syntax
udmg-client [global options] accounts list-credentials <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts list-credentials acme-corp
allow-credential
Description
Grants a Credential to an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts allow-credential <account> <credential>
Arguments
| Argument | Description |
|---|---|
<account> | Account name. |
<credential> | Credential 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 accounts allow-credential acme-corp sftp-key
revoke-credential
Description
Revokes a Credential from an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts revoke-credential <account> <credential>
Arguments
| Argument | Description |
|---|---|
<account> | Account name. |
<credential> | Credential 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 accounts revoke-credential acme-corp sftp-key
list-pipelines
Description
Returns all Pipelines that the Account has access to.
Required role
- Any
Command line syntax
udmg-client [global options] accounts list-pipelines <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts list-pipelines acme-corp
list-account-groups
Description
Returns all Account Groups that the Account belongs to.
Required role
- Any
Command line syntax
udmg-client [global options] accounts list-account-groups <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts list-account-groups acme-corp
allow-account-group
Description
Adds an Account to an Account Group.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts allow-account-group <account> <group>
Arguments
| Argument | Description |
|---|---|
<account> | Account name. |
<group> | Account Group 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 accounts allow-account-group acme-corp partners
revoke-account-group
Description
Removes an Account from an Account Group.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts revoke-account-group <account> <group>
Arguments
| Argument | Description |
|---|---|
<account> | Account name. |
<group> | Account Group 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 accounts revoke-account-group acme-corp partners
get-quota
Description
Returns the quota policy configured for an Account.
Required role
- Any
Command line syntax
udmg-client [global options] accounts get-quota <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts get-quota acme-corp
set-quota
Description
Creates or replaces the bytes-transferred quota policy for an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts set-quota <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Account name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--quota-size | Maximum bytes allowed per reset period. Must be greater than 0. | Yes | N/A |
--quota-direction | Transfer direction to count against the quota. Accepted values: read, write, both. | Yes | N/A |
--reset-period | Interval at which the quota counter resets. Accepted values: daily, weekly, monthly, quarterly, yearly. | Yes | N/A |
--enabled | Enables quota enforcement. Boolean switch — include to enable. | No | false |
--subtract-deletes | Subtract bytes freed by file deletions from the quota counter. Boolean switch — include to enable. | 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 accounts set-quota acme-corp --quota-size 1073741824 --quota-direction read --reset-period daily --enabled
delete-quota
Description
Removes the quota policy from an Account.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] accounts delete-quota <name>
Arguments
| Argument | Description |
|---|---|
<name> | Account 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 accounts delete-quota acme-corp
quota-history
Description
Returns paginated history of completed quota reset periods for an Account.
Required role
- Any
Command line syntax
udmg-client [global options] accounts quota-history <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Account name. |
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. Accepted values: periodStart, quotaSize. | 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 accounts quota-history acme-corp --page 1 --page-size 10 --order asc --order-by periodStart
quota-summary
Description
Returns the quota utilization for every Account that has a quota policy configured.
Required role
- Any
Command line syntax
udmg-client [global options] accounts quota-summary
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 accounts quota-summary