The Password API is implemented via the Password Authenticator Plugin. REST APIs provided by plugins are currently considered Experimental, and as such this interface may change without notice between minor releases. |
|
Add a new Password.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| NewObjectResponse with | Password created |
| Password Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| Unknown error |
Remove a Password.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| Password deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit an existing Password.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| Password updated | |
| Password Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
|
| |
| Unknown error |
Retrieve all existing Passwords.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| Passwords returned | |
| Authentication required | |
| Unknown error |
Retrieve all existing Passwords for a specified CO.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| Passwords returned | |
| Authentication required | |
404 CO Unknown | id not found | |
| Unknown error |
Retrieve all existing Passwords for the specified CO Person.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| Password returned | |
| Authentication required | |
|
| |
| Unknown error |
Retrieve an existing Password.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| Password returned | |
| Authentication required | |
|
| |
| Unknown error |