bm admin accesskey info

Syntax

The bm admin accesskey info command returns a description of the specified access key(s).

The description output includes the following details, as available:

  • Access Key

  • Parent user of the specified access key

  • Access key status (on or off)

  • Policy or policies

  • Comment

  • Expiration

The following command returns information on the specified access key:

bm admin accesskey info mybuckit myuseraccesskey

The command has the following syntax:

bm [GLOBALFLAGS] admin accesskey info      \
                                 ALIAS     \
                                 ACCESSKEY
  • 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.

ACCESSKEY
Required

The access key to display.

Return information for multiple access keys by separating each access key with a space.

Global Flags

This command supports any of the global flags.

Examples

Display access key details

Use bm admin accesskey info to display details of an access key on a Buckit deployment:

   bm admin accesskey info mybuckit myaccesskey
  • Replace mybuckit with the alias of the Buckit deployment.

  • Replace myaccesskey with the access key for which to display information. List multiple keys by separating each with a space.

The output resembles the following:

AccessKey: myuserserviceaccount
ParentUser: myuser
Status: on
Comment:
Policy: implied
Expiration: no-expiry

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.