Using Basic Authentication

To use HTTPS Basic Authentication, attach an Authorization header formatted so:

Authorization: Basic bXkuZW1haWwuYWRkcmVzc0BvcGVuZGF0YWtpdC5vcmc6bXkucGFzc3dvcmQ=

As given by the standard, the text following the Basic marker here is a base64 encoding of the credentials, provided in the form email:password (in this example my.email.address@getodk.org:my.password).

Because the colon symbol (":") is used as a separator, authenticating using an email address containing a colon is not possible. This is a general limitation of this authentication method; it is not specific to ODK Central.

Unlike the standard, we do not require the client to first send an unauthenticated request and retry the request only after receiving a WWW-Authenticate response, and in fact we will never send the WWW-Authenticate header. This is mostly because, as noted above, we generally discourage the use of this authentication method, and would rather not advertise its use openly. As a result, if you wish to use Basic Authentication, directly supply the header on any request that needs it.

(There is not really anything at /v1/example2; this section only demonstrates how generally to use Basic Authentication.)