Merge pull request #813 from GSA/apitoken-name

X-CKAN-API-Key as apitoken_header_name
GSA · Feb 14, 2025 · 30461f0 · 30461f0
2 parents 336e976 + 66780c5
commit 30461f0
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/.env b/.env
@@ -75,7 +75,7 @@ CKAN__AUTH__CREATE_USER_VIA_WEB=false
 CKAN__AUTH__ROLES_THAT_CASCADE_TO_SUB_GROUPS=admin
 CKAN__AUTH__PUBLIC_USER_DETAILS=false
 
-CKAN___APITOKEN_HEADER_NAME=Authorization
+CKAN___APITOKEN_HEADER_NAME=X-CKAN-API-Key
 
 # Xloader Settings
 # Even though datapusher is ignored, we still have to include a URL in the config?

diff --git a/config/ckan.ini b/config/ckan.ini
@@ -110,7 +110,7 @@ ckan.auth.create_user_via_web = false
 ckan.auth.roles_that_cascade_to_sub_groups = admin
 ckan.auth.public_user_details = false
 
-apitoken_header_name = Authorization
+apitoken_header_name = X-CKAN-API-Key
 
 ## Search Settings
 #ckan.site_id = $CKAN_SITE_ID

diff --git a/e2e/cypress/integration/ckan_token.cy.js b/e2e/cypress/integration/ckan_token.cy.js
@@ -32,7 +32,7 @@ describe('CKAN Token', () => {
             method: 'GET',
             url: '/api/action/package_search',
             headers: {
-                'Authorization': token_data.api_token
+                'X-CKAN-API-Key': token_data.api_token
             }
         }).then((response) => {
             expect(response.status).to.eq(200);

diff --git a/e2e/cypress/integration/dataset.cy.js b/e2e/cypress/integration/dataset.cy.js
@@ -46,7 +46,7 @@ describe('Dataset', () => {
                 body: formData,
                 headers: {
                     'Content-Type': 'multipart/form-data',
-                    'Authorization': token_data.api_token
+                    'X-CKAN-API-Key': token_data.api_token
                 }
             }).then((response) => {
                 expect(response.status).to.eq(200);

diff --git a/e2e/cypress/integration/datastore.cy.js b/e2e/cypress/integration/datastore.cy.js
@@ -19,7 +19,7 @@ describe('Datastore', () => {
             method: 'GET',
             url: '/api/3/action/datastore_search?resource_id=_table_metadata',
             headers: {
-                'Authorization': token_data.api_token
+                'X-CKAN-API-Key': token_data.api_token
             }
         }).should((response) => {
             expect(response.body).to.have.property('success', true)
@@ -40,7 +40,7 @@ describe('Datastore', () => {
                     'headers': {
                         'cache-control': 'no-cache',
                         'content-type': 'application/json',
-                        'Authorization': token_data.api_token
+                        'X-CKAN-API-Key': token_data.api_token
                     },
                     body: JSON.stringify({
                         "resource": {"package_id": response.body.result.id},
@@ -61,7 +61,7 @@ describe('Datastore', () => {
             method: 'GET',
             url: '/api/action/package_show?id=test-dataset-1',
             headers: {
-                'Authorization': token_data.api_token
+                'X-CKAN-API-Key': token_data.api_token
             }
         }).then((response) => {
             expect(response.body).to.have.property('success', true);
@@ -70,7 +70,7 @@ describe('Datastore', () => {
                 method: 'GET',
                 url: `/api/action/datastore_search?resource_id=${resource_id}`,
                 headers: {
-                    'Authorization': token_data.api_token
+                    'X-CKAN-API-Key': token_data.api_token
                 }
             }).should((response) => {
                 expect(response.body).to.have.property('success', true);
@@ -85,7 +85,7 @@ describe('Datastore', () => {
             method: 'GET',
             url: '/api/action/package_show?id=test-dataset-1',
             headers: {
-                'Authorization': token_data.api_token
+                'X-CKAN-API-Key': token_data.api_token
             }
         }).then((response) => {
             expect(response.body).to.have.property('success', true);
@@ -97,7 +97,7 @@ describe('Datastore', () => {
                 'headers': {
                     'cache-control': 'no-cache',
                     'content-type': 'application/json',
-                    'Authorization': token_data.api_token
+                    'X-CKAN-API-Key': token_data.api_token
                 },
                 body: JSON.stringify({
                     "resource_id": resource_id,

diff --git a/e2e/cypress/support/command.js b/e2e/cypress/support/command.js
@@ -99,7 +99,7 @@ Cypress.Commands.add('revoke_token', (tokenName) => {
         url: '/api/3/action/api_token_revoke',
         method: 'POST',
         headers: {
-            'Authorization': token_data.api_token,
+            'X-CKAN-API-Key': token_data.api_token,
             'Content-Type': 'application/json'
         },
         body: {jti: token_data.jti}
@@ -141,7 +141,7 @@ Cypress.Commands.add('create_organization', (orgName, orgDesc, extras = null) =>
         url: '/api/action/organization_create',
         method: 'POST',
         headers: {
-            'Authorization': token_data.api_token,
+            'X-CKAN-API-Key': token_data.api_token,
             'Content-Type': 'application/json'
         },
         body: {
@@ -180,7 +180,7 @@ Cypress.Commands.add('delete_organization', (orgName) => {
         method: 'POST',
         failOnStatusCode: false,
         headers: {
-            'Authorization': token_data.api_token,
+            'X-CKAN-API-Key': token_data.api_token,
             'Content-Type': 'application/json'
         },
         body: {
@@ -193,7 +193,7 @@ Cypress.Commands.add('delete_organization', (orgName) => {
         method: 'POST',
         failOnStatusCode: false,
         headers: {
-            'Authorization': token_data.api_token,
+            'X-CKAN-API-Key': token_data.api_token,
             'Content-Type': 'application/json'
         },
         body: {
@@ -215,7 +215,7 @@ Cypress.Commands.add('delete_dataset', (datasetName) => {
         method: 'POST',
         failOnStatusCode: false,
         headers: {
-            'Authorization': token_data.api_token,
+            'X-CKAN-API-Key': token_data.api_token,
             'Content-Type': 'application/json'
         },
         body: {
@@ -289,7 +289,7 @@ Cypress.Commands.add('create_dataset', (ckan_dataset) => {
         headers: {
             'cache-control': 'no-cache',
             'content-type': 'application/json',
-            'Authorization': token_data.api_token,
+            'X-CKAN-API-Key': token_data.api_token,
         },
         body: JSON.stringify(ckan_dataset),
     };