Bug 31378: Add an administration interface for authentication sources
[koha.git] / api / v1 / swagger / definitions / auth_provider_domain.yaml
1 ---
2 type: object
3 properties:
4   auth_provider_domain_id:
5     type: integer
6     description: Internally assigned authentication provider domain identifier
7     readOnly: true
8   auth_provider_id:
9     type: integer
10     description: Internally assigned authentication provider identifier
11   domain:
12     description: Matching domain ('*' used as wildcard)
13     type:
14       - string
15       - "null"
16   auto_register:
17     description: If patrons will be generated on login if required
18     type: boolean
19   update_on_auth:
20     description: If patron data is updated on login
21     type: boolean
22   default_library_id:
23     description: Internal identifier for the default library to be assigned to the new patrons
24     type:
25       - string
26       - "null"
27   default_category_id:
28     description: Internal identifier for the default patron's category
29     type:
30       - string
31       - "null"
32   allow_opac:
33     description: If this domain can be used for OPAC login
34     type: boolean
35   allow_staff:
36     description: If this domain can be used for staff login
37     type: boolean
38 additionalProperties: false
39 required:
40   - auth_provider_domain_id
41   - auth_provider_id
42   - domain
43   - auto_register
44   - update_on_auth
45   - default_library_id
46   - default_category_id
47   - allow_opac
48   - allow_staff