| Requires any of the roles: | SystemAdministrator, Manager |
| POST | /users |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class DashboardPermissions(str, Enum):
VIEW_FILES = 'ViewFiles'
VIEW_NOTIFICATIONS = 'ViewNotifications'
VIEW_SESSIONS = 'ViewSessions'
VIEW_ENDPOINTS = 'ViewEndpoints'
VIEW_REPORTS = 'ViewReports'
VIEW_CUSTOMERS = 'ViewCustomers'
VIEW_FLOWS = 'ViewFlows'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserInfo:
id: Optional[str] = None
is_authenticated: bool = False
first_name: Optional[str] = None
last_name: Optional[str] = None
name: Optional[str] = None
avatar_url: Optional[str] = None
email_address: Optional[str] = None
roles: Optional[List[str]] = None
account_ids: Optional[List[str]] = None
account_names: Optional[List[str]] = None
dashboard_permissions: Optional[List[DashboardPermissions]] = None
# @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.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewUser(IPost):
"""
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.
"""
# @ApiMember(Description="The account ID you want to create this user under")
account_id: Optional[str] = None
"""
The account ID you want to create this user under
"""
# @ApiMember(Description="The email address of the new user")
email_address: Optional[str] = None
"""
The email address of the new user
"""
# @ApiMember(Description="The user's first name")
first_name: Optional[str] = None
"""
The user's first name
"""
# @ApiMember(Description="The user's last name")
last_name: Optional[str] = None
"""
The user's last name
"""
# @ApiMember(Description="The password for the new user")
password: Optional[str] = None
"""
The password for the new user
"""
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>