Documentation

MinIO Access Management Plugin Settings

This page documents settings for enabling external authorization management using the MinIO Access Management Plugin. See MinIO External Access Management Plugin for a tutorial on using these settings.

You can establish or modify settings by defining:

  • an environment variable on the host system prior to starting or restarting the MinIO Server. Refer to your operating system’s documentation for how to define an environment variable.

  • a configuration setting using mc admin config set.

  • a configuration setting using the MinIO Console’s Administrator > Settings pages.

If you define both an environment variable and the similar configuration setting, MinIO uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

Important

Each configuration setting controls fundamental MinIO behavior and functionality. MinIO strongly recommends testing configuration changes in a lower environment, such as DEV or QA, before applying to production.

Examples

When setting up the MinIO Access Management plugin, you must define at minimum all required settings. The examples here represent the minimum required setting.

MINIO_POLICY_PLUGIN_URL="https://authzservice.example.net:8080/authz"
policy_plugin

Use the mc admin config set command to create or update the access management plugin configuration. The policy_plugin url argument is required. Specify additional optional arguments as a whitespace (” “)-delimited list.

mc admin config set policy_plugin                     \
   url="https://authzservice.example.net:8080/authz"  \
   [ARGUMENT=VALUE] ...

Settings

URL

Required

MINIO_POLICY_PLUGIN_URL
policy_plugin url

The webhook endpoint for the external access management service (https://authzservice.example.net:8080/authz).

Auth Token

Optional

MINIO_POLICY_PLUGIN_AUTH_TOKEN
policy_plugin auth_token

An authentication token to present to the configured webhook endpoint.

Specify a supported HTTP Authentication scheme as a string value, such as "Bearer TOKEN". MinIO sends the token using the HTTP Authorization header.

HTTP2

Optional

MINIO_POLICY_PLUGIN_ENABLE_HTTP2
policy_plugin enable_http2

Enable experimental HTTP2 support for connecting to the configure webhook service.

Defaults to off

Comment

Optional

MINIO_POLICY_PLUGIN_COMMENT
policy_plugin comment

Specify a comment to associate to the external access management configuration.