Configuration API

Overview

This document describes the API operations for a configuration.

Version information

Version : 1.0.0

URI scheme

Schemes : HTTPS, HTTP

Paths

Obtaining configuration from CIM

GET /api/config

Responses

HTTP Code Description Schema
200 configuration Configuration
400 Bad request No Content
405 Unsupported method No Content
500 Api disabled No Content

Consumes

  • application/json

Produces

  • application/json

Security

Type Name
basic basic_auth

Example HTTP request

Request path
/api/config

Example HTTP response

Response 200
{
  "password_policy" : {
    "min_length" : 0,
    "max_length" : 0,
    "lower_case_char_required" : false,
    "upper_case_char_required" : false,
    "special_char_required" : false
  },
  "messages" : {
    "default" : {
      "personal.general.next" : "Next",
      "personal.general.collapse" : "Collapse"
    },
    "nl" : {
      "personal.general.next" : "Volgende",
      "personal.general.collapse" : "Inklappen"
    }
  }
}

Definitions

Configuration

Name Description Schema
messages
required
Example : "[messages](#messages)" Messages
password_policy
required
Example : "[passwordpolicy](#passwordpolicy)" PasswordPolicy

Messages

Key value map where key is the language nad value contains list of translations.

Type : < string, < string, Translations > map > map

PasswordPolicy

Name Description Schema
lower_case_char_required
required
Example : false boolean
max_length
required
Example : 0 integer (int32)
min_length
required
Example : 0 integer (int32)
special_char_required
required
Example : false boolean
upper_case_char_required
required
Example : false boolean

Translations

Key value map where key is the message identifier and value contains translation.

Type : < string, string > map

Security

basic_auth

Type : basic