Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@axway/axway-cli-oum

appcelerator9kApache-2.03.0.3

Axway Amplify platform organization and user management CLI

axway, amplify

readme

Axway Amplify OUM CLI

Manage organizations, teams, and users.

Installation

This package is bundled with the Axway CLI and thus does not need to be directly installed.

npm i -g axway

Usage

Organizations

List all organizations:

$ axway org list

View an organization:

$ axway org view

$ axway org view <org>

Rename an organization:

$ axway org rename <org> <name>

Organization Users

List all organization users:

$ axway org user list <org>

Add a user to an org:

$ axway org user add <org> <guid|email> --role <role1> [...--role <role2>]

Update a user's roles:

$ axway org user update <org> <guid|email> --role <role1> [...--role <role2>]

Delete a user:

$ axway org user remove <org> <guid|email>

Organization Teams

List all organization teams:

$ axway team list [org]

View a team's info:

$ axway team view <org> <team>

Add a team to an org:

$ axway team add <org> <name> --desc [value] --tag [tag1] --tag [tag2] --default

Update a team:

$ axway team update # shows help

$ axway team update <org> <team> # shows help

$ axway team update <org> <team> --name [value] --desc [value] --tag [tag1] --tag [tag2] --default

Remove a team from an org:

$ axway team remove <org> <team>

Organization Team Users

List all users in a team:

$ axway team user list <org> <team>

Add a user to a team:

$ axway team user add <org> <team> <guid|email> --role <role1> [...--role <role2>]

Update a user's role within a team:

$ axway team user update <org> <team> <guid|email> --role <role1> [...--role <role2>]

Remove a user from a team:

$ axway team user remove <org> <team> <guid|email>

Organization Usage

View the usage:

$ axway org usage <org> --from [yyyy-mm-dd] --to [yyyy-mm-dd]

Organization Activity

View the organization activity:

$ axway org activity <org> --from [yyyy-mm-dd] --to [yyyy-mm-dd]

Organization IdP

Manage the organization identity provider settings:

$ axway org idp <org>

Account Management

View an account including organizations and roles:

$ axway user view

Update your account information:

$ axway user update --first-name <name> --last-name <name>

View your user activity:

$ axway user activity --from [yyyy-mm-dd] --to [yyyy-mm-dd]

Change your log in credentials:

$ axway user credentials

This project is open source under the Apache Public License v2 and is developed by Axway, Inc and the community. Please read the LICENSE file included in this distribution for more information.

changelog

v3.0.3 (June 26, 2025)

v3.0.2 (May 16, 2025)

  • BREAKING CHANGE: Node.js version upgrade to 20.18.2 (minimum) and conversion to ES Modules. (APIGOV-27923)

v3.0.1 (May 16, 2025)

  • BREAKING CHANGE: Node.js version upgrade to 20.18.2 (minimum) and conversion to ES Modules. (APIGOV-27923)

v3.0.0 (May 16, 2025)

  • BREAKING CHANGE: Node.js version upgrade to 20.18.2 (minimum) and conversion to ES Modules. (APIGOV-27923)

v2.0.20 (Jan 16, 2025)

  • chore: Updated dependencies.

v2.0.19 (Nov 21, 2024)

  • chore: Updated dependencies.

v2.0.18 (July 3, 2024)

  • chore: Updated dependencies.

v2.0.17 (May 31, 2024)

  • chore: Updated dependencies.

v2.0.16 (Jan 23, 2024)

  • chore: Updated dependencies.

v2.0.15 (Nov 8, 2023)

  • chore: Updated dependencies.

v2.0.14 (Nov 8, 2023)

  • chore: Updated dependencies.

v2.0.13 (Nov 8, 2023)

  • chore: Updated dependencies.

v2.0.12 (Nov 8, 2023)

  • chore: Updated dependencies.

v2.0.11 (Jul 7, 2022)

  • chore: Updated dependencies.

v2.0.10 (Jun 30, 2022)

  • chore: Updated dependencies.

v2.0.9 (May 11, 2022)

  • chore: Updated dependencies.

v2.0.8 (Mar 28, 2022)

  • chore: Updated dependencies.

v2.0.7 (Feb 16, 2022)

  • chore: Updated dependencies.

v2.0.6 (Feb 2, 2022)

  • chore: Updated dependencies.

v2.0.5 (Jan 14, 2022)

  • fix: Added user "type" to org user list command to match team user list.
  • chore: Updated dependencies.

v2.0.4 (Dec 21, 2021)

  • chore: Updated dependencies.

v2.0.3 (Dec 2, 2021)

  • chore: Updated dependencies.

v2.0.2 (Nov 5, 2021)

  • chore: Updated dependencies.

v2.0.1 (Oct 18, 2021)

  • chore: Updated dependencies.

v2.0.0 (Sep 24, 2021)

  • BREAKING CHANGE: Require Node.js 12.13.0 LTS or newer. (APIGOV-19220)
  • refactor: Renamed axway team add command to axway team create and added add as an alias.
  • refactor: Removed bin from package.
  • refactor: Moved initPlatformAccount() to @axway/amplify-cli-utils.
  • refactor: Replaced appcd-* libraries with @axway/amplify-utils. (APIGOV-20264)
  • feat: Added support to activity and usage methods for selecting a date range by month. (APIGOV-19922)
  • fix(org:view): Always show teams section even if there are no teams.
  • fix: Properly validate account name and error when a service account is specified. (APIGOV-19678)
  • chore: Updated dependencies.

v1.2.0 (Jul 30, 2021)

  • feat(org:view): Show list of org teams.
  • fix(activity): Render activity changes correctly. (APIGOV-19215)
  • fix(org:usage): Support for package bundles and unlimited SaaS. (APIGOV-19513)
  • fix(util): Fixed typo in platform account assertion.
  • chore(org:view): Removed child organizations from org view.

v1.1.3 (May 11, 2021)

  • chore: Updated dependencies.

v1.1.2 (Apr 29, 2021)

  • doc: Improved help verbiage.
  • chore: Updated dependencies.

v1.1.1 (Apr 28, 2021)

  • chore: Updated dependencies.

v1.1.0 (Apr 27, 2021)

  • feat: Added roles command to org and team user management commands.
  • fix: Fallback to the selected org when the default org in the Axway CLI config is stale. (CLI-121)
  • chore: Updated dependencies.

v1.0.0 (Apr 21, 2021)

  • Initial release.
  • Org, team, and user management CLI. (CLI-108)