DocumentationAPI ReferenceRelease Notes
API Reference

Create functional account

post
https://example.com/beyondtrust/api/public/v3/functionalaccounts

Required Permission(s)

Any of the following:

  • Password Safe Account Management (Full control)
  • Password Safe Configuration Management (Full control)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The functional account configuration details

string | null

(required when Platform.RequiresSecret is false) Functional account password

string | null

(optional; can be set if Platform.DSSFlag is true) DSS private key

string | null

(required when PrivateKey is an encrypted DSS key) DSS passphrase. Can be set if Platform.DSSFlag is true

string | null

(required when Platform.RequiresSecret is true) Functional account secret

string | null

(required for Google functional accounts) Google Cloud Platform service account email

string | null

(required when Platform.RequiresAPIKey is true) Functional account API key

int32

Unique ID of functional account

int32

(required) ID of functional account platform

string | null

(optional) Domain name of functional account. Can be set if Platform.DomainNameFlag is true

string | null

(required) Name of functional account (does not include domain name)

string | null

(optional) Display name or alias for functional account. If not given, uses AccountName. Must be unique for platform

string | null

(optional) Description of functional account

string | null

Elevation command used for SSH connections (sudo, pbrun, pmrun). Can be set if Platform.SupportsElevationFlag is true

int32

Count of managed systems that reference functional account

string | null

(required when Platform.RequiresTenantID is true) TenantID of functional account

string | null

(required when Platform.RequiresObjectID is true) ObjectID of functional account

string | null

For an AzureAD functional account, "AzurePublic" or "AzureUsGovernment". For a non-AzureAD functional account, an empty string ""

string | null

(required for Entra ID accounts) Test Application (Client) ID

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 19 days ago

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

Updated 19 days 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.