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}
namespace Voice.Api.Authentication

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type DashboardPermissions =
        | ViewFiles = 0
        | ViewNotifications = 1
        | ViewSessions = 2
        | ViewEndpoints = 3
        | ViewReports = 4
        | ViewCustomers = 5
        | ViewFlows = 6

    [<AllowNullLiteral>]
    type UserInfo() = 
        member val Id:String = null with get,set
        member val IsAuthenticated:Boolean = new Boolean() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val Name:String = null with get,set
        member val AvatarUrl:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val AccountIds:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val AccountNames:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val DashboardPermissions:ResizeArray<DashboardPermissions> = new ResizeArray<DashboardPermissions>() with get,set

    ///<summary>
    ///Update the specified login
    ///</summary>
    [<Api(Description="Update the specified login")>]
    [<AllowNullLiteral>]
    type PatchUser() = 
        interface IPatch
        ///<summary>
        ///The account IDs that this user has access to
        ///</summary>
        [<ApiMember(Description="The account IDs that this user has access to")>]
        member val AccountIds:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///The ID of the user
        ///</summary>
        [<ApiMember(Description="The ID of the user")>]
        member val UserId:String = null with get,set

        ///<summary>
        ///The user's first name
        ///</summary>
        [<ApiMember(Description="The user's first name")>]
        member val FirstName:String = null with get,set

        ///<summary>
        ///The user's last name
        ///</summary>
        [<ApiMember(Description="The user's last name")>]
        member val LastName:String = null with get,set

        ///<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)")>]
        member val NewPassword:String = null with get,set

        ///<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")>]
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set

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