Evo Voice

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}

"use strict";
/** @typedef {'ReadOnly'|'ReadWrite'|'ReadWriteDelete'} */
export var UserManagerAccess;
(function (UserManagerAccess) {
    UserManagerAccess["ReadOnly"] = "ReadOnly"
    UserManagerAccess["ReadWrite"] = "ReadWrite"
    UserManagerAccess["ReadWriteDelete"] = "ReadWriteDelete"
})(UserManagerAccess || (UserManagerAccess = {}));
/** @typedef {'ViewFiles'|'ViewNotifications'|'ViewSessions'|'ViewEndpoints'|'ViewReports'|'ViewCustomers'|'ViewFlows'|'ViewCallCenter'} */
export var DashboardPermissions;
(function (DashboardPermissions) {
    DashboardPermissions["ViewFiles"] = "ViewFiles"
    DashboardPermissions["ViewNotifications"] = "ViewNotifications"
    DashboardPermissions["ViewSessions"] = "ViewSessions"
    DashboardPermissions["ViewEndpoints"] = "ViewEndpoints"
    DashboardPermissions["ViewReports"] = "ViewReports"
    DashboardPermissions["ViewCustomers"] = "ViewCustomers"
    DashboardPermissions["ViewFlows"] = "ViewFlows"
    DashboardPermissions["ViewCallCenter"] = "ViewCallCenter"
})(DashboardPermissions || (DashboardPermissions = {}));
export class UserInfo {
    /** @param {{id?:string,isAuthenticated?:boolean,firstName?:string,lastName?:string,name?:string,avatarUrl?:string,emailAddress?:string,roles?:string[],accountIds?:string[],accountNames?:string[],managerAccess?:UserManagerAccess,dashboardPermissions?:DashboardPermissions[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {boolean} */
    isAuthenticated;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    name;
    /** @type {string} */
    avatarUrl;
    /** @type {string} */
    emailAddress;
    /** @type {string[]} */
    roles;
    /** @type {string[]} */
    accountIds;
    /** @type {string[]} */
    accountNames;
    /** @type {UserManagerAccess} */
    managerAccess;
    /** @type {DashboardPermissions[]} */
    dashboardPermissions;
}
export class PatchUser {
    /** @param {{accountIds?:string[],userId?:string,firstName?:string,lastName?:string,newPassword?:string,roles?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string[]}
     * @description The account IDs that this user has access to */
    accountIds;
    /**
     * @type {string}
     * @description The ID of the user */
    userId;
    /**
     * @type {string}
     * @description The user's first name */
    firstName;
    /**
     * @type {string}
     * @description The user's last name */
    lastName;
    /**
     * @type {string}
     * @description The new password for the user (leave null to not change) */
    newPassword;
    /**
     * @type {string[]}
     * @description The roles to associate with the login. Can only specify if system admin */
    roles;
}

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