Skip to main content
API docs by Redocly

PX-Backup Roles (1.0.0)

Download OpenAPI specification:Download

General

Create Role

Create Role

header Parameters
Content-Type
string
Value: "application/json"
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "org_id": "default",
  • "description": "test",
  • "rules": [
    ],
  • "name": "test"
}

Update Role

Update Role

header Parameters
Content-Type
string
Value: "application/json"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "org_id": "default",
  • "description": "test",
  • "rules": [
    ],
  • "name": "test",
  • "uid": "8969c259-c1b5-4eb0-af26-04ea556076bf",
  • "role_id": "7936e937-2fd2-422b-b9da-820f52ea5d89"
}

List Roles

List Roles

query Parameters
searchString
string
page
integer <int32>
per_page
integer <int32>

Responses

Delete Role

Delete Role

query Parameters
org_id
string
name
string
role_id
string

Responses

Map role to user

Map role to user

query Parameters
user_id
string
header Parameters
Content-Type
string
Value: "application/json"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

unmap role from user

unmap role from user

query Parameters
user_id
string
role_id
string
role_name
string

Responses