Modify a subuser

Learn how to modify an existing subuser.

Capabilities

`users=write`

Syntax

POST /admin/user?subuser&format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAME

Request Parameters

uid

Description: The user ID under which a subuser is to be created.
Type: String
Example: foo_user
Required: Yes

subuser

Description: The subuser ID to be modified.
Type: String
Example: sub_foo
Required: No

generate-secret

Description: Generate a new secret key for the subuser, replacing the existing key.
Type: Boolean
Example: True [False]
Required: No

secret

Description: Specify secret key.
Type: String
Example: 0AbCDEFg1h2i34JklM5nop6QrSTUV+WxyzaBC7D8
Required: No

key-type

Description: Key type to be generated, options are: swift (default), s3.
Type: String
Example: swift [swift]
Required: No

access

Description: Set access permissions for sub-user, should be one of read, write, readwrite, full.
Type: String
Example: read
Required: No

Response Entities

subusers

Description: Subusers associated with the user account.
Type: Container
Parent: N/A

id

Description: Subuser ID
Type: String
Parent: subusers

permissions

Description: Subuser access to user account.
Type: String
Parent: subusers

If successful, the response contains the subuser information.

InvalidKeyType

Description: Invalid key type specified.
Code: 400 Bad Request

InvalidSecretKey

Description: Invalid secret key specified.
Code: 400 Bad Request

InvalidAccess

Description: Invalid subuser access specified
Code: 400 Bad Request