minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-06 14:42:56 +03:00
Code Activity
Files
relax-event-restriction
docs/source/reference/minio-mc-admin/mc-admin-accesskey-edit.rst
Daryl White af3d8aba9f Updates for two October 2024 releases (#1353) 
Deprecates a no longer used operator environment variable.

Closes #1351

Adds `mc admin accesskey` and subcommands.
Updates `mc admin user svcacct` and subcommands with reference to new
commands.

Closes #1350
2024-10-22 16:32:42 -04:00

4.9 KiB
Raw Permalink Blame History

mc admin user accesskey edit

minio

Table of Contents

mc admin accesskey edit

Syntax

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

The command requires that at least one attribute of the access key change. Otherwise, the command exits with an error message.

EXAMPLE

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

mc admin accesskey edit                                             \  
                   myminio myuserserviceaccount                     \
                   --secret-key "myuserserviceaccountnewsecretkey"  \     
                   --policy "/path/to/new/policy.json"

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin accesskey edit                      \  
                                 ALIAS                     \  
                                 ACCESSKEY                 \
                                 [--description string]    \
                                 [--expiry-duration value] \
                                 [--expiry value]          \
                                 [--name string]           \
                                 [--policy path]           \  
                                 [--secret-key string]

Parameters

ALIAS

The alias <mc alias> of the MinIO deployment.

ACCESSKEY

The access key to modify.

--description

Add or modify a description for the access key. For example, you might specify the reason the access key exists.

--expiry

Set or modify an expiration date for the access key. The date must be in the future, you may not set an expiration date that has already passed.

Allowed date and time formats:

  • 2023-06-24
  • 2023-06-24T10:00
  • 2023-06-24T10:00:00
  • 2023-06-24T10:00:00Z
  • 2023-06-24T10:00:00-07:00

Mutually exclusive with ~mc admin accesskey edit --expiry-duration.

--expiry-duration

Length of time for which the accesskey remains valid.

For example, 30d, 24h, or similar. To expire the credentials after 30 days, use:

--expiry-duration 30d

Mutually exclusive with ~mc admin accesskey edit --expiry.

--name

Add or modify a human-readable name for the access key.

--policy

The path to a policy document <minio-policy> 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

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

Examples

Change the secret key for an access key

The following command modifies the secret key for the access key myuseraccesskey on the myminio deployment.

mc admin accesskey edit myminio/ myuseraccesskey --secret-key 'new-secret-key-change-me'

Change the expiration for an access key

The following command changes the expiration value for the access key myuseraccesskey on the myminio deployment.

mc admin accesskey edit myminio/ myuseraccesskey --expiry-duration 24h

The ~mc admin accesskey edit --expiry-duration cannot be added if the access key already has a value set for ~mc admin accesskey edit --expiry.

Behavior

S3 Compatibility