Access

Generated access operations.

POST/v1/access/invitations/acceptRun access invitations acceptsession

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: post_access_invitations_accept
Max body: 64 KiB

Request body application/json · required

Example

{
  "code": "string",
  "name": "Fargo",
  "password": "string",
  "username": "Fargo"
}

Schema

codestringrequiredlength 32–128
namestring
passwordstringrequired
usernamestringrequired

Responses

201Successapplication/json

Example

{
  "accountId": "id_8h2k4q",
  "allowedLibraries": [
    "string"
  ],
  "profileId": "id_8h2k4q",
  "role": "string",
  "username": "Fargo",
  "variant": "accepted"
}

Schema

accountIdstringrequired
allowedLibrariesarray of stringrequired
profileIdstringrequired
rolestringrequired
usernamestringrequired
variant"accepted"required

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundsign_in_kind_localsign_in_kind_porticofactor_setup_requiredinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/access/invitations/accept" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","name":"Fargo","password":"string","username":"Fargo"}'

POST/v1/access/invitations/previewPreview an invitation without consuming its codesession

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: preview_invitation
Max body: 4 KiB

Request body application/json · required

Example

{
  "code": "string"
}

Schema

codestringrequiredlength 32–128

Responses

200Successapplication/json

Example

{
  "allLibraries": true,
  "expiresAt": "2026-10-18T19:30:00Z",
  "forPorticoAccount": true,
  "inviterUsername": "Fargo",
  "libraries": [
    {
      "kind": "string",
      "name": "Fargo"
    }
  ],
  "libraryCount": 0,
  "role": "string",
  "serverName": "Fargo",
  "signInMethod": "string"
}

Schema

allLibrariesbooleanrequired
expiresAtstringrequired
forPorticoAccountboolean
inviterUsernamestring
librariesarray of objectrequired
- kindstring
- namestringrequired
libraryCountintegerrequired
rolestringrequired
serverNamestringrequired
signInMethodstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvitation_not_foundrate_limitedinvalid_requestinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/access/invitations/preview" \
  -H "Content-Type: application/json" \
  -d '{"code":"string"}'