4.1 KiB
1) Configure or Create a Client for Accessing Keycloak
Authenticate to the Keycloak Administrative Console
and navigate to Clients
.
2) Create Client Scope for MinIO Client
Client scopes allow Keycloak to map user attributes as part of the JSON Web Token (JWT) returned in authentication requests. This allows MinIO to reference those attributes when assigning policies to the user. This step creates the necessary client scope to support MinIO authorization after successful Keycloak authentication.
3) Apply the Necessary Attribute to Keycloak Users/Groups
You must assign an attribute named policy
to the
Keycloak Users or Groups. Set the value to any policy <minio-policy>
on the MinIO deployment.
4) Configure MinIO for Keycloak Authentication
MinIO supports multiple methods for configuring Keycloak authentication:
- Using the MinIO Console
- Using a terminal/shell and the
mc admin idp openid
command - Using environment variables set prior to starting MinIO
MinIO Console
CLI
Environment Variables
Restart the MinIO deployment for the changes to apply.
Check the MinIO logs and verify that startup succeeded with no errors related to the OIDC configuration.
If you attempt to log in with the Console, you should now see an
(SSO) button using the configured Display Name
.
Specify a configured user and attempt to log in. MinIO should
automatically redirect you to the Keycloak login entry. Upon successful
authentication, Keycloak should redirect you back to the MinIO Console
using either the originating Console URL or the Redirect URI
if
configured.
5) Generate Application Credentials using the Security Token Service (STS)
Next Steps
Applications should implement the STS AssumeRoleWithWebIdentity <minio-sts-assumerolewithwebidentity>
flow using their SDK <minio-drivers>
of choice. When STS
credentials expire, applications should have logic in place to
regenerate the JWT token, STS token, and MinIO credentials before
retrying and continuing operations.
Alternatively, users can generate access keys <minio-id-access-keys>
through the
MinIO Console for the purpose of creating long-lived API-key like access
using their Keycloak credentials.