Evo Voice

<back to all web services

PatchUser

Update the specified login

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager
The following routes are available for this service:
PATCH/users/{userId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Update the specified login
*/
@Api(Description="Update the specified login")
open class PatchUser : IPatch
{
    /**
    * The account IDs that this user has access to
    */
    @ApiMember(Description="The account IDs that this user has access to")
    open var accountIds:ArrayList<String>? = null

    /**
    * The ID of the user
    */
    @ApiMember(Description="The ID of the user")
    open var userId:String? = null

    /**
    * The user's first name
    */
    @ApiMember(Description="The user's first name")
    open var firstName:String? = null

    /**
    * The user's last name
    */
    @ApiMember(Description="The user's last name")
    open var lastName:String? = null

    /**
    * The new password for the user (leave null to not change)
    */
    @ApiMember(Description="The new password for the user (leave null to not change)")
    open var newPassword:String? = null

    /**
    * The roles to associate with the login. Can only specify if system admin
    */
    @ApiMember(Description="The roles to associate with the login. Can only specify if system admin")
    open var roles:ArrayList<String>? = null
}

open class UserInfo
{
    open var id:String? = null
    open var isAuthenticated:Boolean? = null
    open var firstName:String? = null
    open var lastName:String? = null
    open var name:String? = null
    open var avatarUrl:String? = null
    open var emailAddress:String? = null
    open var roles:ArrayList<String>? = null
    open var accountIds:ArrayList<String>? = null
    open var accountNames:ArrayList<String>? = null
    open var managerAccess:UserManagerAccess? = null
    open var dashboardPermissions:ArrayList<DashboardPermissions>? = null
}

enum class UserManagerAccess
{
    ReadOnly,
    ReadWrite,
    ReadWriteDelete,
}

enum class DashboardPermissions
{
    ViewFiles,
    ViewNotifications,
    ViewSessions,
    ViewEndpoints,
    ViewReports,
    ViewCustomers,
    ViewFlows,
    ViewCallCenter,
}

Kotlin PatchUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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: 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>
  <ManagerAccess>ReadOnly</ManagerAccess>
  <Name>String</Name>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</UserInfo>