Requires any of the roles: | SystemAdministrator, Manager |
POST | /users |
---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* 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 static class NewUser implements IPost
{
/**
* The account ID you want to create this user under
*/
@ApiMember(Description="The account ID you want to create this user under")
public String accountId = null;
/**
* The email address of the new user
*/
@ApiMember(Description="The email address of the new user")
public String emailAddress = null;
/**
* The user's first name
*/
@ApiMember(Description="The user's first name")
public String firstName = null;
/**
* The user's last name
*/
@ApiMember(Description="The user's last name")
public String lastName = null;
/**
* The password for the new user
*/
@ApiMember(Description="The password for the new user")
public String password = null;
public String getAccountId() { return accountId; }
public NewUser setAccountId(String value) { this.accountId = value; return this; }
public String getEmailAddress() { return emailAddress; }
public NewUser setEmailAddress(String value) { this.emailAddress = value; return this; }
public String getFirstName() { return firstName; }
public NewUser setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public NewUser setLastName(String value) { this.lastName = value; return this; }
public String getPassword() { return password; }
public NewUser setPassword(String value) { this.password = value; return this; }
}
public static class UserInfo
{
public String id = null;
public Boolean isAuthenticated = null;
public String firstName = null;
public String lastName = null;
public String name = null;
public String avatarUrl = null;
public String emailAddress = null;
public ArrayList<String> roles = null;
public ArrayList<String> accountIds = null;
public ArrayList<String> accountNames = null;
public ArrayList<DashboardPermissions> dashboardPermissions = null;
public String getId() { return id; }
public UserInfo setId(String value) { this.id = value; return this; }
public Boolean getIsAuthenticated() { return isAuthenticated; }
public UserInfo setIsAuthenticated(Boolean value) { this.isAuthenticated = value; return this; }
public String getFirstName() { return firstName; }
public UserInfo setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public UserInfo setLastName(String value) { this.lastName = value; return this; }
public String getName() { return name; }
public UserInfo setName(String value) { this.name = value; return this; }
public String getAvatarUrl() { return avatarUrl; }
public UserInfo setAvatarUrl(String value) { this.avatarUrl = value; return this; }
public String getEmailAddress() { return emailAddress; }
public UserInfo setEmailAddress(String value) { this.emailAddress = value; return this; }
public ArrayList<String> getRoles() { return roles; }
public UserInfo setRoles(ArrayList<String> value) { this.roles = value; return this; }
public ArrayList<String> getAccountIds() { return accountIds; }
public UserInfo setAccountIds(ArrayList<String> value) { this.accountIds = value; return this; }
public ArrayList<String> getAccountNames() { return accountNames; }
public UserInfo setAccountNames(ArrayList<String> value) { this.accountNames = value; return this; }
public ArrayList<DashboardPermissions> getDashboardPermissions() { return dashboardPermissions; }
public UserInfo setDashboardPermissions(ArrayList<DashboardPermissions> value) { this.dashboardPermissions = value; return this; }
}
public static enum DashboardPermissions
{
ViewFiles,
ViewNotifications,
ViewSessions,
ViewEndpoints,
ViewReports,
ViewCustomers,
ViewFlows;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"accountId":"String","emailAddress":"String","firstName":"String","lastName":"String","password":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl 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"]}