passwordVault

Get all password vaults

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get password vaults. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

403

Forbidden access

404

Not found

get/password-vaults
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create password vault

Securityapi_key
Request
Request Body schema: application/json
required

The password vault to create

name
string <= 255 characters

The name of the password vault. This must be unique across all password vaults on the engine.

vaultType
string
Default: "HASHICORP"

The type of password vault. Currently, HASHICORP, CYBERARK and GCP are supported.

Enum: "CYBERARK" "HASHICORP" "GCP" "AZURE"
configJson
object

The configuration properties used to connect to the password vault.

description
string <= 1024 characters

The description of the password vault.

Responses
201

Success

400

Bad request

403

Forbidden access

post/password-vaults
Request samples
application/json
{
  • "name": "SampleVault",
  • "vaultType": "HASHICORP",
  • "configJson": {
    },
  • "description": "This password vault is used as an API example."
}
Response samples
application/json
{
  • "name": "SampleVault",
  • "vaultType": "HASHICORP",
  • "configJson": {
    },
  • "description": "This password vault is used as an API example."
}

Get password vault by ID

Securityapi_key
Request
path Parameters
passwordVaultId
required
integer <int32>

The ID of the password vault to get

Responses
200

Success

403

Forbidden access

404

Not found

get/password-vaults/{passwordVaultId}
Response samples
application/json
{
  • "name": "SampleVault",
  • "vaultType": "HASHICORP",
  • "configJson": {
    },
  • "description": "This password vault is used as an API example."
}

Update password vault by ID

Securityapi_key
Request
path Parameters
passwordVaultId
required
integer <int32>

The ID of the password vault to update

Request Body schema: application/json
required

The updated password vault

name
string <= 255 characters

The name of the password vault. This must be unique across all password vaults on the engine.

vaultType
string
Default: "HASHICORP"

The type of password vault. Currently, HASHICORP, CYBERARK and GCP are supported.

Enum: "CYBERARK" "HASHICORP" "GCP" "AZURE"
configJson
object

The configuration properties used to connect to the password vault.

description
string <= 1024 characters

The description of the password vault.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/password-vaults/{passwordVaultId}
Request samples
application/json
{
  • "name": "SampleVault",
  • "vaultType": "HASHICORP",
  • "configJson": {
    },
  • "description": "This password vault is used as an API example."
}
Response samples
application/json
{
  • "name": "SampleVault",
  • "vaultType": "HASHICORP",
  • "configJson": {
    },
  • "description": "This password vault is used as an API example."
}

Delete password vault by ID

Securityapi_key
Request
path Parameters
passwordVaultId
required
integer <int32>

The ID of the password vault to delete

Responses
200

Success

403

Forbidden access

404

Not found

delete/password-vaults/{passwordVaultId}
➔ Next to plugin