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_legacy, cyberark, laps, thycotic}	yes	Immutable
login	string	If `type` == `laps` \|\| `thycotic`
secret	string	If `type` == `laps` \|\| `thycotic`	Protected
tls_certificate	string
cyberark_legacy_account_fmt	string	If `type` == `cyberark_legacy`
cyberark_application_id	string	If `type` == `cyberark_legacy` \|\| `cyberark`
cyberark_safe	string	If `type` == `cyberark`
thycotic_secret_fmt	string	If `type` == `tyhotic`
base_dn	string	If `type` == `laps`
identity_cert	string
identity_key	string		Protected
created_at	string		Read-only
modified_at	string		Read-only
removed	string		Read-only

Request for retrieving available attributes of the PassvnModel

Method	GET
Path	/api/v2/objspec/passvn

Note

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

The next chapter describes procedures for creating separate requests.

Creating external password repository¶

Request

Method	POST
Path	/api/v2/passvn
Headers	Content-Type: Application/JSON
Body	PassvnModel

Example request

Sending POST https://10.0.0.0/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"
    }
}

Retrieving external password repositories list¶

Request

Method	GET
Path	/api/v2/passvn

Example request

Sending GET https://10.0.0.0/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"
    }
]

Deleting 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

Sending PATCH https://10.0.0.0/api/v2/passvn/123456789012345679

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

Response

{
   "result": "success"
}