access-requests

Prove the code and file the request (unauthenticated)

A correct code files an ExternalAccessRequest and notifies the deciders. Wrong-code feedback is safe here (the code went only to the address's holder) and bounded by a brute-force lockout (429 LOCKED). 400 INVALID_CODE otherwise; 429 RESOURCE_CAP at 25 pending external asks per resource. Requests expire after 14 days like internal ones.

post/public/access-requests/verify

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/public/access-requests/verify
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Request body

resourceType'PROJECT' | 'PAGE' | 'LIBRARY' | 'TABLE' required
resourceIdstring required
emailstring email required
codestring required

The 6-digit code from the email.

notestring

Response

{ requested: true, alreadyPending }

Changes

No recorded changes to this operation across all 1 revision of this API.