Jump to Content
Documentation
API Reference
Release Notes
v1
v25.1
v25.2
v25.3
v25.4
v25.5
v25.6
v25.7
v25.8
API Reference
v25.8
Documentation
API Reference
Release Notes
Downloads Policy Revision
All
Pages
Start typing to search…
JUMP TO
BeyondTrust PM Cloud Management API - Version 3
AcceptedDomains
Retrieves list of Accepted Domains
get
Creates Accepted Domain
post
Deletes Accepted Domain
del
Retrieves Record of Accepted Domain
get
Modifies Accepted Domain
put
ActivityAudits
Retrieves list of Activity Audits with pagination (sorting and filtering)
get
Retrieves Record of Activity Audit
get
Retrieves list of Details of Activity Audits with pagination (sorting and filtering)
get
AdminAccessRequest
Updates an Admin Access Request decision which can be approved or denied
post
Creates an Admin Access Request on behalf of a user, if the properties "decision", "decisionTime", "decisionPerformedByUser" are included with the right values an approved request is created.
post
Retrieves the list of Authorization Request with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request
get
AppSwitcher
/v3/AppSwitcher/connector
post
AuthorizationRequest
Handle URM ticket notifications
post
Retrieves the list of Authorization Request with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request
get
AuthorizationRequestAudits
Retrieves the list of Authorization Request Audit with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request Audit
get
Computers
Retrieves the list of Computers with pagination (sorting and filtering). Sort by Created Date, Ascending to avoid returning duplicate entries.
get
Deletes Computers
del
Retrieves a detail of the Computer
get
Authorises Computers
post
Deactivate Computer functionality no longer exists To mimic the functionailty as closely as possible, this will now archive and delete the computer.
post
Request to Renew Computer Certificate
post
Rejects Computers
post
Retrieves Computer Logs
post
Retrieves Computer Status Info
post
Gets Computer Command Logs List
get
Gets Computer Logs
get
Downloads Computer Log
get
Archive Computer
post
Unarchive Computer
post
Archive Computers
post
Unarchive Computers
post
File
Get the API definition file in YAML format
get
GlobalRoles
Retrieves the list of Global Roles with pagination, sorting and filtering.
get
Retrieves the details of a global role.
get
Groups
Retrieves the list of Groups with pagination (sorting and filtering)
get
Creates Group
post
Modifies Group
put
Deletes group
del
Retrieves a detail of the group
get
Marks group as default
patch
Auto assign policy revision to the group
post
Assigns policy revision to the group
post
Assigns policy revision to multiple group
post
Clears policy from group
patch
Clears policy from groups
post
Unassigns computers from the groups
post
assigns computers to the group
post
assigns computers to the group by input of csv file
post
Policies
Retrieve list of Policies with pagination (sorting and filtering)
get
Creates new policy with provided file
post
Deletes policy
del
Retrieves a detail of the policy
get
Request to update policy properties
put
Reverts and discards policy changes
patch
Downloads Latest Policy Revision
get
Retrieves list of policy revisions
get
Retrieves list of Groups that are assigned to Policy
get
Downloads Policy Revision
get
Upload New Policy Revision
post
PolicyEditor
Retrieves a list of applications for the specified policy, filtered by the provided application group and application criteria.
get
Create, delete applications within application groups in a specified policy. To update an existing application in the policy, first use the DELETE endpoint to remove the current application, then use the CREATE endpoint to add the updated version. Supported application types for creation: bat, cpl, exe, msc, msi, ps1, reg, rpsc, rpss, unex, wsh. Unsupported application types for creation: ocx, com, svc, appx, unin(will not be supported in the future), dll, cont.
post
Roles
Retrieve list of Roles
get
Retrieve role details
get
Tasks
Retrieves a detail of the Task
get
Users
Retrieves the list of Users with pagination (sorting and filtering)
get
Creates user and assigns customized permissions or roles.
post
/v3/Users/{id}
get
Modifies User
put
Assign Roles to User
post
Disables User
patch
Enables User
patch
Modifies User Preferences
put
Resends invitation email to User
patch
About
Retrieve version
get
ApiAccounts
Retrieves list of Api Accounts
get
AuthenticationProvider
Retrieves a detail of the configures authentication provider
get
Events
Gets the list of events by start date
get
Gets the list of events by Filters
get
ScimResourceTypes
gets types of resources available
get
gets user endpoint configurations
get
gets roles configuration
get
ScimRoles
/scim/v3/Roles
get
ScimSchemas
Get the Schema supported by the SCIM Api
get
ScimServiceProviderConfig
gets the Json structure available
get
ScimUsers
List V3
get
Create the user using SCIM protocol
post
Get User V3
get
Patch operation
patch
Modify a user
put
BeyondTrust PM Cloud Management API - Version 2
AcceptedDomains
Retrieves list of Accepted Domains
get
Creates Accepted Domain
post
Deletes Accepted Domain
del
Retrieves Record of Accepted Domain
get
Modifies Accepted Domain
put
ActivityAudits
Retrieves list of Activity Audits with pagination (sorting and filtering)
get
Retrieves Record of Activity Audit
get
Retrieves list of Details of Activity Audits with pagination (sorting and filtering)
get
AdminAccessRequest
Updates an Admin Access Request decision which can be approved or denied
post
Creates an Admin Access Request on behalf of a user, if the properties "decision", "decisionTime", "decisionPerformedByUser" are included with the right values an approved request is created.
post
Retrieves the list of Authorization Request with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request
get
AppSwitcher
/v2/AppSwitcher/connector
post
AuthorizationRequest
Handle URM ticket notifications
post
Retrieves the list of Authorization Request with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request
get
AuthorizationRequestAudits
Retrieves the list of Authorization Request Audit with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request Audit
get
Computers
Retrieves the list of Computers with pagination (sorting and filtering). Sort by Created Date, Ascending to avoid returning duplicate entries.
get
Deletes Computers
del
Retrieves a detail of the Computer
get
Authorises Computers
post
Deactivate Computer functionality no longer exists To mimic the functionailty as closely as possible, this will now archive and delete the computer.
post
Request to Renew Computer Certificate
post
Rejects Computers
post
Retrieves Computer Logs
post
Retrieves Computer Status Info
post
Gets Computer Command Logs List
get
Gets Computer Logs
get
Downloads Computer Log
get
Archive Computer
post
Unarchive Computer
post
Archive Computers
post
Unarchive Computers
post
File
Get the API definition file in YAML format
get
GlobalRoles
Retrieves the list of Global Roles with pagination, sorting and filtering.
get
Retrieves the details of a global role.
get
Groups
Retrieves the list of Groups with pagination (sorting and filtering)
get
Creates Group
post
Modifies Group
put
Deletes group
del
Retrieves a detail of the group
get
Marks group as default
patch
Auto assign policy revision to the group
post
Assigns policy revision to the group
post
Assigns policy revision to multiple group
post
Clears policy from group
patch
Clears policy from groups
post
Unassigns computers from the groups
post
assigns computers to the group
post
assigns computers to the group by input of csv file
post
Policies
Retrieve list of Policies with pagination (sorting and filtering)
get
Creates new policy with provided file
post
Deletes policy
del
Retrieves a detail of the policy
get
Request to update policy properties
put
Reverts and discards policy changes
patch
Downloads Latest Policy Revision
get
Retrieves list of policy revisions
get
Retrieves list of Groups that are assigned to Policy
get
Downloads Policy Revision
get
Upload New Policy Revision
post
Roles
Retrieve list of Roles
get
Retrieve role details
get
Tasks
Retrieves a detail of the Task
get
Users
Retrieves the list of Users with pagination (sorting and filtering)
get
Creates User
post
Retrieves a detail of the User
get
Modifies User
put
Assign Roles to User
post
Disables User
patch
Enables User
patch
Modifies User Preferences
put
Resends invitation email to User
patch
About
Retrieve version
get
ApiAccounts
Retrieves list of Api Accounts
get
AuthenticationProvider
Retrieves a detail of the configures authentication provider
get
Events
Gets the list of events by start date
get
Gets the list of events by Filters
get
ScimResourceTypes
gets types of resources available
get
gets user endpoint configurations
get
gets roles configuration
get
ScimRoles
/scim/v2/Roles
get
ScimSchemas
Get the Schema supported by the SCIM Api
get
ScimServiceProviderConfig
gets the Json structure available
get
ScimUsers
/scim/v2/users
get
Create the user using SCIM protocol
post
/scim/v2/users/{userID}
get
Modify a user
put
Patch operation
patch
BeyondTrust PM Cloud Management API - Version 1
AcceptedDomains
Retrieves list of Accepted Domains
get
Creates Accepted Domain
post
Deletes Accepted Domain
del
Retrieves Record of Accepted Domain
get
Modifies Accepted Domain
put
ActivityAudits
Retrieves list of Activity Audits with pagination (sorting and filtering)
get
Retrieves Record of Activity Audit
get
Retrieves list of Details of Activity Audits with pagination (sorting and filtering)
get
AdminAccessRequest
Updates an Admin Access Request decision which can be approved or denied
post
Creates an Admin Access Request on behalf of a user, if the properties "decision", "decisionTime", "decisionPerformedByUser" are included with the right values an approved request is created.
post
Retrieves the list of Authorization Request with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request
get
AppSwitcher
/v1/AppSwitcher/connector
post
AuthorizationRequest
Handle URM ticket notifications
post
Retrieves the list of Authorization Request with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request
get
AuthorizationRequestAudits
Retrieves the list of Authorization Request Audit with pagination (sorting and filtering)
get
Retrieves Record of Authorization Request Audit
get
Computers
Retrieves the list of Computers with pagination (sorting and filtering). Sort by Created Date, Ascending to avoid returning duplicate entries.
get
Deletes Computers
del
Retrieves a detail of the Computer
get
Authorises Computers
post
Deactivate Computer functionality no longer exists To mimic the functionailty as closely as possible, this will now archive and delete the computer.
post
Request to Renew Computer Certificate
post
Rejects Computers
post
Retrieves Computer Logs
post
Retrieves Computer Status Info
post
Gets Computer Command Logs List
get
Gets Computer Logs
get
Downloads Computer Log
get
File
Get the API definition file in YAML format
get
Groups
Retrieves the list of Groups with pagination (sorting and filtering)
get
Creates Group
post
Modifies Group
put
Deletes group
del
Retrieves a detail of the group
get
Marks group as default
patch
Auto assign policy revision to the group
post
Assigns policy revision to the group
post
Assigns policy revision to multiple group
post
Clears policy from group
patch
Clears policy from groups
post
Unassigns computers from the groups
post
assigns computers to the group
post
assigns computers to the group by input of csv file
post
Policies
Retrieve list of Policies with pagination (sorting and filtering)
get
Creates new policy with provided file
post
Deletes policy
del
Retrieves a detail of the policy
get
Request to update policy properties
put
Reverts and discards policy changes
patch
Downloads Latest Policy Revision
get
Retrieves list of policy revisions
get
Retrieves list of Groups that are assigned to Policy
get
Downloads Policy Revision
get
Upload New Policy Revision
post
Roles
Retrieve list of Roles
get
Retrieve role details
get
Tasks
Retrieves a detail of the Task
get
Users
Retrieves the list of Users with pagination (sorting and filtering)
get
Creates User
post
Retrieves a detail of the User
get
Modifies User
put
Assign Role to User
post
Disables User
patch
Enables User
patch
Modifies User Preferences
put
Resends invitation email to User
patch
Events
Gets the list of events by start date
get
Gets the list of events by Filters
get
ScimResourceTypes
gets types of resources available
get
gets user endpoint configurations
get
gets roles configuration
get
ScimRoles
/scim/v1/Roles
get
ScimSchemas
Get the Schema supported by the SCIM Api
get
ScimServiceProviderConfig
gets the Json structure available
get
ScimUsers
/scim/v1/users
get
Create the user using SCIM protocol
post
/scim/v1/users/{userID}
get
Modify a user
put
Patch operation
patch
Powered by
Downloads Policy Revision
get
