| Requires any of the roles: | SystemAdministrator, Manager |
| POST | /users |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Creates a new login with the specified email address and password. Note: Any given email address can only exist once in the entire Evo Voice system.
*/
@Api(Description="Creates a new login with the specified email address and password. Note: Any given email address can only exist once in the entire Evo Voice system.")
open class NewUser : IPost
{
/**
* The account ID you want to create this user under
*/
@ApiMember(Description="The account ID you want to create this user under")
open var accountId:String? = null
/**
* The email address of the new user
*/
@ApiMember(Description="The email address of the new user")
open var emailAddress:String? = null
/**
* The user's first name
*/
@ApiMember(Description="The user's first name")
open var firstName:String? = null
/**
* The user's last name
*/
@ApiMember(Description="The user's last name")
open var lastName:String? = null
/**
* The password for the new user
*/
@ApiMember(Description="The password for the new user")
open var password:String? = null
}
open class UserInfo
{
open var id:String? = null
open var isAuthenticated:Boolean? = null
open var firstName:String? = null
open var lastName:String? = null
open var name:String? = null
open var avatarUrl:String? = null
open var emailAddress:String? = null
open var roles:ArrayList<String>? = null
open var accountIds:ArrayList<String>? = null
open var accountNames:ArrayList<String>? = null
open var managerAccess:UserManagerAccess? = null
open var dashboardPermissions:ArrayList<DashboardPermissions>? = null
}
enum class UserManagerAccess
{
ReadOnly,
ReadWrite,
ReadWriteDelete,
}
enum class DashboardPermissions
{
ViewFiles,
ViewNotifications,
ViewSessions,
ViewEndpoints,
ViewReports,
ViewCustomers,
ViewFlows,
ViewCallCenter,
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users HTTP/1.1
Host: evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NewUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
<AccountId>String</AccountId>
<EmailAddress>String</EmailAddress>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Password>String</Password>
</NewUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
<AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AccountIds>
<AccountNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AccountNames>
<AvatarUrl>String</AvatarUrl>
<DashboardPermissions>
<DashboardPermissions>ViewFiles</DashboardPermissions>
</DashboardPermissions>
<EmailAddress>String</EmailAddress>
<FirstName>String</FirstName>
<Id>String</Id>
<IsAuthenticated>false</IsAuthenticated>
<LastName>String</LastName>
<ManagerAccess>ReadOnly</ManagerAccess>
<Name>String</Name>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Roles>
</UserInfo>