credentialPath

Get all credential paths

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

The page number for which to get credential paths. 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

400

Bad request

403

Forbidden access

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

Create credential path

Securityapi_key
Request
Request Body schema: application/json
required

The credential path to create

credentialPathName
string <= 255 characters

The name of the credential path.

description
string <= 1024 characters

The description of the credential path.

passwordVaultId
integer <int32>

The ID of the password vault which contains this credential path.

credentialParameters
object

The parameters for this credential path.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/credential-paths
Request samples
application/json
{
  • "credentialPathName": "ExampleCredentialPath",
  • "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  • "passwordVaultId": 5,
  • "credentialParameters": {
    }
}
Response samples
application/json
{
  • "credentialPathName": "ExampleCredentialPath",
  • "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  • "passwordVaultId": 5,
  • "credentialParameters": {
    }
}

Get credential path by ID

Securityapi_key
Request
path Parameters
credentialPathId
required
integer <int32>

The ID of the credential path to get

Responses
200

Success

403

Forbidden access

404

Not found

get/credential-paths/{credentialPathId}
Response samples
application/json
{
  • "credentialPathName": "ExampleCredentialPath",
  • "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  • "passwordVaultId": 5,
  • "credentialParameters": {
    }
}

Update credential path by ID

Securityapi_key
Request
path Parameters
credentialPathId
required
integer <int32>

The ID of the credential path to update

Request Body schema: application/json
required

The updated credential path

credentialPathName
string <= 255 characters

The name of the credential path.

description
string <= 1024 characters

The description of the credential path.

passwordVaultId
integer <int32>

The ID of the password vault which contains this credential path.

credentialParameters
object

The parameters for this credential path.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

put/credential-paths/{credentialPathId}
Request samples
application/json
{
  • "credentialPathName": "ExampleCredentialPath",
  • "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  • "passwordVaultId": 5,
  • "credentialParameters": {
    }
}
Response samples
application/json
{
  • "credentialPathName": "ExampleCredentialPath",
  • "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  • "passwordVaultId": 5,
  • "credentialParameters": {
    }
}

Delete credential path by ID

Securityapi_key
Request
path Parameters
credentialPathId
required
integer <int32>

The ID of the credential path to delete

Responses
200

Success

403

Forbidden access

404

Not found

409

Conflict

delete/credential-paths/{credentialPathId}
➔ Next to configuration