Profile Commands
The profile command group views and manages the currently authenticated User's profile, tokens, and password.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
profile get | Retrieves the profile of the currently authenticated User. | Any |
profile get-scopes | Returns the permission scopes assigned to the currently authenticated User. | Any |
profile list-tokens | Returns all API tokens belonging to the currently authenticated User. | Any |
profile create-token | Creates a Personal Access Token for the currently authenticated User. The token value is returned only at creation — it cannot be retrieved afterwards. | Any |
profile delete-token <token> | Permanently deletes a Personal Access Token belonging to the currently authenticated User. | Any |
profile set-password | Changes the password of the currently authenticated User. | 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
get
Description
Retrieves the profile of the currently authenticated User.
Required role
- Any
Command line syntax
udmg-client [global options] profile get
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 profile get
get-scopes
Description
Returns the permission scopes assigned to the currently authenticated User.
Required role
- Any
Command line syntax
udmg-client [global options] profile get-scopes
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 profile get-scopes
list-tokens
Description
Returns all API tokens belonging to the currently authenticated User.
Required role
- Any
Command line syntax
udmg-client [global options] profile list-tokens [command-specific options]
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 profile list-tokens --page 1 --page-size 10 --order asc --order-by createdAt
create-token
Description
Creates a Personal Access Token for the currently authenticated User. The token value is returned only at creation — it cannot be retrieved afterwards.
Required role
- Any
Command line syntax
udmg-client [global options] profile create-token [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Name for the new token. | Yes | N/A |
--description | Description for the token. | 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 profile create-token --name ci-token --expires-at 2027-12-31
delete-token
Description
Permanently deletes a Personal Access Token belonging to the currently authenticated User.
Required role
- Any
Command line syntax
udmg-client [global options] profile delete-token <token>
Arguments
| Argument | Description |
|---|---|
<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 profile delete-token ci-token
set-password
Description
Changes the password of the currently authenticated User.
Required role
- Any
Command line syntax
udmg-client [global options] profile set-password [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--current-password | Current password. | Yes | N/A |
--new-password | New password. | 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 profile set-password --current-password oldpass --new-password newpass