diff --git a/models/common/authentification-info.json b/models/common/authentification-info.json index c67b3c2862a8823afdc37577b3fb861b7213f23f..6a0a52d84e61caf9a9185d3c0071bfbf1e466be6 100644 --- a/models/common/authentification-info.json +++ b/models/common/authentification-info.json @@ -2,6 +2,14 @@ "type": "object", "title": "Authentifikation", "additionalProperties": false, + "description": "Informationen über die Authentifikation der Person.", + "x-examples": { + "example-1": { + "assuranceLevel": "high", + "authentificationMethod": "eID", + "timestamp": "2020-03-03T12:38:23Z" + } + }, "properties": { "assuranceLevel": { "type": "string", @@ -9,29 +17,46 @@ "low", "substantial", "high" - ] + ], + "description": "Vertrauensniveau" }, "authentificationMethod": { - "type": "string" + "type": "string", + "description": "Methode der Authentifikation" }, "authentificationToken": { "type": "object" }, "timestamp": { "type": "string", - "format": "date-time" + "format": "date-time", + "description": "Zeitstempel der Authentifikation" + }, + "authenticatedFields": { + "type": "array", + "minItems": 1, + "uniqueItems": true, + "description": "Liste der authentifizierten Felder in `identityInfo`", + "items": { + "type": "string", + "enum": [ + "placeOfBirth", + "dateOfBirth", + "gender", + "nationality", + "artisticName", + "doctoralDegrees", + "birthName", + "givenName", + "familyName", + "placeOfResidence" + ] + } } }, "required": [ "assuranceLevel", - "authentificationMethod" - ], - "description": "Informationen über die Authentifikation der Person.", - "x-examples": { - "example-1": { - "assuranceLevel": "high", - "authentificationMethod": "eID", - "timestamp": "2020-03-03T12:38:23Z" - } - } + "authentificationMethod", + "authenticatedFields" + ] } \ No newline at end of file