Skip to main content
PUT
/
api
/
v3
/
network-settings
/
users
Update users configuration
curl --request PUT \
  --url https://apix.us.amity.co/api/v3/network-settings/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isAllowUpdateDisplayName": true,
  "fallbackRoleIds": [
    "<string>"
  ]
}
'
{
  "isAllowUpdateDisplayName": true,
  "fallbackRole": {
    "enabled": false,
    "roleIds": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Information of a users to be updated.

​
isAllowUpdateDisplayName
boolean
​
fallbackRoleIds
string[]

When fallback role is enabled, these roles will be assigned to users who don't have any role in the network.

Maximum string length: 10

Response

Users configuration

​
isAllowUpdateDisplayName
boolean
​
fallbackRole
object