Skip to content

Application


title: “application” description: “application Command” lead: "" date: 2023-06-12T13:46:25-06:00 lastmod: 2023-06-12T13:46:25-06:00 draft: false images: [] menu: docs: parent: “cli-api” weight: 312 toc: true

Command Reference

Definition

Provides an interface to call the Trimble Access Management Application APIs.

Terminal window
./tam application

Sub-Commands

register

Registers an application with Trimble Access Management.

Arguments

environment (Required) Trimble Access Management environment. Options are Stage, and Prod

consumerKey (Required) The Trimble Cloud Console Client ID for your application.

consumerSecret (Required) The Trimble Cloud Console Client Secret for your application.

namespaces (Required) The comma separated namespaces of packages that should be used to create a bundle for the application.

autoUpdate (Optional) The boolean(true/false) parameter used to enable and disable auto update bundle, Default value is false. When an application has autoUpdate set to true, any package registered to it without a specific version will automatically refresh to the latest change on the appliance. This happens whenever a new revision of that package is registered or its data file is updated. If all packages are registered with a specific version, setting autoUpdate to true will not cause any changes.

Example

Terminal window
./tam application register --environment Stage --consumerKey a79ace58-555a-4558-954f-b922ba342656 --consumerSecret 2282aea627aa4464884d7227d4e38735 --namespaces sample.auth,sample2.auth --autoUpdate true

get

Gets current application’s namespace and the date of application’s last bundle update from Trimble Access Management.

Arguments

environment (Required) Trimble Access Management environment. Options are Stage, and Prod

consumerKey (Required) The Trimble Cloud Console Client ID for your application.

consumerSecret (Required) The Trimble Cloud Console Client Secret for your application.

Example

Terminal window
./tam application get --environment Stage --consumerKey a79ace58-555a-4558-954f-b922ba342656 --consumerSecret 2282aea627aa4464884d7227d4e38735

update

Updates an application with Trimble Access Management by adding, removing or overwriting the application packages.

Arguments

environment (Required) Trimble Access Management environment. Valid options are Stage, and Prod

consumerKey (Required) The Trimble Cloud Console Client ID for your application.

consumerSecret (Required) The Trimble Cloud Console Client Secret for your application.

namespaces (Required) The comma separated namespaces of packages that should be used to create a bundle for the application.

action (Required) Action can be add/remove/overwrite. Default value for action is overwrite.

autoUpdate (Optional) The boolean(true/false) parameter used to enable and disable auto update bundle, No Default value. When an application has autoUpdate set to true, any package registered to it without a specific version will automatically refresh to the latest change on the appliance. This happens whenever a new revision of that package is registered or its data file is updated. If all packages are registered with a specific version, setting autoUpdate to true will not cause any changes.

Example

Terminal window
./tam application update --environment Stage --consumerKey a79ace58-555a-4558-954f-b922ba342656 --consumerSecret 2282aea627aa4464884d7227d4e38735 --namespaces sample.auth,sample2.auth --action add --autoUpdate true