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 net.servicestack.client.*;

public class dtos
{

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

        /**
        * The ID of the user
        */
        @ApiMember(Description="The ID of the user")
        public String userId = null;

        /**
        * The user's first name
        */
        @ApiMember(Description="The user's first name")
        public String firstName = null;

        /**
        * The user's last name
        */
        @ApiMember(Description="The user's last name")
        public String lastName = 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)")
        public String newPassword = 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")
        public ArrayList<String> roles = null;
        
        public ArrayList<String> getAccountIds() { return accountIds; }
        public PatchUser setAccountIds(ArrayList<String> value) { this.accountIds = value; return this; }
        public String getUserId() { return userId; }
        public PatchUser setUserId(String value) { this.userId = value; return this; }
        public String getFirstName() { return firstName; }
        public PatchUser setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public PatchUser setLastName(String value) { this.lastName = value; return this; }
        public String getNewPassword() { return newPassword; }
        public PatchUser setNewPassword(String value) { this.newPassword = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public PatchUser setRoles(ArrayList<String> value) { this.roles = value; return this; }
    }

    public static class UserInfo
    {
        public String id = null;
        public Boolean isAuthenticated = null;
        public String firstName = null;
        public String lastName = null;
        public String name = null;
        public String avatarUrl = null;
        public String emailAddress = null;
        public ArrayList<String> roles = null;
        public ArrayList<String> accountIds = null;
        public ArrayList<String> accountNames = null;
        public ArrayList<DashboardPermissions> dashboardPermissions = null;
        
        public String getId() { return id; }
        public UserInfo setId(String value) { this.id = value; return this; }
        public Boolean getIsAuthenticated() { return isAuthenticated; }
        public UserInfo setIsAuthenticated(Boolean value) { this.isAuthenticated = value; return this; }
        public String getFirstName() { return firstName; }
        public UserInfo setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public UserInfo setLastName(String value) { this.lastName = value; return this; }
        public String getName() { return name; }
        public UserInfo setName(String value) { this.name = value; return this; }
        public String getAvatarUrl() { return avatarUrl; }
        public UserInfo setAvatarUrl(String value) { this.avatarUrl = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public UserInfo setEmailAddress(String value) { this.emailAddress = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public UserInfo setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public ArrayList<String> getAccountIds() { return accountIds; }
        public UserInfo setAccountIds(ArrayList<String> value) { this.accountIds = value; return this; }
        public ArrayList<String> getAccountNames() { return accountNames; }
        public UserInfo setAccountNames(ArrayList<String> value) { this.accountNames = value; return this; }
        public ArrayList<DashboardPermissions> getDashboardPermissions() { return dashboardPermissions; }
        public UserInfo setDashboardPermissions(ArrayList<DashboardPermissions> value) { this.dashboardPermissions = value; return this; }
    }

    public static enum DashboardPermissions
    {
        ViewFiles,
        ViewNotifications,
        ViewSessions,
        ViewEndpoints,
        ViewReports,
        ViewCustomers,
        ViewFlows;
    }

}

Java PatchUser DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"accountIds":["String"],"userId":"String","firstName":"String","lastName":"String","newPassword":"String","roles":["String"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":"String","isAuthenticated":false,"firstName":"String","lastName":"String","name":"String","avatarUrl":"String","emailAddress":"String","roles":["String"],"accountIds":["String"],"accountNames":["String"],"dashboardPermissions":["ViewFiles"]}