User Role by ID

Prev Next
Get
/public/v1/user-management/user-roles/{id}

Retrieves a single user role by its unique identifier

Security

The requesting user must have the following permission to retrieve a user role:

  • Administration → Users → View User Roles & Permissions
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Path parameters
id
string (uuid) Required

The unique identifier of the user role to retrieve

Responses
200

User Role

object
id
string (uuid)

Unique identifier of the user role.

name
string

Display name of the user role.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.