mc idp ldap accesskey create
Added: mc
RELEASE.2023-12-23T08-47-21Z
Description
The mc idp ldap accesskey create allows you to add LDAP access key pairs.
The following example creates a new access key pair with the same policy as the authenticated user on the
minioalias:
The command has the following syntax:
-
Replace
ALIASwith the alias of a MinIO 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
mc-cmd
Required
The alias of the MinIO deployment configured for AD/LDAP.
For example:
--access-key
mc-cmd
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
mc-cmd
Optional
A secret to use for the account.
Requires --access-key
--policy
mc-cmd
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
mc-cmd
Optional
A human-readable name to use for the account.
--description
mc-cmd
Optional
Add a description for the service account. For example, you might specify the reason the access key exists.
--expiry-duration
mc-cmd
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
mc-cmd
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
mc-cmd
Optional
Deprecated: RELEASE.2024-04-18T16-45-29Z
Use mc 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 MinIO Server to use for the login prompt.
Requires an interactive terminal.
Global Flags
This command supports any of the global flags.
Behavior
S3 Compatibility
SILO is the supported server for PGSTY mcli; compatibility with upstream MinIO and other S3 services is best effort.
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 minio alias. The command outputs a randomly generated access key and secret key.
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 minio alias.
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 minio alias. The credentials expire after 24 hours.
The command outputs a randomly generated access key and secret key.
Create a new access-key and prompt to login as the user
The following command creates a new access key pair. The MinIO Client will first ask you to log in as the user the access key is for on the MinIO site configured for LDAP at minio.example.com.
The command outputs a randomly generated access key and secret key.
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 minio alias. The credentials expire after February 29, 2024.
The command outputs a randomly generated access key and secret key.