User aliases¶
User aliases can be used to assign multiple usernames to a single user. These additional usernames are called aliases. Use aliases to for example allow a user to authenticate using either the users username or e-mail address.
Aliases are only ever looked up during authentication, and can not be used as a substitute for the usernames. In this way, user aliases are different to external ids.
Managing aliases¶
Create a new alias for a user¶
-
PUT
/user/
(username)/alias/
(name)¶ Adds a new user alias for the specified user.
Status Codes: - 409 Conflict – The alias is already used by another user.
Role: _administrator
Example¶
PUT /user/stephen/alias/stephen@example.com
200 OK
GET API/user/stephen
<UserDocument xmlns="http://xml.vidispine.com/schema/vidispine" disabled="false">
<userName>stephen</userName>
<realName>Stephen</realName>
<alias>stephen@example.com</alias>
</UserDocument>
Delete a specific user alias¶
-
DELETE
/user/
(username)/alias/
(name)¶ Removes the specific user alias.
Role: _administrator
Example¶
DELETE /user/stephen/alias/stephen@example.com
200 OK
GET API/user/stephen
<UserDocument xmlns="http://xml.vidispine.com/schema/vidispine" disabled="false">
<userName>stephen</userName>
<realName>Stephen</realName>
</UserDocument>