Update Profile

This API requires the Account Administrator role.

Updates a profile.

The following fields must be unique otherwise a HTTP 409 Conflcit will be returned:

  • profileName

This operation will clear the value stored for any fields not present in the request.
For example, to remove a feature such as voice from a user you should omit the
voice field in the request. The same behavior applies to every field in the request.

Changes to the fields:

  • features

Will trigger asynchronous updates, the status of which should be monitored via /profiles:listStatuses.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

string
required
length between 6 and 6
^[a-zA-Z0-9\-\_\.\ ]+$

The unique 6 character internal id (uuid) that represents the profile.

Body Params

Profile information

string
required
length between 2 and 255
^[a-zA-Z\p{L}0-9]+([ ]*[a-zA-Z\p{L}0-9-\_\*\=\+\$\:\;\&\~\,\?\%\!\|\{\}\`\.\']+)*$

Name of profile

string
length between 5 and 1024

Information about profile

string
length between 36 and 36

The unique 36 character internal id (uuid) that represents the ux profile.

roles
array of objects
length ≤ 50

Role list applicable with profile

roles
memberOfGroups
array of strings
length ≤ 50

List of the groups of which the user is member of.

memberOfGroups
resourcePartitions
array of strings
length ≤ 10

List of the resource partitions assigned to the user

resourcePartitions
resourcePartitionDefaultResources
array of objects
resourcePartitionDefaultResources
features
object

Features present in profile

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json