| Requires any of the roles: | SystemAdministrator, Manager |
| 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,
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
],
managerAccess: ReadOnly,
dashboardPermissions:
[
ViewFiles
]
}