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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class DashboardPermissions(str, Enum):
    VIEW_FILES = 'ViewFiles'
    VIEW_NOTIFICATIONS = 'ViewNotifications'
    VIEW_SESSIONS = 'ViewSessions'
    VIEW_ENDPOINTS = 'ViewEndpoints'
    VIEW_REPORTS = 'ViewReports'
    VIEW_CUSTOMERS = 'ViewCustomers'
    VIEW_FLOWS = 'ViewFlows'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserInfo:
    id: Optional[str] = None
    is_authenticated: Optional[bool] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    name: Optional[str] = None
    avatar_url: Optional[str] = None
    email_address: Optional[str] = None
    roles: Optional[List[str]] = None
    account_ids: Optional[List[str]] = None
    account_names: Optional[List[str]] = None
    dashboard_permissions: Optional[List[DashboardPermissions]] = None


# @Api(Description="Update the specified login")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PatchUser(IPatch):
    """
    Update the specified login
    """

    # @ApiMember(Description="The account IDs that this user has access to")
    account_ids: Optional[List[str]] = None
    """
    The account IDs that this user has access to
    """


    # @ApiMember(Description="The ID of the user")
    user_id: Optional[str] = None
    """
    The ID of the user
    """


    # @ApiMember(Description="The user's first name")
    first_name: Optional[str] = None
    """
    The user's first name
    """


    # @ApiMember(Description="The user's last name")
    last_name: Optional[str] = None
    """
    The user's last name
    """


    # @ApiMember(Description="The new password for the user (leave null to not change)")
    new_password: Optional[str] = None
    """
    The new password for the user (leave null to not change)
    """


    # @ApiMember(Description="The roles to associate with the login. Can only specify if system admin")
    roles: Optional[List[str]] = None
    """
    The roles to associate with the login. Can only specify if system admin
    """

Python PatchUser DTOs

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

HTTP + JSV

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

{
	accountIds: 
	[
		String
	],
	userId: String,
	firstName: String,
	lastName: String,
	newPassword: String,
	roles: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	]
}