bm admin user svcacct edit

Important

This command has been replaced and will be deprecated in a future Buckit Manager CLI release.

As of Buckit Manager CLI RELEASE.2024-10-08T09-37-26Z, use the bm admin accesskey edit command to modify access keys for built-in Buckit IDP users.

To modify access keys for AD/LDAP users, use the bm idp ldap accesskey edit command.

Syntax

The bm admin user svcacct edit command modifies the configuration of an access key associated to the specified user.

The following command applies a new policy and secret key to the myuserserviceaccount access key on the mybuckit deployment:

bm admin user svcacct edit                                             \
                      --secret-key "myuserserviceaccountnewsecretkey"  \
                      --policy "/path/to/new/policy.json"              \
                      mybuckit myuserserviceaccount

The command has the following syntax:

bm [GLOBALFLAGS] admin user svcacct edit            \
                                    [--secret-key]  \
                                    [--policy]      \
                                    ALIAS           \
                                    SERVICEACCOUNT
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS
Required

The alias of the Buckit deployment.

SERVICEACCOUNT
Required

The service account to modify.

--description
Optional
--expiry
Optional
--name
Optional
--policy
Optional

The path to a policy document to attach to the new access key, with a maximum size of 2048 characters. The attached policy cannot grant access to any action or resource not explicitly allowed by the parent user’s policies.

The new policy overwrites any previously attached policy.

--secret-key
Optional

The secret key to associate with the new access key. Overwrites the previous secret key. Applications using the access keys must update to use the new credentials to continue performing operations.

Global Flags

This command supports any of the global flags.

Behavior

S3 Compatibility

The bm commandline tool is built for compatibility with the AWS S3 API and is tested with Buckit and AWS S3 for expected functionality and behavior.

Buckit provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While bm commands may work as documented, any such usage is at your own risk.