From d634c1971fba572959fbef6ca9392767e3506a62 Mon Sep 17 00:00:00 2001 From: Owen Leonard Date: Tue, 30 May 2023 10:51:16 +0000 Subject: [PATCH] Bug 33859: Use the phrase 'Identity providers' instead of 'Authentication providers' This patch updates instances in the code and templates where the term "Authentication providers" is used, replacing it with the preferred "Identity provider." Most of the instances of this change are in module or API documentation, but you can see a couple of the changes in the interface: - Administration -> Identity providers: - The sidebar menu should show "Identity providers" instead of "Authentication providers." - Patrons -> Patron details -> More -> Set permissions - Under " Manage Koha system settings (Administration panel)" you should see "Manage identity providers (manage_identity_providers)" Signed-off-by: Sam Lau Signed-off-by: David Cook Signed-off-by: Tomas Cohen Arazi --- .../REST/V1/Auth/Identity/Provider/Domains.pm | 12 +-- Koha/REST/V1/Auth/Identity/Providers.pm | 12 +-- .../definitions/identity_provider.yaml | 6 +- .../definitions/identity_provider_domain.yaml | 4 +- api/v1/swagger/paths/auth.yaml | 82 +++++++++---------- api/v1/swagger/swagger.yaml | 4 +- .../data/mysql/mandatory/userpermissions.sql | 2 +- .../prog/en/includes/admin-menu.inc | 2 +- .../prog/en/includes/permissions.inc | 2 +- 9 files changed, 63 insertions(+), 63 deletions(-) diff --git a/Koha/REST/V1/Auth/Identity/Provider/Domains.pm b/Koha/REST/V1/Auth/Identity/Provider/Domains.pm index cac05a8d96..0cdc7ec140 100644 --- a/Koha/REST/V1/Auth/Identity/Provider/Domains.pm +++ b/Koha/REST/V1/Auth/Identity/Provider/Domains.pm @@ -30,13 +30,13 @@ use Try::Tiny; =head1 NAME Koha::REST::V1::Auth::Identity::Provider::Domains - Controller library for handling -authentication provider domains routes. +identity provider domains routes. =head2 Operations =head3 list -Controller method for listing authentication provider domains. +Controller method for listing identity provider domains. =cut @@ -69,7 +69,7 @@ sub list { =head3 get -Controller method for retrieving an authentication provider domain. +Controller method for retrieving an identity provider domain. =cut @@ -114,7 +114,7 @@ sub get { =head3 add -Controller method for adding an authentication provider. +Controller method for adding an identity provider. =cut @@ -153,7 +153,7 @@ sub add { =head3 update -Controller method for updating an authentication provider domain. +Controller method for updating an identity provider domain. =cut @@ -197,7 +197,7 @@ sub update { =head3 delete -Controller method for deleting an authentication provider. +Controller method for deleting an identity provider. =cut diff --git a/Koha/REST/V1/Auth/Identity/Providers.pm b/Koha/REST/V1/Auth/Identity/Providers.pm index 2f3dede36a..fd8a80fae4 100644 --- a/Koha/REST/V1/Auth/Identity/Providers.pm +++ b/Koha/REST/V1/Auth/Identity/Providers.pm @@ -31,13 +31,13 @@ use Try::Tiny; =head1 NAME Koha::REST::V1::Auth::Identity::Providers - Controller library for handling -authentication providers routes. +identity providers routes. =head2 Operations =head3 list -Controller method for listing authentication providers. +Controller method for listing identity providers. =cut @@ -57,7 +57,7 @@ sub list { =head3 get -Controller method for retrieving an authentication provider. +Controller method for retrieving an identity provider. =cut @@ -88,7 +88,7 @@ sub get { =head3 add -Controller method for adding an authentication provider. +Controller method for adding an identity provider. =cut @@ -140,7 +140,7 @@ sub add { =head3 update -Controller method for updating an authentication provider. +Controller method for updating an identity provider. =cut @@ -204,7 +204,7 @@ sub update { =head3 delete -Controller method for deleting an authentication provider. +Controller method for deleting an identity provider. =cut diff --git a/api/v1/swagger/definitions/identity_provider.yaml b/api/v1/swagger/definitions/identity_provider.yaml index c69d60a595..c9fc649d42 100644 --- a/api/v1/swagger/definitions/identity_provider.yaml +++ b/api/v1/swagger/definitions/identity_provider.yaml @@ -3,10 +3,10 @@ type: object properties: identity_provider_id: type: integer - description: Internally assigned authentication provider identifier + description: Internally assigned identity provider identifier readOnly: true code: - description: Authentication provider code + description: Identity provider code type: string description: description: User-oriented description for the provider @@ -40,7 +40,7 @@ properties: - string - "null" domains: - description: Configured domains for the authentication provider + description: Configured domains for the identity provider type: - array - "null" diff --git a/api/v1/swagger/definitions/identity_provider_domain.yaml b/api/v1/swagger/definitions/identity_provider_domain.yaml index d03e99dbe6..a912e735d0 100644 --- a/api/v1/swagger/definitions/identity_provider_domain.yaml +++ b/api/v1/swagger/definitions/identity_provider_domain.yaml @@ -3,11 +3,11 @@ type: object properties: identity_provider_domain_id: type: integer - description: Internally assigned authentication provider domain identifier + description: Internally assigned identity provider domain identifier readOnly: true identity_provider_id: type: integer - description: Internally assigned authentication provider identifier + description: Internally assigned identity provider identifier domain: description: Matching domain ('*' used as wildcard) type: diff --git a/api/v1/swagger/paths/auth.yaml b/api/v1/swagger/paths/auth.yaml index b1aad6eec6..90765f1d20 100644 --- a/api/v1/swagger/paths/auth.yaml +++ b/api/v1/swagger/paths/auth.yaml @@ -134,7 +134,7 @@ operationId: listAuthProviders tags: - auth_providers - summary: List configured authentication providers + summary: List configured identity providers parameters: - $ref: ../swagger.yaml#/parameters/match - $ref: ../swagger.yaml#/parameters/order_by @@ -158,7 +158,7 @@ - application/json responses: "200": - description: A list of authentication providers + description: A list of identity providers schema: type: array items: @@ -190,7 +190,7 @@ operationId: addAuthProvider tags: - auth_providers - summary: Add a new authentication provider + summary: Add a new identity provider parameters: - name: body in: body @@ -222,7 +222,7 @@ - application/json responses: "201": - description: The generated authentication provider + description: The generated identity provider schema: $ref: ../swagger.yaml#/definitions/auth_provider "400": @@ -253,7 +253,7 @@ operationId: getAuthProvider tags: - auth_providers - summary: Get authentication provider + summary: Get identity provider parameters: - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp - name: x-koha-embed @@ -270,7 +270,7 @@ - application/json responses: "200": - description: An authentication provider + description: An identity provider schema: $ref: ../swagger.yaml#/definitions/auth_provider "404": @@ -296,7 +296,7 @@ operationId: updateAuthProvider tags: - auth_providers - summary: Update an authentication provider + summary: Update an identity provider parameters: - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp - name: body @@ -329,7 +329,7 @@ - application/json responses: "200": - description: Updated authentication provider + description: Updated identity provider schema: $ref: ../swagger.yaml#/definitions/auth_provider "400": @@ -363,14 +363,14 @@ operationId: delAuthProvider tags: - auth_providers - summary: Delete authentication provider + summary: Delete identity provider parameters: - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp produces: - application/json responses: "204": - description: Authentication provider deleted + description: identity provider deleted "401": description: Authentication required schema: @@ -401,7 +401,7 @@ operationId: listAuthProviderDomains tags: - auth_providers - summary: Get authentication provider configured domains + summary: Get identity provider configured domains parameters: - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp - $ref: ../swagger.yaml#/parameters/match @@ -426,7 +426,7 @@ - application/json responses: "200": - description: An authentication provider + description: An identity provider schema: items: $ref: ../swagger.yaml#/definitions/auth_provider_domain @@ -453,12 +453,12 @@ operationId: addAuthProviderDomain tags: - auth_providers - summary: Add an authentication provider domain + summary: Add an identity provider domain parameters: - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp - name: body in: body - description: An authentication provider domain object + description: An identity provider domain object required: true schema: $ref: ../swagger.yaml#/definitions/auth_provider_domain @@ -466,7 +466,7 @@ - application/json responses: "201": - description: Updated authentication provider domain + description: Updated identity provider domain schema: $ref: ../swagger.yaml#/definitions/auth_provider_domain "400": @@ -501,7 +501,7 @@ operationId: getAuthProviderDomain tags: - auth_providers - summary: Get authentication provider domain + summary: Get identity provider domain parameters: - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp - $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp @@ -509,7 +509,7 @@ - application/json responses: "200": - description: An authentication provider + description: An identity provider schema: $ref: ../swagger.yaml#/definitions/auth_provider_domain "404": @@ -535,7 +535,7 @@ operationId: delAuthProviderDomain tags: - auth_providers - summary: Delete authentication provider + summary: Delete identity provider parameters: - $ref: ../swagger.yaml#/parameters/auth_provider_id_pp - $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp @@ -543,7 +543,7 @@ - application/json responses: "204": - description: Authentication provider deleted + description: identity provider deleted "401": description: Authentication required schema: @@ -574,7 +574,7 @@ operationId: listIdentityProviders tags: - identity_providers - summary: List configured authentication providers + summary: List configured identity providers parameters: - $ref: ../swagger.yaml#/parameters/match - $ref: ../swagger.yaml#/parameters/order_by @@ -598,7 +598,7 @@ - application/json responses: "200": - description: A list of authentication providers + description: A list of identity providers schema: type: array items: @@ -630,7 +630,7 @@ operationId: addIdentityProvider tags: - identity_providers - summary: Add a new authentication provider + summary: Add a new identity provider parameters: - name: body in: body @@ -662,7 +662,7 @@ - application/json responses: "201": - description: The generated authentication provider + description: The generated identity provider schema: $ref: ../swagger.yaml#/definitions/identity_provider "400": @@ -693,7 +693,7 @@ operationId: getIdentityProvider tags: - identity_providers - summary: Get authentication provider + summary: Get identity provider parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp - name: x-koha-embed @@ -710,7 +710,7 @@ - application/json responses: "200": - description: An authentication provider + description: An identity provider schema: $ref: ../swagger.yaml#/definitions/identity_provider "404": @@ -736,7 +736,7 @@ operationId: updateIdentityProvider tags: - identity_providers - summary: Update an authentication provider + summary: Update an identity provider parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp - name: body @@ -769,7 +769,7 @@ - application/json responses: "200": - description: Updated authentication provider + description: Updated identity provider schema: $ref: ../swagger.yaml#/definitions/identity_provider "400": @@ -803,14 +803,14 @@ operationId: delIdentityProvider tags: - identity_providers - summary: Delete authentication provider + summary: Delete identity provider parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp produces: - application/json responses: "204": - description: Authentication provider deleted + description: identity provider deleted "401": description: Authentication required schema: @@ -841,7 +841,7 @@ operationId: listIdentityProviderDomains tags: - identity_providers - summary: Get authentication provider configured domains + summary: Get identity provider configured domains parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp - $ref: ../swagger.yaml#/parameters/match @@ -866,7 +866,7 @@ - application/json responses: "200": - description: An authentication provider + description: An identity provider schema: items: $ref: ../swagger.yaml#/definitions/identity_provider_domain @@ -893,12 +893,12 @@ operationId: addIdentityProviderDomain tags: - identity_providers - summary: Add an authentication provider domain + summary: Add an identity provider domain parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp - name: body in: body - description: An authentication provider domain object + description: An identity provider domain object required: true schema: $ref: ../swagger.yaml#/definitions/identity_provider_domain @@ -906,7 +906,7 @@ - application/json responses: "201": - description: Updated authentication provider domain + description: Updated identity provider domain schema: $ref: ../swagger.yaml#/definitions/identity_provider_domain "400": @@ -941,7 +941,7 @@ operationId: getIdentityProviderDomain tags: - identity_providers - summary: Get authentication provider domain + summary: Get identity provider domain parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp - $ref: ../swagger.yaml#/parameters/identity_provider_domain_id_pp @@ -949,7 +949,7 @@ - application/json responses: "200": - description: An authentication provider + description: An identity provider schema: $ref: ../swagger.yaml#/definitions/identity_provider_domain "404": @@ -975,13 +975,13 @@ operationId: updateIdentityProviderDomain tags: - identity_providers - summary: Update an authentication provider domain + summary: Update an identity provider domain parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp - $ref: ../swagger.yaml#/parameters/identity_provider_domain_id_pp - name: body in: body - description: An authentication provider domain object + description: An identity provider domain object required: true schema: $ref: ../swagger.yaml#/definitions/identity_provider_domain @@ -989,7 +989,7 @@ - application/json responses: "200": - description: Updated authentication provider domain + description: Updated identity provider domain schema: $ref: ../swagger.yaml#/definitions/identity_provider_domain "400": @@ -1023,7 +1023,7 @@ operationId: delIdentityProviderDomain tags: - identity_providers - summary: Delete authentication provider + summary: Delete identity provider parameters: - $ref: ../swagger.yaml#/parameters/identity_provider_id_pp - $ref: ../swagger.yaml#/parameters/identity_provider_domain_id_pp @@ -1031,7 +1031,7 @@ - application/json responses: "204": - description: Authentication provider deleted + description: identity provider deleted "401": description: Authentication required schema: diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml index 280610c261..9e60aa77a2 100644 --- a/api/v1/swagger/swagger.yaml +++ b/api/v1/swagger/swagger.yaml @@ -420,13 +420,13 @@ parameters: required: false type: integer identity_provider_id_pp: - description: Authentication provider internal identifier + description: Identity provider internal identifier in: path name: identity_provider_id required: true type: integer identity_provider_domain_id_pp: - description: Authentication provider domain internal identifier + description: Identity provider domain internal identifier in: path name: identity_provider_domain_id required: true diff --git a/installer/data/mysql/mandatory/userpermissions.sql b/installer/data/mysql/mandatory/userpermissions.sql index c3dcf91dee..63da567fb7 100644 --- a/installer/data/mysql/mandatory/userpermissions.sql +++ b/installer/data/mysql/mandatory/userpermissions.sql @@ -41,7 +41,7 @@ INSERT INTO permissions (module_bit, code, description) VALUES ( 3, 'manage_background_jobs', 'Manage background jobs'), ( 3, 'manage_curbside_pickups', 'Manage curbside pickups'), ( 3, 'manage_search_filters', 'Manage custom search filters'), - ( 3, 'manage_identity_providers', 'Manage authentication providers'), + ( 3, 'manage_identity_providers', 'Manage identity providers'), ( 4, 'delete_borrowers', 'Delete patrons'), ( 4, 'edit_borrowers', 'Add, modify and view patron information'), ( 4, 'view_borrower_infos_from_any_libraries', 'View patron infos from any libraries'), diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/admin-menu.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/admin-menu.inc index 96ca936832..c0d492f252 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/admin-menu.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/admin-menu.inc @@ -145,7 +145,7 @@
Additional parameters
    [% IF ( CAN_user_parameters_manage_identity_providers) %] -
  • Authentication providers
    • +
  • Identity providers
    • [% END %] [% IF ( CAN_user_parameters_manage_search_targets ) %]
  • Z39.50/SRU servers
    • diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc index cfa6c1afa2..9466b94cf7 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc @@ -851,7 +851,7 @@ [%# identity_providers %] [%- CASE 'manage_identity_providers' -%] - Manage authentication providers + Manage identity providers ([% name | html %]) [%- END -%] -- 2.39.5