User (Object):Add User

Search (SHIFT+S)




Add User

POST /object/users

Creates a user for a specified namespace. The user must subsequently be assigned a secret key in order to access the object store.


Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • NAMESPACE_ADMIN


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<user_create_param>
<user> User to be created String
<namespace> Namespace identifier to associate with the user String
<tags> A list of arbitrary tags to assign to the new user. These can be used to track additional information about the user and will also appear on bucket billing responses for buckets owned by the user. String 0-* Elements
</user_create_param>

Response Body

Newly created user details.

Field Description Type Notes
<user_secret_key>
<secret_key> Secret key String
<key_timestamp> Secret key creation timestamp in ISO-8601 format String Valid Values:
  •  yyyy-MM-dd'T'HH:mm'Z'
<key_expiry_timestamp> Secret key expiry timestamp in ISO-8601 format String Valid Values:
  •  yyyy-MM-dd'T'HH:mm'Z'
<link> A link for this resource
</user_secret_key>

Examples

Request
POST https://192.168.0.0:4443/object/users HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<?xml version="1.0" encoding="UTF-8"?>
<user_create_param>
   <user>wuser1@SANITY.LOCAL</user>
   <namespace>s3</namespace>
</user_create_param>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<user_secret_key>
   <secret_key> </secret_key>
   <link href="/object/user-secret-keys/wuser1@sanity.local"
      rel="self"/>
</user_secret_key>
Notes: