From afa2b83687de96bfe9ae90c73744f71217dabcbe Mon Sep 17 00:00:00 2001 From: Casey Bodley Date: Thu, 9 Jan 2025 12:52:03 -0500 Subject: [PATCH] doc/rgw: document UserName requirements for account migration clarify the following error when migrating a user into an account: > could not modify user: unable to modify user, UserName contains invalid characters Fixes: https://tracker.ceph.com/issues/69470 Signed-off-by: Casey Bodley --- doc/radosgw/account.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/radosgw/account.rst b/doc/radosgw/account.rst index 6dab997d93e67..0e4ede5a50a79 100644 --- a/doc/radosgw/account.rst +++ b/doc/radosgw/account.rst @@ -174,6 +174,11 @@ An existing user can be adopted into an account with ``user modify``:: .. note:: Account membership is permanent. Once added, users cannot be removed from their account. +.. note:: The IAM User API imposes additional requirements on the format + of ``UserName``, which is enforced when migrating users into an account. + If migration fails with "UserName contains invalid characters", the + ``--display-name`` should be modified to match ``[\w+=,.@-]+``. + .. warning:: Ownership of the user's notification topics will not be transferred to the account. Notifications will continue to work, but the topics will no longer be visible to SNS Topic APIs. Topics and -- 2.39.5