`bm admin user svcacct add`

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 create command to add access keys for built-in Buckit IDP users.

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

Syntax

The bm admin user svcacct add command adds a new access key to an existing Buckit or AD/LDAP user.

Access keys for OpenID Connect users

To generate service account access keys for OpenID Connect users, use the Buckit Console.

EXAMPLE

The following command creates a new access key associated to an existing Buckit user:

bm admin user svcacct add                       \
   --access-key "myuserserviceaccount"          \
   --secret-key "myuserserviceaccountpassword"  \
   --policy "/path/to/policy.json"              \
   mybuckit myuser

The command returns the access key and secret key for the new account.

SYNTAX

The command has the following syntax:

bm [GLOBALFLAGS] admin user svcacct add             \
                                    [--access-key]  \
                                    [--secret-key]  \
                                    [--policy]      \
                                    [--comment]     \
                                    ALIAS           \
                                    USER

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.

USER

Required

The username of the user to which Buckit adds the new access key.

For Buckit-managed users, specify the access key for the user.
For Active Directory/LDAP users, specify the Distinguished Name of the user.
For OpenID Connect users, use the Buckit Console to generate access keys.

--access-key

Optional

A string to use as the access key for this account. Omit to let Buckit autogenerate a random 20 character value.

Access Key names must be unique across all users.

--comment: Optional

Changed in version RELEASE.2023-05-18T16-59-00Z: Replaced by --description and --name.

Originally added in version RELEASE.2023-01-28T20-29-38Z.

This option has been removed. Use --description or --name instead.

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

--secret-key: Optional
The secret key to associate with the new account. Omit to let Buckit autogenerate a random 40-character value.

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.