Requires any of the roles: | SystemAdministrator, Manager |
POST | /users |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum DashboardPermissions
{
ViewFiles = 'ViewFiles',
ViewNotifications = 'ViewNotifications',
ViewSessions = 'ViewSessions',
ViewEndpoints = 'ViewEndpoints',
ViewReports = 'ViewReports',
ViewCustomers = 'ViewCustomers',
ViewFlows = 'ViewFlows',
}
export class UserInfo
{
public id: string;
public isAuthenticated: boolean;
public firstName: string;
public lastName: string;
public name: string;
public avatarUrl: string;
public emailAddress: string;
public roles: string[];
public accountIds: string[];
public accountNames: string[];
public dashboardPermissions: DashboardPermissions[];
public constructor(init?: Partial<UserInfo>) { (Object as any).assign(this, init); }
}
/** @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. */
// @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.")
export class NewUser implements IPost
{
/** @description The account ID you want to create this user under */
// @ApiMember(Description="The account ID you want to create this user under")
public accountId: string;
/** @description The email address of the new user */
// @ApiMember(Description="The email address of the new user")
public emailAddress: string;
/** @description The user's first name */
// @ApiMember(Description="The user's first name")
public firstName: string;
/** @description The user's last name */
// @ApiMember(Description="The user's last name")
public lastName: string;
/** @description The password for the new user */
// @ApiMember(Description="The password for the new user")
public password: string;
public constructor(init?: Partial<NewUser>) { (Object as any).assign(this, init); }
}
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: team.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> <Name>String</Name> <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </Roles> </UserInfo>