Experimental
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.
Implementation Notes
- Only JSON format is supported. XML format is not supported.
- Note the URLs for this API use plugin syntax. (There is an extra component to the path.)
- Authenticators that are locked cannot be managed by the API.
Add
Add a new Password.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
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 |
Delete
Remove a Password.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| Password deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit
Edit an existing Password.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
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 |
View (all)
Retrieve all existing Passwords.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| Passwords returned | |
| Authentication required | |
| Unknown error |
View (per CO)
Retrieve all existing Passwords for a specified CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| Passwords returned | |
| Authentication required | |
404 CO Unknown | id not found | |
| Unknown error |
View (per CO Person)
Retrieve all existing Passwords for the specified CO Person.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| Password returned | |
| Authentication required | |
|
| |
| Unknown error |
View (one)
Retrieve an existing Password.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| Password returned | |
| Authentication required | |
|
| |
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_passwords model definition