Documentation

mc admin user svcacct edit

Syntax

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

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

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

The command has the following syntax:

mc [GLOBALFLAGS] admin user svcacct edit            \
                                    [--secret-key]  \
                                    [--policy]      \
                                    ALIAS           \
                                    SERVICEACCOUNT
  • 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 MinIO deployment.

SERVICEACCOUNT
Required

The service account to modify.

--description
Optional

New in version RELEASE.2023-05-18T16-59-00Z.

Add a description for the service account. For example, you might specify the reason the service account exists.

--expiry
Optional

New in version RELEASE.2023-05-30T22-41-38Z.

Set an expiration date for the service account. 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

--name
Optional

New in version RELEASE.2023-05-18T16-59-00Z.

Add a human-readable name for the service account.

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

The new policy overwrites any previously attached policy.

--secret-key
Optional

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

This command supports any of the global flags.

Behavior

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested with MinIO and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.