UserRoles

Endpoint for managing Roles

Get all usersRoles in the tenant

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

Createdstring · date-timeOptional

LastModifiedstring · date-timeOptional

CreatedBystring · nullableOptional

LastModifiedBystring · nullableOptional

Uidstring · uuidOptional

Namestring · nullableOptional

404

Not Found

application/json

get/v1/Roles

HTTPcURLJavaScriptPython

GET /v1/Roles HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Created": "2026-08-07T13:01:11.017Z",
    "LastModified": "2026-08-07T13:01:11.017Z",
    "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

ApiKey

AuthorizationstringRequired

Body

application/json

Uidstring · uuidOptional

Namestring · nullableOptional

Responses

200

OK

No content

404

Not Found

application/json

post/v1/Roles

HTTPcURLJavaScriptPython

POST /v1/Roles HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/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

ApiKey

AuthorizationstringRequired

Body

application/json

Uidstring · uuidOptional

Namestring · nullableOptional

Responses

200

OK

No content

404

Not Found

application/json

put/v1/Roles

HTTPcURLJavaScriptPython

PUT /v1/Roles HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/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

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

application/json

Createdstring · date-timeOptional

LastModifiedstring · date-timeOptional

CreatedBystring · nullableOptional

LastModifiedBystring · nullableOptional

Uidstring · uuidOptional

Namestring · nullableOptional

404

Not Found

application/json

get/v1/Roles/{uid}

HTTPcURLJavaScriptPython

GET /v1/Roles/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Created": "2026-08-07T13:01:11.017Z",
  "LastModified": "2026-08-07T13:01:11.017Z",
  "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

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/json

delete/v1/Roles/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/Roles/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content