Create UserRole

Create a new UserRole record.

POST /api/security/userroles

Create UserRole

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/security/userroles \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>"
}
'

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A User Role is a permission group that assigns one or more global Roles to user accounts across every location they can access; its associated location is organisational only.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the UserRole-Create role.

Request Body

Required Fields

BusinessId · integer · required

ID of the organisational location associated with this User Role; keep it at the top-most root location where possible, as it does not limit the permissions granted..

Name · string · required

Required name of this permission group, unique within its organisational location..

Optional Fields

Roles · integer[]

List of global Role IDs that define this permission group’s permissions; an empty list grants no Role permissions..

Users · integer[]

List of User IDs assigned to this permission group; an empty list assigns the group to no users, and an update replaces the complete assignment list..

Code Examples

cURL

curl -X POST \
  "https://spaces.nexudus.com/api/security/userroles" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": ""
}'

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the userrole was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "UserRole was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

A summary of the validation error(s), in the format PropertyName: error message.

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}