Requires any of the roles: | SystemAdministrator, Manager |
PATCH | /users/{userId} |
---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Authentication
Namespace Global
Namespace Voice.Api.Authentication
Public Enum DashboardPermissions
ViewFiles
ViewNotifications
ViewSessions
ViewEndpoints
ViewReports
ViewCustomers
ViewFlows
End Enum
'''<Summary>
'''Update the specified login
'''</Summary>
<Api(Description:="Update the specified login")>
Public Partial Class PatchUser
Implements IPatch
'''<Summary>
'''The account IDs that this user has access to
'''</Summary>
<ApiMember(Description:="The account IDs that this user has access to")>
Public Overridable Property AccountIds As List(Of String)
'''<Summary>
'''The ID of the user
'''</Summary>
<ApiMember(Description:="The ID of the user")>
Public Overridable Property UserId As String
'''<Summary>
'''The user's first name
'''</Summary>
<ApiMember(Description:="The user's first name")>
Public Overridable Property FirstName As String
'''<Summary>
'''The user's last name
'''</Summary>
<ApiMember(Description:="The user's last name")>
Public Overridable Property LastName As String
'''<Summary>
'''The new password for the user (leave null to not change)
'''</Summary>
<ApiMember(Description:="The new password for the user (leave null to not change)")>
Public Overridable Property NewPassword As String
'''<Summary>
'''The roles to associate with the login. Can only specify if system admin
'''</Summary>
<ApiMember(Description:="The roles to associate with the login. Can only specify if system admin")>
Public Overridable Property Roles As List(Of String)
End Class
Public Partial Class UserInfo
Public Overridable Property Id As String
Public Overridable Property IsAuthenticated As Boolean
Public Overridable Property FirstName As String
Public Overridable Property LastName As String
Public Overridable Property Name As String
Public Overridable Property AvatarUrl As String
Public Overridable Property EmailAddress As String
Public Overridable Property Roles As List(Of String)
Public Overridable Property AccountIds As List(Of String)
Public Overridable Property AccountNames As List(Of String)
Public Overridable Property DashboardPermissions As List(Of DashboardPermissions)
End Class
End Namespace
End Namespace
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.
PATCH /users/{userId} HTTP/1.1
Host: team.evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PatchUser 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>
<FirstName>String</FirstName>
<LastName>String</LastName>
<NewPassword>String</NewPassword>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Roles>
<UserId>String</UserId>
</PatchUser>
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>