Account Groups Commands

The account-groups command group manages Account Groups, collections of Accounts that share Pipeline access and permissions.

For command line syntax, see the UDMG Client CLI overview.

Commands Overview

Command	Description	Required Role
account-groups list	Returns all Account Groups.	Any
account-groups get <name>	Retrieves the full definition of an Account Group identified by name.	Any
account-groups create	Creates an Account Group.	System Administrator Domain Administrator Pipeline Management
account-groups update <name>	Updates one or more properties of an existing Account Group. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.	System Administrator Domain Administrator Pipeline Management
account-groups delete <name>	Permanently deletes an Account Group.	System Administrator Domain Administrator Pipeline Management
account-groups list-accounts <name>	Returns all Accounts that belong to an Account Group.	Any
account-groups allow-account <group> <account>	Grants an Account access to an Account Group.	System Administrator Domain Administrator Pipeline Management
account-groups revoke-account <group> <account>	Revokes an Account's access from an Account Group.	System Administrator Domain Administrator Pipeline Management
account-groups list-pipelines <name>	Returns all Pipelines that belong to an Account Group.	Any
account-groups allow-pipeline <group> <pipeline>	Grants an Account Group access to a Pipeline.	System Administrator Domain Administrator Pipeline Management
account-groups revoke-pipeline <group> <pipeline>	Revokes an Account Group's access to a Pipeline.	System Administrator Domain Administrator Pipeline Management

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 Account Groups.

Required role

• Any

Command line syntax

udmg-client [global options] account-groups list [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. Accepted values: name, 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 account-groups list --page 1 --page-size 10 --order asc --order-by name

get

Description

Retrieves the full definition of an Account Group identified by name.

Required role

• Any

Command line syntax

udmg-client [global options] account-groups get <name>

Arguments

Argument	Description
<name>	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 account-groups get partners

create

Description

Creates an Account Group.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] account-groups create [command-specific options]

Command-specific options

Option	Description	Required	Default
--name	Account Group name.	Yes	N/A
--description	The description of the Account Group.	No	(none)
--business-service	Business Service name to assign to the Account Group.	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 account-groups create --name partners --description "External partner accounts" --business-service my-service

update

Description

Updates one or more properties of an existing Account Group. 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] account-groups update <name> [command-specific options]

Arguments

Argument	Description
<name>	Account Group name.

Command-specific options

Option	Description	Required	Default
--name	New name for the Account Group.	No	(none)
--description	The new description of the Account Group.	No	(none)
--business-service	Business Service name.	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 account-groups update partners --name partners-updated --description "External partner accounts" --business-service my-service

delete

Description

Permanently deletes an Account Group.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] account-groups delete <name>

Arguments

Argument	Description
<name>	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 account-groups delete partners

list-accounts

Description

Returns all Accounts that belong to an Account Group.

Required role

• Any

Command line syntax

udmg-client [global options] account-groups list-accounts <name>

Arguments

Argument	Description
<name>	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 account-groups list-accounts partners

allow-account

Description

Grants an Account access to an Account Group.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] account-groups allow-account <group> <account>

Arguments

Argument	Description
<group>	Account Group name.
<account>	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 account-groups allow-account partners acme-corp

revoke-account

Description

Revokes an Account's access from an Account Group.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] account-groups revoke-account <group> <account>

Arguments

Argument	Description
<group>	Account Group name.
<account>	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 account-groups revoke-account partners acme-corp

list-pipelines

Description

Returns all Pipelines that belong to an Account Group.

Required role

• Any

Command line syntax

udmg-client [global options] account-groups list-pipelines <name>

Arguments

Argument	Description
<name>	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 account-groups list-pipelines partners

allow-pipeline

Description

Grants an Account Group access to a Pipeline.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] account-groups allow-pipeline <group> <pipeline>

Arguments

Argument	Description
<group>	Account Group name.
<pipeline>	Pipeline 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 account-groups allow-pipeline partners daily-upload

revoke-pipeline

Description

Revokes an Account Group's access to a Pipeline.

Required role

• System Administrator
• Domain Administrator
• Pipeline Management

Command line syntax

udmg-client [global options] account-groups revoke-pipeline <group> <pipeline>

Arguments

Argument	Description
<group>	Account Group name.
<pipeline>	Pipeline 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 account-groups revoke-pipeline partners daily-upload