Sign in
initialization

Initialize a new security server with the provided initial configuration

Changed on
<h3>Administrator initializes a new Security 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 is <code>invalid_init_params</code> which can have any one or more of the following strings in the metadata field <ul> <li>server_code_not_provided</li> <li>member_class_not_provided</li> <li>member_code_not_provided</li> <li>pin_code_not_provided</li> <li>server_code_exists</li> <li>member_class_exists</li> <li>member_code_exists</li> <li>pin_code_exists</li> </ul> </p> <p> This endpoint can return a warnings response which can be ignored by setting <code>InitialServerConf.ignore_warnings</code> = true. If <code>InitialServerConf.ignore_warnings</code> = false, a warnings response will be returned if any one of the following conditions is true <ul> <li>server code has already been set for this Security Server (warning code <code>init_servercode_exists</code>)</li> <li>server owner has already been set for this Security Server(warning code <code>init_server_owner_exists</code>)</li> <li>software token has already been initialized in this Security Server(warning code <code>init_software_token_initialized</code>)</li> <li>the provided owner member is unregistered(warning code <code>init_unregistered_member</code>)</li> <li>the provided server id is already in use by another Security Server(warning code <code>init_server_id_exists</code>)</li> </ul> </p> <strong>See the '400' response examples</strong>
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

owner_member_classstring text

member class

owner_member_codestring text

member code

security_server_codestring text

security server code

software_token_pinstring text

pin code for the initial software token

ignore_warningsboolean

if true, any ignorable warnings are ignored. if false (or missing), any warnings cause request to fail

enable_software_token_autologinboolean

if true, enables software token autologin; if false, disables it. If omitted, the autologin setting is left unchanged.

Example request

{
  "owner_member_class": "GOV",
  "owner_member_code": "12345678-9",
  "security_server_code": "SS1",
  "software_token_pin": "sup3rs3cr3t_p!n"
}

Response

security server initialized

Changes