Get user information
Learn how to get user information.
Cap users or user-info-without-keys must be set to
read to run this operation. If cap user-info-without-keys is set
to read or *, S3 keys and Swift keys will not be included in the
response unless the user running this operation is the system user, an admin user, or the cap
users is set to read.
Capabilities
users=read or user-info-without-keys=readSyntax
GET /admin/user?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAMERequest Parameters
uid
- Description
-
The user for which the information is requested.
- Type
-
String
- Example
-
foo_user - Required
-
Yes
access-key
- Description
-
The S3 access key of the user for which the information is requested.
- Type
-
String
- Example
-
ABCD0EF12GHIJ2K34LMN - Required
-
No
Response Entities
user
- Description
-
A container for the user data information.
- Type
-
Container
- Parent
-
N/A
user_id
- Description
-
The user ID.
- Type
-
String
- Parent
-
user
display_name
- Description
-
Display name for the user.
- Type
-
String
- Parent
-
user
suspended
- Description
-
True if the user is suspended.
- Type
-
Boolean
- Parent
-
user
max_buckets
- Description
-
The maximum number of buckets to be owned by the user.
- Type
-
Integer
- Parent
-
user
subusers
- Description
-
Subusers associated with this user account.
- Type
-
Container
- Parent
-
user
keys
- Description
-
S3 keys associated with this user account.
- Type
-
Container
- Parent
-
user
swift_keys
- Description
-
Swift keys associated with this user account.
- Type
-
Container
- Parent
-
user
caps
- Description
-
User capabilities.
- Type
-
Container
- Parent
-
user
If successful, the response contains the user information.
Special Error Responses
None.