API v2: External Password Repositoryยถ

Fudo Enterprise supports external passwords repositories for managing passwords to monitored servers.


Data Structuresยถ

PassvnModelยถ

Attribute

Type

Required

Description

id

string

Unique, read-only object identifier.

name

string

yes

Unique, case insensitive object name

url

string

yes

URL to the passwords serverโ€™s API

type

string {cyberark, laps, thycotic}

yes

Immutable

login

string

If type == laps || thycotic

secret

string

If type == laps || thycotic

Protected

tls_certificate

string

Value format: x509-certificate

cyberark_application_id

string

If type == cyberark

cyberark_safe

string

If type == cyberark

thycotic_secret_fmt

string

If type == thyhotic

base_dn

string

If type == laps

identity_certificate

string

Value format: x509-certificate

identity_key

string

Protected. Value format: private-key

identity_key_passphrase

string

If identity_key is set

Protected. Passphrase to use to decrypt private key.

created_at

datetime

Read-only

modified_at

datetime

Read-only

removed

string

Read-only

Retrieve Available Attributes of the PassvnModelยถ

Request

Method

GET

Path

/api/v2/objspec/passvn

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.


Create External Password Repositoryยถ

Request

Method

POST

Path

/api/v2/passvn

Headers

Content-Type: Application/json

Body

PassvnModel

Example Request

POST /api/v2/passvn`

{
    "type": "laps",
    "name": "LAPS Test Name 2",
    "url": "ldaps://10.2.0.1:8636/",
    "login": "cn=admin,dc=fudosecurity,dc=lab",
    "secret": "passwordExample",
    "base_dn": "dc=fudosecurity,dc=lab"
}

Response

{
    "result": "success",
    "passvn": {
        "id": "123456789012345678"
    }
}

Get External Password Repositories Listยถ

Request

Method

GET

Path

/api/v2/passvn

Example Request

GET /api/v2/passvn`


Response

"result": "success",
"passvn": [
    {
        "id": "123456789012345679",
        "name": "LDAP Test Name",
        "url": "ldaps://10.2.0.100:8636/",
        "type": "laps",
        "login": "cn=admin,dc=fudosecurity,dc=lab",
        "base_dn": "dc=fudosecurity,dc=lab",
        "created_at": "2023-06-16 02:53:08.930597-07",
        "modified_at": "2023-06-16 02:53:08.930597-07"
    }
]

Get Information About External Password Repository byย IDยถ

Request

Method

GET

Path

/api/v2/passvn/<id>

Example Request

GET /api/v2/passvn/<id>`


Response

"result": "success",
"passvn": [
    {
        "id": "123456789012345679",
        "name": "LDAP Test Name",
        "url": "ldaps://10.2.0.100:8636/",
        "type": "laps",
        "login": "cn=admin,dc=fudosecurity,dc=lab",
        "base_dn": "dc=fudosecurity,dc=lab",
        "created_at": "2023-06-16 02:53:08.930597-07",
        "modified_at": "2023-06-16 02:53:08.930597-07"
    }
]

Delete an External Password Repository Definitionยถ

Request

Method

DELETE

Path

/api/v2/passvn/<id>

Changing External Password Repository Configurationยถ

Request

Method

PATCH

Path

/api/v2/passvn/<id>

Headers

Content-Type: Application/json

Body

PassvnModel

Example Request

PATCH /api/v2/passvn/<id>`

{
   "login": "cn=admin,dc=fudosecurity,dc=com",
   "base_dn": "dc=fudosecurity,dc=com"
}

Response

{
   "result": "success"
}