Get one UserRole

Retrieve a single UserRole record by its Id.

GET /api/security/userroles/{id}

Get one UserRole

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/security/userroles/{id} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "Roles": [
    123
  ],
  "Users": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

Path Parameters

id · integer · required

The Id of the UserRole record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/security/userroles/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

BusinessId · integer

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..

BusinessName · string

Display value for Business.Name..

Name · string

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

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..

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "Roles": [],
  "Users": [],
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "UserRole Example",
  "LocalizationDetails": null,
  "CustomFields": null
}