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

Parameters

Type Name Description Schema
Query fields
optional
Fields that should be included in the response message. All fields are displayed if the param is not present. < Fields > array

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,
    "breached_password_blocked" : false
  },
  "messages" : {
    "default" : {
      "personal.general.next" : "Next",
      "personal.general.collapse" : "Collapse"
    },
    "nl" : {
      "personal.general.next" : "Volgende",
      "personal.general.collapse" : "Inklappen"
    }
  },
  "profile" : {
    "required_attributes_validation_rules" : [ {
      "any_of" : [ "BIRTH_DATE", "PHONE" ]
    } ]
  }
}

Definitions

AttributeType

Type : enum (NAME, PHONE, BIRTH_DATE, EMAIL)

Configuration

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

Fields

Type : enum (profile, messages, password_policy)

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
breached_password_blocked
required
Indicates that the password is disallowed when it has been discovered in a public data breach.
Note: this option enables sending an anonymized transformation of the user's password to the Have I Been Pwned API, which is a resource of passwords found in public data breaches. This information is sent in such a way that it cannot be linked to the original user or their password by anyone (more on how this works).
Example : false
boolean
lower_case_char_required
required
Indicates at least one lower case character is required.
Example : false
boolean
max_length
required
Indicates the maximum length of a password.
Example : 0
integer (int32)
min_length
required
Indicates the minimum length of a password.
Example : 0
integer (int32)
special_char_required
required
Indicates that at least one special character is required.
Example : false
boolean
upper_case_char_required
required
Indicates at least one upper case character is required.
Example : false
boolean

Profile

Contains profiel configuration

Name Description Schema
required_attributes_validation_rules
optional
Example : [ "[requiredattributesvalidationrule](#requiredattributesvalidationrule)" ] < RequiredAttributesValidationRule > array

RequiredAttributesValidationRule

Contains list of required profile attributes. At least one of attributes is required

Name Description Schema
any_of
optional
Example : [ "BIRTH_DATE", "PHONE" ] < AttributeType > array

Translations

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

Type : < string, string > map

Security

basic_auth

Type : basic