2 /auth/otp/token_delivery:
4 x-mojo-to: TwoFactorAuth#send_otp_token
5 operationId: send_otp_token
8 summary: Send OTP token for second step authentication
23 additionalProperties: false
25 description: Bad Request
27 $ref: "../swagger.yaml#/definitions/error"
29 description: Access forbidden
31 $ref: "../swagger.yaml#/definitions/error"
34 Internal server error. Possible `error_code` attribute values:
36 * `internal_server_error`
38 $ref: "../swagger.yaml#/definitions/error"
43 /auth/two-factor/registration:
45 x-mojo-to: TwoFactorAuth#registration
46 operationId: Two factor register
49 summary: Generate a secret
66 additionalProperties: false
68 description: Bad Request
70 $ref: "../swagger.yaml#/definitions/error"
72 description: Access forbidden
74 $ref: "../swagger.yaml#/definitions/error"
77 Internal server error. Possible `error_code` attribute values:
79 * `internal_server_error`
81 $ref: "../swagger.yaml#/definitions/error"
86 /auth/two-factor/registration/verification:
88 x-mojo-to: TwoFactorAuth#verification
89 operationId: Two factor register verification
92 summary: Verify two-factor registration
96 description: the secret
101 description: the pin code
110 description: Authentication required
112 $ref: "../swagger.yaml#/definitions/error"
114 description: Bad Request
116 $ref: "../swagger.yaml#/definitions/error"
118 description: Access forbidden
120 $ref: "../swagger.yaml#/definitions/error"
123 Internal server error. Possible `error_code` attribute values:
125 * `internal_server_error`
127 $ref: "../swagger.yaml#/definitions/error"
128 x-koha-authorization:
133 x-mojo-to: Auth::Providers#list
134 operationId: listAuthProviders
137 summary: List configured identity providers
139 - $ref: ../swagger.yaml#/parameters/match
140 - $ref: ../swagger.yaml#/parameters/order_by
141 - $ref: ../swagger.yaml#/parameters/page
142 - $ref: ../swagger.yaml#/parameters/per_page
143 - $ref: ../swagger.yaml#/parameters/q_param
144 - $ref: ../swagger.yaml#/parameters/q_body
145 - $ref: ../swagger.yaml#/parameters/q_header
146 - $ref: ../swagger.yaml#/parameters/request_id_header
150 description: Embed list sent as a request header
156 collectionFormat: csv
161 description: A list of identity providers
165 $ref: ../swagger.yaml#/definitions/auth_provider
167 description: Bad Request
169 $ref: ../swagger.yaml#/definitions/error
171 description: Access forbidden
173 $ref: ../swagger.yaml#/definitions/error
176 Internal server error. Possible `error_code` attribute values:
178 * `internal_server_error`
180 $ref: ../swagger.yaml#/definitions/error
182 description: Under maintenance
184 $ref: ../swagger.yaml#/definitions/error
185 x-koha-authorization:
187 parameters: manage_authentication_providers
189 x-mojo-to: Auth::Providers#add
190 operationId: addAuthProvider
193 summary: Add a new identity provider
198 A JSON object containing OAuth provider parameters.
200 The `config` object required attributes depends on the chosen `protocol`
220 $ref: ../swagger.yaml#/definitions/auth_provider
225 description: The generated identity provider
227 $ref: ../swagger.yaml#/definitions/auth_provider
229 description: Bad Request
231 $ref: ../swagger.yaml#/definitions/error
233 description: Access forbidden
235 $ref: ../swagger.yaml#/definitions/error
238 Internal server error. Possible `error_code` attribute values:
240 * `internal_server_error`
242 $ref: ../swagger.yaml#/definitions/error
244 description: Under maintenance
246 $ref: ../swagger.yaml#/definitions/error
247 x-koha-authorization:
249 parameters: manage_authentication_providers
250 "/auth/providers/{auth_provider_id}":
252 x-mojo-to: Auth::Providers#get
253 operationId: getAuthProvider
256 summary: Get identity provider
258 - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp
262 description: Embed list sent as a request header
268 collectionFormat: csv
273 description: An identity provider
275 $ref: ../swagger.yaml#/definitions/auth_provider
277 description: Object not found
279 $ref: ../swagger.yaml#/definitions/error
282 Internal server error. Possible `error_code` attribute values:
284 * `internal_server_error`
286 $ref: ../swagger.yaml#/definitions/error
288 description: Under maintenance
290 $ref: ../swagger.yaml#/definitions/error
291 x-koha-authorization:
293 parameters: manage_authentication_providers
295 x-mojo-to: Auth::Providers#update
296 operationId: updateAuthProvider
299 summary: Update an identity provider
301 - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp
305 A JSON object containing OAuth provider parameters.
307 The `config` object required attributes depends on the chosen `protocol`
327 $ref: ../swagger.yaml#/definitions/auth_provider
332 description: Updated identity provider
334 $ref: ../swagger.yaml#/definitions/auth_provider
336 description: Bad Request
338 $ref: ../swagger.yaml#/definitions/error
340 description: Access forbidden
342 $ref: ../swagger.yaml#/definitions/error
344 description: Object not found
346 $ref: ../swagger.yaml#/definitions/error
349 Internal server error. Possible `error_code` attribute values:
351 * `internal_server_error`
353 $ref: ../swagger.yaml#/definitions/error
355 description: Under maintenance
357 $ref: ../swagger.yaml#/definitions/error
358 x-koha-authorization:
360 parameters: manage_authentication_providers
362 x-mojo-to: Auth::Providers#delete
363 operationId: delAuthProvider
366 summary: Delete identity provider
368 - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp
373 description: identity provider deleted
375 description: Authentication required
377 $ref: ../swagger.yaml#/definitions/error
379 description: Access forbidden
381 $ref: ../swagger.yaml#/definitions/error
383 description: City not found
385 $ref: ../swagger.yaml#/definitions/error
388 Internal server error. Possible `error_code` attribute values:
390 * `internal_server_error`
392 description: Under maintenance
394 $ref: ../swagger.yaml#/definitions/error
395 x-koha-authorization:
397 parameters: manage_authentication_providers
398 "/auth/providers/{auth_provider_id}/domains":
400 x-mojo-to: Auth::Provider::Domains#list
401 operationId: listAuthProviderDomains
404 summary: Get identity provider configured domains
406 - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp
407 - $ref: ../swagger.yaml#/parameters/match
408 - $ref: ../swagger.yaml#/parameters/order_by
409 - $ref: ../swagger.yaml#/parameters/page
410 - $ref: ../swagger.yaml#/parameters/per_page
411 - $ref: ../swagger.yaml#/parameters/q_param
412 - $ref: ../swagger.yaml#/parameters/q_body
413 - $ref: ../swagger.yaml#/parameters/q_header
414 - $ref: ../swagger.yaml#/parameters/request_id_header
418 description: Embed list sent as a request header
424 collectionFormat: csv
429 description: An identity provider
432 $ref: ../swagger.yaml#/definitions/auth_provider_domain
434 description: Object not found
436 $ref: ../swagger.yaml#/definitions/error
439 Internal server error. Possible `error_code` attribute values:
441 * `internal_server_error`
443 $ref: ../swagger.yaml#/definitions/error
445 description: Under maintenance
447 $ref: ../swagger.yaml#/definitions/error
448 x-koha-authorization:
450 parameters: manage_authentication_providers
452 x-mojo-to: Auth::Provider::Domains#add
453 operationId: addAuthProviderDomain
456 summary: Add an identity provider domain
458 - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp
461 description: An identity provider domain object
464 $ref: ../swagger.yaml#/definitions/auth_provider_domain
469 description: Updated identity provider domain
471 $ref: ../swagger.yaml#/definitions/auth_provider_domain
473 description: Bad Request
475 $ref: ../swagger.yaml#/definitions/error
477 description: Access forbidden
479 $ref: ../swagger.yaml#/definitions/error
481 description: Object not found
483 $ref: ../swagger.yaml#/definitions/error
486 Internal server error. Possible `error_code` attribute values:
488 * `internal_server_error`
490 $ref: ../swagger.yaml#/definitions/error
492 description: Under maintenance
494 $ref: ../swagger.yaml#/definitions/error
495 x-koha-authorization:
497 parameters: manage_authentication_providers
498 "/auth/providers/{auth_provider_id}/domains/{auth_provider_domain_id}":
500 x-mojo-to: Auth::Provider::Domains#get
501 operationId: getAuthProviderDomain
504 summary: Get identity provider domain
506 - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp
507 - $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp
512 description: An identity provider
514 $ref: ../swagger.yaml#/definitions/auth_provider_domain
516 description: Object not found
518 $ref: ../swagger.yaml#/definitions/error
521 Internal server error. Possible `error_code` attribute values:
523 * `internal_server_error`
525 $ref: ../swagger.yaml#/definitions/error
527 description: Under maintenance
529 $ref: ../swagger.yaml#/definitions/error
530 x-koha-authorization:
532 parameters: manage_authentication_providers
534 x-mojo-to: Auth::Provider::Domains#delete
535 operationId: delAuthProviderDomain
538 summary: Delete identity provider
540 - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp
541 - $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp
546 description: identity provider deleted
548 description: Authentication required
550 $ref: ../swagger.yaml#/definitions/error
552 description: Access forbidden
554 $ref: ../swagger.yaml#/definitions/error
556 description: City not found
558 $ref: ../swagger.yaml#/definitions/error
561 Internal server error. Possible `error_code` attribute values:
563 * `internal_server_error`
565 description: Under maintenance
567 $ref: ../swagger.yaml#/definitions/error
568 x-koha-authorization:
570 parameters: manage_authentication_providers
571 /auth/identity_providers:
573 x-mojo-to: Auth::Identity::Providers#list
574 operationId: listIdentityProviders
577 summary: List configured identity providers
579 - $ref: ../swagger.yaml#/parameters/match
580 - $ref: ../swagger.yaml#/parameters/order_by
581 - $ref: ../swagger.yaml#/parameters/page
582 - $ref: ../swagger.yaml#/parameters/per_page
583 - $ref: ../swagger.yaml#/parameters/q_param
584 - $ref: ../swagger.yaml#/parameters/q_body
585 - $ref: ../swagger.yaml#/parameters/q_header
586 - $ref: ../swagger.yaml#/parameters/request_id_header
590 description: Embed list sent as a request header
596 collectionFormat: csv
601 description: A list of identity providers
605 $ref: ../swagger.yaml#/definitions/identity_provider
607 description: Bad Request
609 $ref: ../swagger.yaml#/definitions/error
611 description: Access forbidden
613 $ref: ../swagger.yaml#/definitions/error
616 Internal server error. Possible `error_code` attribute values:
618 * `internal_server_error`
620 $ref: ../swagger.yaml#/definitions/error
622 description: Under maintenance
624 $ref: ../swagger.yaml#/definitions/error
625 x-koha-authorization:
627 parameters: manage_identity_providers
629 x-mojo-to: Auth::Identity::Providers#add
630 operationId: addIdentityProvider
633 summary: Add a new identity provider
638 A JSON object containing OAuth provider parameters.
640 The `config` object required attributes depends on the chosen `protocol`
660 $ref: ../swagger.yaml#/definitions/identity_provider
665 description: The generated identity provider
667 $ref: ../swagger.yaml#/definitions/identity_provider
669 description: Bad Request
671 $ref: ../swagger.yaml#/definitions/error
673 description: Access forbidden
675 $ref: ../swagger.yaml#/definitions/error
678 Internal server error. Possible `error_code` attribute values:
680 * `internal_server_error`
682 $ref: ../swagger.yaml#/definitions/error
684 description: Under maintenance
686 $ref: ../swagger.yaml#/definitions/error
687 x-koha-authorization:
689 parameters: manage_identity_providers
690 "/auth/identity_providers/{identity_provider_id}":
692 x-mojo-to: Auth::Identity::Providers#get
693 operationId: getIdentityProvider
696 summary: Get identity provider
698 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
702 description: Embed list sent as a request header
708 collectionFormat: csv
713 description: An identity provider
715 $ref: ../swagger.yaml#/definitions/identity_provider
717 description: Object not found
719 $ref: ../swagger.yaml#/definitions/error
722 Internal server error. Possible `error_code` attribute values:
724 * `internal_server_error`
726 $ref: ../swagger.yaml#/definitions/error
728 description: Under maintenance
730 $ref: ../swagger.yaml#/definitions/error
731 x-koha-authorization:
733 parameters: manage_identity_providers
735 x-mojo-to: Auth::Identity::Providers#update
736 operationId: updateIdentityProvider
739 summary: Update an identity provider
741 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
745 A JSON object containing OAuth provider parameters.
747 The `config` object required attributes depends on the chosen `protocol`
767 $ref: ../swagger.yaml#/definitions/identity_provider
772 description: Updated identity provider
774 $ref: ../swagger.yaml#/definitions/identity_provider
776 description: Bad Request
778 $ref: ../swagger.yaml#/definitions/error
780 description: Access forbidden
782 $ref: ../swagger.yaml#/definitions/error
784 description: Object not found
786 $ref: ../swagger.yaml#/definitions/error
789 Internal server error. Possible `error_code` attribute values:
791 * `internal_server_error`
793 $ref: ../swagger.yaml#/definitions/error
795 description: Under maintenance
797 $ref: ../swagger.yaml#/definitions/error
798 x-koha-authorization:
800 parameters: manage_identity_providers
802 x-mojo-to: Auth::Identity::Providers#delete
803 operationId: delIdentityProvider
806 summary: Delete identity provider
808 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
813 description: identity provider deleted
815 description: Authentication required
817 $ref: ../swagger.yaml#/definitions/error
819 description: Access forbidden
821 $ref: ../swagger.yaml#/definitions/error
823 description: City not found
825 $ref: ../swagger.yaml#/definitions/error
828 Internal server error. Possible `error_code` attribute values:
830 * `internal_server_error`
832 description: Under maintenance
834 $ref: ../swagger.yaml#/definitions/error
835 x-koha-authorization:
837 parameters: manage_identity_providers
838 "/auth/identity_providers/{identity_provider_id}/domains":
840 x-mojo-to: Auth::Identity::Provider::Domains#list
841 operationId: listIdentityProviderDomains
844 summary: Get identity provider configured domains
846 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
847 - $ref: ../swagger.yaml#/parameters/match
848 - $ref: ../swagger.yaml#/parameters/order_by
849 - $ref: ../swagger.yaml#/parameters/page
850 - $ref: ../swagger.yaml#/parameters/per_page
851 - $ref: ../swagger.yaml#/parameters/q_param
852 - $ref: ../swagger.yaml#/parameters/q_body
853 - $ref: ../swagger.yaml#/parameters/q_header
854 - $ref: ../swagger.yaml#/parameters/request_id_header
858 description: Embed list sent as a request header
864 collectionFormat: csv
869 description: An identity provider
872 $ref: ../swagger.yaml#/definitions/identity_provider_domain
874 description: Object not found
876 $ref: ../swagger.yaml#/definitions/error
879 Internal server error. Possible `error_code` attribute values:
881 * `internal_server_error`
883 $ref: ../swagger.yaml#/definitions/error
885 description: Under maintenance
887 $ref: ../swagger.yaml#/definitions/error
888 x-koha-authorization:
890 parameters: manage_identity_providers
892 x-mojo-to: Auth::Identity::Provider::Domains#add
893 operationId: addIdentityProviderDomain
896 summary: Add an identity provider domain
898 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
901 description: An identity provider domain object
904 $ref: ../swagger.yaml#/definitions/identity_provider_domain
909 description: Updated identity provider domain
911 $ref: ../swagger.yaml#/definitions/identity_provider_domain
913 description: Bad Request
915 $ref: ../swagger.yaml#/definitions/error
917 description: Access forbidden
919 $ref: ../swagger.yaml#/definitions/error
921 description: Object not found
923 $ref: ../swagger.yaml#/definitions/error
926 Internal server error. Possible `error_code` attribute values:
928 * `internal_server_error`
930 $ref: ../swagger.yaml#/definitions/error
932 description: Under maintenance
934 $ref: ../swagger.yaml#/definitions/error
935 x-koha-authorization:
937 parameters: manage_identity_providers
938 "/auth/identity_providers/{identity_provider_id}/domains/{identity_provider_domain_id}":
940 x-mojo-to: Auth::Identity::Provider::Domains#get
941 operationId: getIdentityProviderDomain
944 summary: Get identity provider domain
946 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
947 - $ref: ../swagger.yaml#/parameters/identity_provider_domain_id_pp
952 description: An identity provider
954 $ref: ../swagger.yaml#/definitions/identity_provider_domain
956 description: Object not found
958 $ref: ../swagger.yaml#/definitions/error
961 Internal server error. Possible `error_code` attribute values:
963 * `internal_server_error`
965 $ref: ../swagger.yaml#/definitions/error
967 description: Under maintenance
969 $ref: ../swagger.yaml#/definitions/error
970 x-koha-authorization:
972 parameters: manage_identity_providers
974 x-mojo-to: Auth::Identity::Provider::Domains#update
975 operationId: updateIdentityProviderDomain
978 summary: Update an identity provider domain
980 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
981 - $ref: ../swagger.yaml#/parameters/identity_provider_domain_id_pp
984 description: An identity provider domain object
987 $ref: ../swagger.yaml#/definitions/identity_provider_domain
992 description: Updated identity provider domain
994 $ref: ../swagger.yaml#/definitions/identity_provider_domain
996 description: Bad Request
998 $ref: ../swagger.yaml#/definitions/error
1000 description: Access forbidden
1002 $ref: ../swagger.yaml#/definitions/error
1004 description: Object not found
1006 $ref: ../swagger.yaml#/definitions/error
1009 Internal server error. Possible `error_code` attribute values:
1011 * `internal_server_error`
1013 $ref: ../swagger.yaml#/definitions/error
1015 description: Under maintenance
1017 $ref: ../swagger.yaml#/definitions/error
1018 x-koha-authorization:
1020 parameters: manage_identity_providers
1022 x-mojo-to: Auth::Identity::Provider::Domains#delete
1023 operationId: delIdentityProviderDomain
1025 - identity_providers
1026 summary: Delete identity provider
1028 - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp
1029 - $ref: ../swagger.yaml#/parameters/identity_provider_domain_id_pp
1034 description: identity provider deleted
1036 description: Authentication required
1038 $ref: ../swagger.yaml#/definitions/error
1040 description: Access forbidden
1042 $ref: ../swagger.yaml#/definitions/error
1044 description: City not found
1046 $ref: ../swagger.yaml#/definitions/error
1049 Internal server error. Possible `error_code` attribute values:
1051 * `internal_server_error`
1053 description: Under maintenance
1055 $ref: ../swagger.yaml#/definitions/error
1056 x-koha-authorization:
1058 parameters: manage_identity_providers
1059 "/auth/password/validation":
1061 x-mojo-to: Auth::Password#validate
1062 operationId: validateUserAndPassword
1065 summary: Check validity of username and password
1069 description: A JSON object containing username and password information
1074 description: Username
1077 description: Password (plain text)
1082 additionalProperties: false
1087 description: Validation successful
1089 description: Bad request
1091 $ref: ../swagger.yaml#/definitions/error
1093 description: Authentication required
1095 $ref: ../swagger.yaml#/definitions/error
1097 description: Access forbidden
1099 $ref: ../swagger.yaml#/definitions/error
1102 Internal server error. Possible `error_code` attribute values:
1104 * `internal_server_error`
1106 $ref: ../swagger.yaml#/definitions/error
1108 description: Under maintenance
1110 $ref: ../swagger.yaml#/definitions/error
1111 x-koha-authorization: