initialization

Initialize a new central server with the provided initial configuration

Changed on
<h3>Administrator initializes a new Central Server with the provided initial configuration.</h3> <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> Other possible error code are <ul> <li><code>invalid_init_params</code> for "business" logic problems which can have any one or more of the following strings in the metadata field. There "_exists" -entries are returned if parameter has been given already in partially succeeded initialization. The "_not_provided"-entries are returned if these parameters is needed still for the initialization, but it is not given in the request. </li> <li>pin_code_exists</li> <li>pin_code_not_provided</li> <li>server_address_exists</li> <li>server_address_not_provided</li> <li>instance_identifier_exists</li> <li>instance_identifier_not_provided</li> <li><code>validation_failure</code> for parameter format errors </ul> <strong>See the '400' response examples</strong> </p>
post/initialization

Request

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

Request body

instance_identifierstring text required

Valid instance identifier, shall not contain colon, semicolon, forwardslash, backslash, percent or control characters.

central_server_addressstring text required

Central server’s public DNS name or external IP address

software_token_pinstring text required

pin code for the initial software token

Example request

{
  "instance_identifier": "FI-TEST",
  "software_token_pin": "sup3rs3cr3t_p!n"
}

Response

central server initialized

Changes

    • ▲

      added the pattern ^[a-zA-Z0-9'()+,-.=?]* to the request property ////