Requires any of the roles: | SystemAdministrator, Manager |
POST | /users |
---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Authentication;
namespace Voice.Api.Authentication
{
public enum DashboardPermissions
{
ViewFiles,
ViewNotifications,
ViewSessions,
ViewEndpoints,
ViewReports,
ViewCustomers,
ViewFlows,
}
///<summary>
///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.
///</summary>
[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 partial class NewUser
: IPost
{
///<summary>
///The account ID you want to create this user under
///</summary>
[ApiMember(Description="The account ID you want to create this user under")]
public virtual string AccountId { get; set; }
///<summary>
///The email address of the new user
///</summary>
[ApiMember(Description="The email address of the new user")]
public virtual string EmailAddress { get; set; }
///<summary>
///The user's first name
///</summary>
[ApiMember(Description="The user's first name")]
public virtual string FirstName { get; set; }
///<summary>
///The user's last name
///</summary>
[ApiMember(Description="The user's last name")]
public virtual string LastName { get; set; }
///<summary>
///The password for the new user
///</summary>
[ApiMember(Description="The password for the new user")]
public virtual string Password { get; set; }
}
public partial class UserInfo
{
public virtual string Id { get; set; }
public virtual bool IsAuthenticated { get; set; }
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
public virtual string Name { get; set; }
public virtual string AvatarUrl { get; set; }
public virtual string EmailAddress { get; set; }
public virtual List<string> Roles { get; set; }
public virtual List<string> AccountIds { get; set; }
public virtual List<string> AccountNames { get; set; }
public virtual List<DashboardPermissions> DashboardPermissions { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: team.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 ] }