nooks
GitHubInstall
Sessions and passwords

Replace password

ReplacePassword sets a new password for the signed-in Member. A Member who was given a temporary password must call this before they can use nooks.

POST
/api/v1/auth/password

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/auth/password" \  -H "Content-Type: application/json" \  -d '{}'
{  "member": {    "uid": "string",    "name": "string",    "email": "string",    "role": "ROLE_UNSPECIFIED",    "mustChangePassword": true,    "createdAt": "string",    "lastSignedInAt": "string"  }}

Refresh access

RefreshAccess exchanges the refresh cookie for a new access token. The refresh token is read from the cookie and never appears in a request or a response body: the credential that lasts a month is not one a caller should be able to copy out of a log.

Request join

RequestJoin asks an Admin for an account. Every account begins this way: the request waits in Activity until an Admin approves it and hands over a temporary password. Refused where the Instance has signup off; where it is on, anybody who can reach the Instance may ask and the approval is what decides. One request may wait per email address, and the queue of waiting requests has a ceiling. Asking again under an address already waiting reports success and writes nothing; asking when the queue is full is refused until an Admin has cleared some.