UserRoles

Endpoint for managing Roles

Get all usersRoles in the tenant

get
Authorizations
Responses
200
OK
get
GET /v1/Roles HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Created": "2025-06-27T08:32:16.592Z",
    "LastModified": "2025-06-27T08:32:16.592Z",
    "CreatedBy": "text",
    "LastModifiedBy": "text",
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "PermissionSetup": {
      "AssignedPermissions": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  }
]

Creates a new user role

post
Authorizations
Body
Uidstring · uuidOptional
Namestring | nullableOptional
Responses
200
OK
post
POST /v1/Roles HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 143

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "PermissionSetup": {
    "AssignedPermissions": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}
No content

Updates an existing role

put
Authorizations
Body
Uidstring · uuidOptional
Namestring | nullableOptional
Responses
200
OK
put
PUT /v1/Roles HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 143

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "PermissionSetup": {
    "AssignedPermissions": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}
No content

Returns a single userRoles from the tenant

get
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
get
GET /v1/Roles/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Created": "2025-06-27T08:32:16.592Z",
  "LastModified": "2025-06-27T08:32:16.592Z",
  "CreatedBy": "text",
  "LastModifiedBy": "text",
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "PermissionSetup": {
    "AssignedPermissions": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Deletes an existing role

delete
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
delete
DELETE /v1/Roles/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousUserGroupNextUsers