Page tree
Skip to end of metadata
Go to start of metadata

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

POST

URL

/password_authenticator/passwords.<format>

Request Body

Password Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of Password

Password created

400 Bad Request


Password Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

500 Other Error


Unknown error


Delete

Remove a Password.

Request Format

Method

DELETE

URL

/password_authenticator/passwords/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


Password deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 Password Unknown


id not found

500 Other Error


Unknown error


Edit

Edit an existing Password.

Request Format

Method

PUT

URL

/password_authenticator/passwords/<id>.<format>

Request Body

Password Request

Response Format

HTTP Status

Response Body

Description

200 OK


Password updated

400 Bad Request


Password Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

404 Password Unknown


id not found

500 Other Error


Unknown error


View (all)

Retrieve all existing Passwords.

Request Format

Method

GET

URL

/password_authenticator/passwords.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

Password Response

Passwords returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error


View (per CO Person)

Retrieve all existing Passwords for the specified CO Person.

Request Format

Method

GET

URL

/password_authenticator/passwords.<format>?copersonid=<id>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

Password Response

Password returned

401 Unauthorized


Authentication required

404 Password Unknown


id not found

500 Other Error


Unknown error


View (one)

Retrieve an existing Password.

Request Format

Method

GET

URL

/password_authenticator/passwords/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

Password Response

Password returned

401 Unauthorized


Authentication required

404 Password Unknown


id not found

500 Other Error


Unknown error


Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels