Functional Accounts
Quick Navigation
- GET FunctionalAccounts
- GET FunctionalAccounts/{id}
- POST FunctionalAccounts
- DELETE FunctionalAccounts/{id}
GET FunctionalAccounts
Purpose
Returns a list of functional accounts.
Required Permissions
Password Safe Account Management (Read).
Request Body
None.
Response Body
Content-Type: application/json
[ { FunctionalAccountID : int, PlatformID : int, DomainName : string, AccountName : string, DisplayName : string, Description : string, ElevationCommand : string, SystemReferenceCount : int, TenantID : string, ObjectID : string }, … ]
Response Body Details
- PlatformID: ID of the platform to which the account belongs.
- DomainName: Domain name of the account.
- AccountName: Name of the account (does not include domain name).
- DisplayName: The display name or alias for the account.
- Description: Description of the account.
- ElevationCommand: Elevation command used for SSH connections (sudo, pbrun, pmrun).
- SystemReferenceCount: The count of managed systems that reference the functional account.
- TenantID: TenantID of the account (if applicable).
- ObjectID: ObjectID of the account (if applicable).
Response Codes
200 - Request successful. Functional account in the response body.
For more information, please see Common Response Codes.
GET FunctionalAccounts/{id}
Purpose
Returns a functional account by ID.
Required Permissions
Password Safe Account Management (Read).
URL Parameters
id: ID of the functional account.
Request Body
None.
Response Body
Content-Type: application/json
{ FunctionalAccountID : int, PlatformID: int, DomainName : string, AccountName : string, DisplayName : string, Description : string, ElevationCommand : string, SystemReferenceCount : int, TenantID : string, ObjectID : string }
Response Body Details
- PlatformID: ID of the platform to which the account belongs.
- DomainName: Domain name of the account.
- AccountName: Name of the account (does not include domain name).
- DisplayName: The display name or alias for the account.
- Description: Description of the account.
- ElevationCommand: Elevation command used for SSH connections (sudo, pbrun, pmrun).
- SystemReferenceCount: The count of managed systems that reference the functional account.
- TenantID: TenantID of the account (if applicable).
- ObjectID: ObjectID of the account (if applicable).
Response Codes
200 - Request successful. Functional Account in the response body.
For more information, please see Common Response Codes.
POST FunctionalAccounts
Purpose
Creates a functional account.
Required Permissions
Password Safe Account Management (Read/Write).
Request Body
Content-Type: application/json
{ PlatformID : int, DomainName : string, AccountName : string, DisplayName : string, Password : string, PrivateKey : string, Passphrase : string, Description : string, ElevationCommand : string, TenantID : string, ObjectID : string, Secret : string }
Request Body Details
- PlatformID: (required) ID of the platform to which the account belongs.
- DomainName: (optional) Domain name of the account. Can be set if Platform.DomainNameFlag is true. Max string length is 50.
- AccountName: (required) Name of the account (do not include domain name). Max string length is 245.
- DisplayName: (optional) The display name or alias for the account. If not given, uses the AccountName. Must be unique for the platform. Max string length is 100.
- Password: (required when Platform.RequiresSecret is false) The current account password.
- PrivateKey: (optional) DSS private key. Can be set if Platform.DSSFlag is true.
- Passphrase: (required when PrivateKey is an encrypted DSS key) DSS passphrase. Can be set if Platform.DSSFlag is true.
- Description: (optional) Description of the account. Max string length is 1000.
- ElevationCommand: (optional) Elevation command to use for SSH connections. Can be set if Platform.SupportsElevationFlag is true (sudo, pbrun, pmrun). Max string length is 80.
- TenantID: string (required when Platform.RequiresTenantID is true). Max string length is 36.
- ObjectID: string (required when Platform.RequiresObjectID is true). Max string length is 36.
- Secret: string: (required when Platform.RequiresSecret is true). Max string length is 255.
Response Body
Content-Type: application/json
{ FunctionalAccountID : int, PlatformID : int, DomainName : string, AccountName : string, DisplayName : string, Description : string, ElevationCommand : string, SystemReferenceCount : int, TenantID : string, ObjectID : string }
Response Body Details
- PlatformID: ID of the platform to which the account belongs.
- DomainName: Domain name of the account.
- AccountName: Name of the account (does not include domain name).
- DisplayName: The display name or alias for the account.
- Description: Description of the account.
- ElevationCommand: Elevation command used for SSH connections (sudo, pbrun, pmrun).
- SystemReferenceCount: The count of managed systems that reference the functional account.
- TenantID: TenantID of the account (if applicable).
- ObjectID: ObjectID of the account (if applicable).
Response Codes
201 - Request successful. Functional Account in the response body.
For more information, please see Common Response Codes.
DELETE FunctionalAccounts/{id}
Purpose
Deletes a functional account by ID.
Required Permissions
Password Safe Account Management (Read/Write).
Other Requirements
The functional account cannot be referenced by any managed systems.
URL Parameters
id: ID of the functional account.
Request Body
None.
Response Body
None.
Response Codes
200 - Request successful.
For more information, please see Common Response Codes.