`bm idp ldap accesskey create`

Description

The bm idp ldap accesskey create allows you to add LDAP access key pairs.

EXAMPLE

The following example creates a new access key pair with the same policy as the authenticated user on the buckit alias:

bm idp ldap accesskey create buckit/

SYNTAX

The command has the following syntax:

bm [GLOBALFLAGS] idp ldap accesskey create                   \
                                 ALIAS                       \
                                 [--access-key <value>]      \
                                 [--secret-key <value>]      \
                                 [--policy <value>]          \
                                 [--name <value>]            \
                                 [--description <value>]     \
                                 [--expiry <value>]          \
                                 [--expiry-duration <value>]

Replace ALIAS with the alias of a Buckit deployment configured for AD/LDAP integration.

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 configured for AD/LDAP.

For example:

bm idp ldap accesskey create buckit

--access-key

Optional

An access key to use for the account. The access key cannot contain the characters = (equal sign) or , (comma).

Requires --secret-key

--secret-key

Optional

A secret to use for the account.

Requires --access-key

--policy

Optional

File path to the JSON-formatted policy to use for the account.

If not specified, the account uses the same policy as the authenticated user.

--name: Optional
A human-readable name to use for the account.

--description: Optional
Add a description for the service account. For example, you might specify the reason the access key exists.

--expiry-duration

Optional

Length of time the access key pair should remain valid for use in #d#h#s format.

For example, 7d, 24h, 5d12h30s are valid strings.

Mutually exclusive with --expiry.

--expiry

Optional

The date after which the access key expires. Enter the date in YYYY-MM-DD format.

For example, to expire the credentials after December 31, 2024, enter 2024-12-31.

Mutually exclusive with --expiry-duration.

--login

Optional

Deprecated since version RELEASE.2024-04-18T16-45-29Z: Use bm idp ldap accesskey create-with-login to access the functionality previously provided by this parameter.

Prompts the user to log in using the LDAP credentials to use to generate the access key. Specify the URL of the LDAP-configured Buckit Server to use for the login prompt.

Requires an interactive terminal.

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.

Examples

Create a new access-key pair for the authenticated user

The following command creates a new access key pair to use with the currently authenticated user on the buckit alias. The command outputs a randomly generated access key and secret key.

bm idp ldap accesskey create buckit

Create a new access-key pair with a custom access key and secret key

The following command creates a new access key pair with both an access key and secret key that you specify for the user currently authenticated on the buckit alias.

bm idp ldap accesskey create buckit/ --access-key my-access-key-change-me --secret-key my-secret-key-change-me

Create a new access-key pair that expires after 24 hours

The following command creates a new access key pair to use with the currently authenticated user on the buckit alias. The credentials expire after 24 hours.

The command outputs a randomly generated access key and secret key.

bm idp ldap accesskey create buckit --expiry-duration 24h

Create a new access-key and prompt to login as the user

The following command creates a new access key pair. The Buckit Manager CLI will first ask you to log in as the user the access key is for on the Buckit site configured for LDAP at buckit.example.com.

The command outputs a randomly generated access key and secret key.

bm idp ldap accesskey create buckit --login buckit.example.com

Create a new access-key pair that expires after a date

The following command creates a new access key pair to use with the currently authenticated user on the buckit alias. The credentials expire after February 29, 2024.

The command outputs a randomly generated access key and secret key.

bm idp ldap accesskey create buckit --expiry 2024-02-29