SCscanopy
Shares
internal

Verify share password

Changed on

Returns an access token for a password-protected share.

The returned token is an HS256 JWT tied to the share's current password hash; subsequent /topology calls send the token instead of the raw password. Changing the share password invalidates outstanding tokens.

post/api/v1/shares/public/{id}/verify

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/shares/public/{id}/verify
  • Auth
    none declared

Path parameters

idstring uuid required

Share ID

Request body text/plain

string required

Response

Password verified; access token issued

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • 6667308abb70Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 409094e80886Revision changes
    • breaking

      the response's property type changed from boolean to object for status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status