api-kim/src/openapi/ServiceInformation.yaml at main · gematik/api-kim · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
openapi: 3.0.3
info:
  title: I_ServiceInformation
  description:  Information about the KIM service is requested via this interface.
  version: 1.0.3
  ### 1.0.3
  # - removed operation GET /appTags
  ### 1.0.2
  # - added operation GET /appTags
  ### 1.0.1
  # - added kimServiceVersion and jwtExpirations to the ServiceInformation object
  ### 1.0.0
  # - initial Version of I_ServiceInformation
  # - added traceId to Error object

externalDocs:
  description: GitHub - documentation
  url: https://github.com/gematik/api-kim
servers:
- url: /ServiceInformation/v1.0/
  # The URL must be formed as described in requirement [A_19524-*], see https://gemspec.gematik.de/docs/gemSpec/gemSpec_FD_KOMLE/latest
tags:
- name: ServiceInformation

paths:
  /serviceinfo:
    get:
      tags:
      - ServiceInformation
      summary: Request information via the KIM backend service
      description: Request information via the KIM backend service
      operationId: getServiceInformation
      responses:
        200:
          description: OK
             # Return the information via the KIM backend service
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ServiceInformation'
        500:
          $ref: 'CommonSchemas.yaml#/components/responses/500'

components:
  schemas:
    ServiceInformation:
      type: object
      properties:
        kimServiceVersion:
          type: string
          description: Specifies the KIM release version(s) of the service according to gematik specification [gemSpec_OM]. Multiple versions MAY be provided as a semicolon-separated (";") list.
          example: "1.5.2;1.5.5"
        passwordPolicyRegEx:
          type: string
          description: Specifies the password policy required by the AccountManager as a regular expression in a Java-compatible style.
        passwordPolicyDisplay:
          type: string
          description: Specifies the password policy that the AccountManager requires in text form.
        jwtExpiration:
          type: integer
          minimum: 300
          maximum: 21600
          description: Specifies the configured expiration time range for JWTs. The value is given in seconds.
        referenceIdRequired:
          type: boolean
          description: Specifies whether the referenceID is required during initial registration.
        initialPasswordRequired:
          type: boolean
          description: Specifies whether the initial password is required during initial registration.
      example:
        kimServiceVersion: 1.5.5
        passwordPolicyRegEx: ^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[*.!@#$%^&(){}\[\]:;'<>,?/~_+\-=|\\]).{12,256}$
        passwordPolicyDisplay: At least one number [0-9]
                              At least one lowercase letter [a-z]
                              At least one capital letter [A-Z]
                              At least one special character [*.!@#$%^&(){}[]:;'<>,?/~_+-=|\]
                              Minimum length 12 characters
                              Maximum length 256 characters.
        jwtExpiration: 300
        referenceIdRequired: true
        initialPasswordRequired: false