Sign in

v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Users

Update User Role

Update the user's Role

post/v2/users/{userId}/roleUpdate

Path parameters

userIdstring uuid required

The UUID of the User.

Request body

rolesstring[] required
<p>The role(s) for the user</p> <p>The role must exist</p> <p>The role can be a custom role or a system role but the invoker must have the permissions to assign the role</p> <p>System roles are: backoffice.admin, payor.master_admin, payor.admin, payor.support</p>
verificationCodestring nullable
<p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>

Example request

{
  "roles": [
    "payor.admin"
  ],
  "verificationCode": "123456"
}

Response

request completed okay