]> git.koha-community.org Git - koha.git/blob - api/v1/swagger/definitions/auth_provider.yaml
Bug 31378: Add authentication provider endpoints
[koha.git] / api / v1 / swagger / definitions / auth_provider.yaml
1 ---
2 type: object
3 properties:
4   auth_provider_id:
5     type: integer
6     description: Internally assigned authentication provider identifier
7     readOnly: true
8   code:
9     description: Authentication provider code
10     type: string
11   description:
12     description: User-oriented description for the provider
13     type: string
14   protocol:
15     description: Authentication protocol
16     type: string
17     enum:
18       - OAuth
19       - OIDC
20       - CAS (not implemented)
21       - LDAP (not implemented)
22   mapping:
23     description: Attribute mapping
24     type:
25       - object
26       - "null"
27   matchpoint:
28     description: Patron attribute that will be used to match
29     type: string
30     enum:
31       - email
32       - userid
33       - cardnumber
34   config:
35     description: Configuration
36     type: object
37   icon_url:
38     description: Icon url
39     type: string
40   domains:
41     description: Configured domains for the authentication provider
42     type:
43       - array
44       - "null"
45 additionalProperties: false
46 required:
47   - config
48   - code
49   - protocol