Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
User Roles

Add roles to User

Endpoint to assign a Role to an User.

post/business/v2/employees/{userId}/assignRole

Path parameters

userIdstring required

The User ID to assign Role to.

Example:XMPL1234-000001

Headers

X-Soldo-Fingerprintstring required

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

Example:{{fingerprint}}
X-Soldo-Fingerprint-Signaturestring required

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Example:{{fingerprint_signature}}

Request body

namestring

The name of the Role.

descriptionstring

The description of the Role.

scopestring

The name of the scope.

Example request

{
  "name": "superAdmin",
  "description": "The SuperAdmin role",
  "scope": "ALL"
}

Response

The returned resource is a single User.

idstring

The User ID.

Example response

{
  "id": "XMPL1234-000001",
  "roles": [
    {
      "id": "superAdmin",
      "name": "superAdmin",
      "description": "The SuperAdmin role",
      "scope": "ALL"
    }
  ]
}