kythene.v1.KytheneService

CreateShareCode

CreateShareCode mints a share code for a tag (a label or a project). The holder is admitted to that tag's collections in the anonymous view and may comment/approve as label. Internal tags cannot have share codes.

post/kythene.v1.KytheneService/CreateShareCode

Request

  • Base URL: https://kythene.com (the document declares no server; this is the origin it was published from)
  • URL: https://kythene.com/kythene.v1.KytheneService/CreateShareCode
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

tagstring

tag is the tag (a label or a project) to mint the code for - an id, or a name in the acting space. A share code admits its holder to that tag's collections; internal tags cannot have share codes.

labelstring

label records who the code is for (required) - it identifies the holder's comments and approvals.

expiresDaysinteger

expires_days time-boxes the code: after this many days it stops admitting, so a leaked link does not stay live until someone remembers to revoke it. 0 (the default) means it never expires.

pinstring

pin optionally sets a second-factor PIN on the code (#364): the link admits only after the holder also enters this PIN, sent by a different channel. 4-8 digits, not an obvious sequence. Empty (the default) means no PIN. Never returned after creation. It can be added or changed later with set_share_pin.

spacestring

space optionally selects which of your spaces to act in (an id or name from list_spaces). Omit it when you belong to a single space.

Response

Success

Example response

{
  "shareCode": {
    "createdAt": "2023-01-15T01:30:15.01Z",
    "expiresAt": "2023-01-15T01:30:15.01Z"
  }
}

Changes

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