Create a generic Vault Account.

post

https://techcomcloudpra.qabeyondtrustcloud.com/api/config/v1/vault/account

Adds a new username / password account, SSH account or X.509 account. Windows local and domain accounts cannot be added via this API.

The request body must either be a VaultUsernamePasswordAccount, VaultTokenAccount, VaultSSHAccount, VaultX509ImportedCAAccount, VaultX509GeneratedCAAccount, or VaultX509ClientAccount resource.

After an account is added via the API, the Vault Account Activity Report shows an "Account Created" event for that account. The "User" column shows the name of the API Account that created the account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

New account properties.

type

string

enum

required

Allowed:

name

string

required

length between 1 and 255

The name of the Account.

username

string

required

length between 1 and 255

The username that will be injected and/or checked out.

password

string

required

length between 1 and 255

The password that will be injected and/or checked out.

description

string

length ≤ 4096

The Account's description.

account_group_id

int32

1 to 2147483647

Defaults to 1

The unique identifier the Vault Account Group. The account_group_id defaults to 1, which is the default Account Group.

account_policy

string | null

The code name of the Account Policy associated with the account. When the value is null, the account policy is inherited from the account group. If there is no account group, it is inherited from the global default.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Indicates the account was created successfully and contains the new account instance. The Location header contains the URL of the account.

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.