PX-Backup Roles (1.0.0)

Download OpenAPI specification:Download

General

Create Role

header Parameters

Content-Type

string

Value: "application/json"

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"org_id": "default",
"description": "test",
"rules": [{"apis": ["inspect*",
"enumerate*"
],
"services": ["schedulepolicy",
"rules",
"role"
]
},
{"apis": ["*"
],
"services": ["cloudcredential",
"backuplocation"
]
}
],
"name": "test"
}

Update Role

header Parameters

Content-Type

string

Value: "application/json"

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"org_id": "default",
"description": "test",
"rules": [{"apis": ["inspect*",
"enumerate*"
],
"services": ["rules",
"role"
]
},
{"apis": ["*"
],
"services": ["cloudcredential",
"schedulepolicy",
"backuplocation"
]
}
],
"name": "test",
"uid": "8969c259-c1b5-4eb0-af26-04ea556076bf",
"role_id": "7936e937-2fd2-422b-b9da-820f52ea5d89"
}

List Roles

query Parameters

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

Responses

Delete Role

query Parameters

org_id	string
name	string
role_id	string

Responses

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

Payload

Content type

application/json

{"roles": [{"id": "41ba5fb0-66b2-48ac-a986-9714b4a4498f",
"name": "test"
}
]
}

unmap role from user

query Parameters

user_id	string
role_id	string
role_name	string