...
You can access the /credentials collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
When requesting a credentials details via the API, the credentials section will be decrypted.
API Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes | Example Response |
---|---|---|---|---|---|---|
GET | n | collection | /credentials | Returns a list of credentials. | credentials_collection.json | |
GET | y | read | /credentials/{id} | Returns a credentials details. | credentials_read.json | |
PATCH | y | update | /credentials/{id} | Update an attribute of a credentials entry. | ||
POST | n | create | /credentials | Insert a new credentials entry. | ||
DELETE | y | delete | /credentials/{id} | Delete a credentials entry. |
Web Application Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
---|---|---|---|---|---|
GET | n | create | create_form | /credentials/create | Displays a standard web form for submission to POST /credentials. |
GET | y | update | update_form | /credentials/{id}/update | Show the script details with the option to update attributes using PATCH to /credentials/{id} |