Evo Voice

<back to all web services

NewUser

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.

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager
The following routes are available for this service:
POST/users
import Foundation
import ServiceStack

/**
* 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.")
public class NewUser : IPost, Codable
{
    /**
    * The account ID you want to create this user under
    */
    // @ApiMember(Description="The account ID you want to create this user under")
    public var accountId:String?

    /**
    * The email address of the new user
    */
    // @ApiMember(Description="The email address of the new user")
    public var emailAddress:String?

    /**
    * The user's first name
    */
    // @ApiMember(Description="The user's first name")
    public var firstName:String?

    /**
    * The user's last name
    */
    // @ApiMember(Description="The user's last name")
    public var lastName:String?

    /**
    * The password for the new user
    */
    // @ApiMember(Description="The password for the new user")
    public var password:String?

    required public init(){}
}

public class UserInfo : Codable
{
    public var id:String?
    public var isAuthenticated:Bool?
    public var firstName:String?
    public var lastName:String?
    public var name:String?
    public var avatarUrl:String?
    public var emailAddress:String?
    public var roles:[String] = []
    public var accountIds:[String] = []
    public var accountNames:[String] = []
    public var dashboardPermissions:[DashboardPermissions] = []

    required public init(){}
}

public enum DashboardPermissions : String, Codable
{
    case ViewFiles
    case ViewNotifications
    case ViewSessions
    case ViewEndpoints
    case ViewReports
    case ViewCustomers
    case ViewFlows
}


Swift NewUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	accountId: String,
	emailAddress: String,
	firstName: String,
	lastName: String,
	password: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	isAuthenticated: False,
	firstName: String,
	lastName: String,
	name: String,
	avatarUrl: String,
	emailAddress: String,
	roles: 
	[
		String
	],
	accountIds: 
	[
		String
	],
	accountNames: 
	[
		String
	],
	dashboardPermissions: 
	[
		ViewFiles
	]
}