Requires any of the roles: | SystemAdministrator, Manager |
PATCH | /users/{userId} |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum DashboardPermissions
{
ViewFiles = 'ViewFiles',
ViewNotifications = 'ViewNotifications',
ViewSessions = 'ViewSessions',
ViewEndpoints = 'ViewEndpoints',
ViewReports = 'ViewReports',
ViewCustomers = 'ViewCustomers',
ViewFlows = 'ViewFlows',
}
export class UserInfo
{
public id: string;
public isAuthenticated: boolean;
public firstName: string;
public lastName: string;
public name: string;
public avatarUrl: string;
public emailAddress: string;
public roles: string[];
public accountIds: string[];
public accountNames: string[];
public dashboardPermissions: DashboardPermissions[];
public constructor(init?: Partial<UserInfo>) { (Object as any).assign(this, init); }
}
/** @description Update the specified login */
// @Api(Description="Update the specified login")
export class PatchUser implements IPatch
{
/** @description The account IDs that this user has access to */
// @ApiMember(Description="The account IDs that this user has access to")
public accountIds: string[];
/** @description The ID of the user */
// @ApiMember(Description="The ID of the user")
public userId: string;
/** @description The user's first name */
// @ApiMember(Description="The user's first name")
public firstName: string;
/** @description The user's last name */
// @ApiMember(Description="The user's last name")
public lastName: string;
/** @description 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 newPassword: string;
/** @description 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 roles: string[];
public constructor(init?: Partial<PatchUser>) { (Object as any).assign(this, init); }
}
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: team.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 ] }