Skip to content

Commit ef4faab

Browse files
authored
Fixes for missing or bugs in the custom token STS docs (#1479)
- Adds that `idmp-` string is added to `ROLE_ID` when generating an ARN - Updates claims example in the plugin docs to be JSON instead of basic comma-delimited key-value pairs
1 parent 3fec026 commit ef4faab

3 files changed

Lines changed: 6 additions & 2 deletions

File tree

source/administration/identity-access-management/pluggable-authentication.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The login flow for an application is as follows:
7575
{
7676
"user": "<string>",
7777
"maxValiditySeconds": 3600,
78-
"claims": "KEY=VALUE,[KEY=VALUE,...]"
78+
"claims": {"KEY": "VALUE", ...}
7979
}
8080
8181
.. list-table::
@@ -90,7 +90,7 @@ The login flow for an application is as follows:
9090
- The maximum allowed expiry duration for the returned credentials
9191

9292
* - ``claims``
93-
- A list of key-value pair claims associated with the requested credentials.
93+
- A JSON string of ``"key": "value"`` pair claims associated with the requested credentials.
9494
MinIO reserves and ignores the ``exp``, ``parent``, and ``sub`` claims objects if present.
9595

9696
4. MinIO returns a response to the STS API request that includes temporary credentials for use with making authenticated requests.

source/developers/security-token-service/AssumeRoleWithCustomToken.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ This endpoint supports the following query parameters:
6767

6868
See :envvar:`MINIO_IDENTITY_PLUGIN_ROLE_ID` or :mc-conf:`identity_plugin role_id <identity_plugin.role_id>` for more information.
6969

70+
Note that MinIO automatically prepends ``idmp-`` to a configured ``ROLE_ID`` when generating the RoleArn.
71+
Include that string with the ``ROLE_ID`` if required.
72+
7073
* - ``DurationSeconds``
7174
- integer
7275
- *Optional*

source/includes/common-minio-external-auth.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,7 @@ Specify a comma-separated list of MinIO :ref:`policies <minio-policy>` to assign
422422
.. start-minio-identity-management-role-id
423423
424424
Specify a unique ID MinIO uses to generate an ARN for this identity manager.
425+
MinIO automatically adds an ``idmp-`` prefix to the specified ID when generating the ARN.
425426

426427
If omitted, MinIO automatically generates the ID and prints the full ARN to the server log.
427428

0 commit comments

Comments
 (0)