session

Revoke active keys for this user and return a newly minted raw key.

Args: request (Any): Request passed to this helper.

Returns: Any: Value produced by this call (type depends on inputs).

Examples:

user_api_key_rotate(None) # doctest: +SKIP

post/api/user-api-key/rotate/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in cookie sessionid
    • none

Response

usernamestring required
raw_keystring nullable
key_prefixstring required

Changes

No recorded changes to this operation across all 31 revisions of this API.