kythene.v1.KytheneService

SetTagPassword

SetTagPassword sets (or, with an empty password, clears) a tag's anonymous-view password: holders of the password can read that tag's collections at its public link without an account. Refuses internal tags and private projects. This is the password counterpart to a share code - the password admits anyone who has it; a share code admits one labelled holder.

post/kythene.v1.KytheneService/SetTagPassword

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/SetTagPassword
  • 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 to set the password on - an id, or a name in the acting space.

passwordstring

password is the secret anonymous viewers must enter to read the tag's collections. An EMPTY password CLEARS it (the tag stops admitting by password). A share code, if any, is a separate mechanism and is unaffected.

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

Changes

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