Sign in
tokens

update security server software token pin code

<h3>Administrator updates the software token pin code.</h3> <p>This operation supports updating the pin code of a software token only.</p> <p> This endpoint can also return metadata in the error response. The metadata array can contain error messages about why the init did not succeed. If the pin code is too weak, the error code <code>weak_pin</code> is used and the entries in the metadata array are always ordered in following way <ul> <li>metadata has a list of strings ["pin_min_length", x, "pin_min_char_classes_count", y] where</li> <li>x = the minimum length of the pin code</li> <li>y = the minimum amount of character classes (e.g. uppercase, number, special characters) to be used in the pin code</li> </ul> </p>
put/tokens/{id}/pin

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/tokens/{id}/pin
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the software token

Request body

old_pinstring text required

the old pin code of the token

new_pinstring text required

the new pin code of the token

Example request

{
  "old_pin": 0,
  "new_pin": 1234
}

Response

software token pin updated

Changes

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