DocumentationAPI ReferenceRelease Notes
API Reference

Create/Update Roles

post
https://{example.com}/api/pbul//rbp/roles

Create or update a role RBP entity for a host.

Multiple role{users,hosts,cmds,tmdates} entities can be passed and will replace all existing relationships for
this role if a list is provided for any of these entities. Not providing a list will leave those relationships
unchanged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The Host ID to perform this operation on

Body Params

Name without ID will overwrite or create new record depending on name; ID only will overwrite an existing record of the same ID or will error; passing in both will overwrite an existing record, renaming the entity with the new name.

RBPRole ties all other entities together to define a policy

string
auth
object

AuthenticationSettings is a model for configuring reauthentication. Reauthentication is a form of an additional second stage authentication, requiring a user to
supply something else when elevating with pbrun.

string
string
boolean
int64
string
string
string
string
int64
rolecmds
array of objects
length ≤ 500
rolecmds
rolehosts
array of objects
length ≤ 500
rolehosts
roletmdates
array of objects
length ≤ 500
roletmdates
roleusers
array of objects
length ≤ 500
roleusers
int64
int64
string
string
string
varmatch
object

RBPVarmatch represents the structure of a PMUL varmatch object that can be used to limit when a policy applies

string

WARN(elowry): ChangeManagementRequest should not exist on the frontend model in this state -- see TFS #160994

Responses

400

TextError An unknown error occured, details provided in body

Updated 1 day ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.