From 403900ee4a709d3cc1e182b1c5bbe0c8329e5987 Mon Sep 17 00:00:00 2001 From: camilner-hdr Date: Wed, 3 Jul 2024 11:35:16 +0100 Subject: [PATCH 1/3] Updated private apps and menu order --- docs/fe-creating-an-app.md | 103 ------------------ ...-fma.md => integrations-hdruk-datasets.md} | 0 docs/private-app-create.md | 92 ++++++++++++++++ docs/private-app-manage.md | 22 ++++ docs/private-app-what.md | 15 +++ mkdocs.yml | 97 +++++++++-------- 6 files changed, 180 insertions(+), 149 deletions(-) delete mode 100644 docs/fe-creating-an-app.md rename docs/{fe-creating-fma.md => integrations-hdruk-datasets.md} (100%) create mode 100644 docs/private-app-create.md create mode 100644 docs/private-app-manage.md create mode 100644 docs/private-app-what.md diff --git a/docs/fe-creating-an-app.md b/docs/fe-creating-an-app.md deleted file mode 100644 index e0404e4..0000000 --- a/docs/fe-creating-an-app.md +++ /dev/null @@ -1,103 +0,0 @@ -## Introduction - -The API Management Service enables data custodians to streamline metadata transfer to the Gateway -through the creation of API keys. This guide offers step-by-step instructions for setting up and managing the -API self-service on the Gateway. - -## Create a new API key - -The API management feature allows data custodians to create API keys and ?link them to the Gateway. -Please note that HDR UK cannot create application registrations on behalf of users. - -### Step 1: Sign into the Gateway - -Sign in to the Gateway with your preferred route. Make sure you have a Team set up on the Gateway. If -you need assistance with this step, contact the HDR UK technology team using the link below. - -[https://www.healthdatagateway.org/about/contact-us](https://www.healthdatagateway.org/about/contact-us) - -### Step 2: Access the Gateway API management page - -If you have the necessary permissions (Team admin or Developer), you can access the service by following -these steps: - -- Navigate to the Team Management page for your Team, by clicking on your name in the top-right corner of the window, and selecting the appropriate Team name in the dropdown list. -- In the menu on the left-hand side, select `Integrations > API management`. -- Click on “Create API-key” to initiate the process (Fig 1) - -![](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/4dd0dbc8-10ae-46a0-b567-9c98c3367987) -_Fig 1: Create a new API key_ - -### Step 3: Create a new API Key - -When creating a new API Key, provide the following information (Fig 2): - -- Public app name: Name of the app you wish to create. -- Description: A brief description of the app. -- Notification contacts: User accounts for relevant notification recipients. -- After completing the required fields, click "Save & Continue" to proceed to the permissions page. - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/5667e21e-576d-4aec-9a96-92448c4375fc) -_Fig 2: App info_ - -### Step 4: Define Permissions - -Use the permissions matrix (Fig 3) to assign the appropriate scope and permissions for secure integration. -Your application will only synchronise data within its assigned scope. Application permissions are the -responsibility of your publisher team. - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/6146a122-e2fb-4daf-a514-f69d2008e178) -_Fig 3: Permissions matrix_ - -It is recommended that when creating Apps on the Gateway you only assign permissions that the app will -need. We would suggest a minimal permissions approach, for instance: if an App is going to be managing -Datasets we would recommend `datasets.create`, `datasets.read`, `datasets.update` and `datasets.delete`. There -would be no need to grant the app permissions to manage Tools or Data Uses. - -Once the desired permissions scope is set, click "Save & Finish" to complete the API setup. Please note, at -the current time, only functionality for Datasets has been enabled on the Gateway. - -Click on the newly-created app\s entry. The API key will be revealed in the "Authentication" tab after completing the app setup (Fig 4). The Client ID is -crucial for configuring your API settings; ensure to copy it and apply it to your API settings accordingly. - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/2c0ec13f-bbe8-4a07-94ee-adc9b8c5620a) -_Fig 4: Authentication_ - -## Manage APIs - -### List of APIs - -Clicking on “Manage API” (Fig 5) displays a list of enabled and disabled APIs for easy management and -monitoring of apps. - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/f363f047-6d33-4030-bda1-3fbedd612f7c) -_Fig 5: Manage API_ - -Each app is listed with its title, creation date, APP ID, and a brief description. The list (Fig 6) can be filtered -by App status. - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/75c7784e-35f4-4a40-b58a-0fb8007c0a0b) -_Fig 6: List of Apps_ - -### Modifying an API - -Select the app you wish to modify, and you can update the app information and permissions settings. -It's important to note that deleting an API is an irreversible action. - -### After updating the app: - -Once you've updated the app, click "Save" to store the updated information on the Gateway. A pop-up -window will confirm the successful application update. Additionally, a new Client ID will be generated in the -Authentication tab, which you need to copy and replace in your API settings. This final step ensures -seamless integration and efficient data synchronisation. - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/ec7175a0-1871-42a2-8450-466d6503b13b) -_Fig 7_ - -### Caveat - -It is important to note that there are several methods of managing metadata on the Gateway. In the -instance where metadata is onboarded onto the gateway though Entity Federation (FMA), these datasets -will not be editable via the User Interface, OR via the API and will result in a 403 forbidden response being -returned. In cases where a Data Partner wants to manage data via API and Federation, federated items will -not be editable via API. diff --git a/docs/fe-creating-fma.md b/docs/integrations-hdruk-datasets.md similarity index 100% rename from docs/fe-creating-fma.md rename to docs/integrations-hdruk-datasets.md diff --git a/docs/private-app-create.md b/docs/private-app-create.md new file mode 100644 index 0000000..401a39b --- /dev/null +++ b/docs/private-app-create.md @@ -0,0 +1,92 @@ +## Glossary + +|Term|Description| +|------|-------------| +|Private App|An application/service/ETL tool that is developed by a user who wants to be able to programmatically interact with the Gateway. | +|AppID and ClientID |Tokens that are generated when creating a new Private App. Each Private App will have a unique AppID and ClientID that needs to be sent with each API request to authenticate and approve the action. | +|Team Admin/Developer |A role that can be assigned to a user when they are part of a ‘team’ on the Gateway. Please see the documentation [here](https://www.healthdatagateway.org/about/how-to-manage-teams-on-the-gateway) on roles and permissions on the Gateway. | +|Authenticated API Endpoint |While a lot of the Gateway APIs are accessible without authentication, any endpoint changing data requires authentication. The ClientID acts as an authentication token. | + +## Introduction + +The Private Apps feature enables developers to create a Private App and corresponding ClientID which is used as a token to authenticate requests made to the Gateway API. This guide offers step-by-step instructions for setting up and managing Private Apps on the Gateway. + +## How to Create a new Private App + +_Please note that HDR UK cannot create Private Apps on behalf of users._ + +### Step 1: Sign into the Gateway + +Sign in to the Gateway with your preferred login provider. Make sure you have a ‘team’ set up on the Gateway. If you are not a member of an existing ‘team’ you may need to ask a Team Admin to add you to the team (see documentation [here](https://www.healthdatagateway.org/about/how-to-manage-teams-on-the-gateway) on how to manage ‘team’ on the Gateway). If you need assistance with this step, contact the HDR UK Technology Team using the link below. + +[https://www.healthdatagateway.org/about/contact-us](https://www.healthdatagateway.org/about/contact-us) + + +### Step 2: Access the Gateway Private App management page + +Providing you have the necessary roles (Team Admin or Developer), you can access the feature by following these steps: + +- Navigate to your Team Management page by clicking on your name in the top-right corner of the window, and selecting the your ’team’ from the dropdown list. +- In the menu on the left-hand side, select Integrations > Private Apps. +- Click on the Create Private App button to initiate the process (Fig 1) + +![](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/4dd0dbc8-10ae-46a0-b567-9c98c3367987) +_Fig 1: How to create a new Private App_ + +### Step 3: Enter Private App details + +To create a new Private App you will need to enter the following information (Fig 2): + +- Public App name: Name of the App you wish to create. +- Description: A brief description of the App. +- Notification contacts: Gateway user accounts for relevant notification recipients. + +![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/5667e21e-576d-4aec-9a96-92448c4375fc) +_Fig 2: App info_ + + +### Step 4: Define permissions + +Use the permissions matrix (Fig 3) to assign the appropriate permissions for secure integration. Your App will only be allowed to use APIs for the permissions you have defined. App permissions are the responsibility of your ‘team’. + +If you have any questions about defining Private App permissions, please contact the HDR UK Technology Team using the URL below. + +[https://www.healthdatagateway.org/about/contact-us ](https://www.healthdatagateway.org/about/contact-us) + +![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/6146a122-e2fb-4daf-a514-f69d2008e178) +_Fig 3: Permissions matrix_ + +We recommend only assigning permissions that the App will need and suggest a minimal permissions approach, for example: if an App is going to be managing Datasets we would recommend `datasets.create`,  `datasets.read`,  `datasets.update`,  and `datasets.delete`. There would be no need to grant the App permissions to manage Tools or Data Uses in this instance. + +Once the desired permissions are set, click the Save & Finish button to complete the Private App setup. Please note, at the current time, only functionality for Datasets has been enabled on the Gateway. + +### Step 5: Authentication Keys + +Click on the newly created App entry. The AppID and ClientID will be accessible in the Authentication tab after completing the App setup (Fig 4). Both the AppID and Client ID are crucial as any requests to an authenticated Gateway API endpoint will require these to validate the request. Please see the documentation _link_ which demonstrates how to make an authenticated API request to the Gateway. + +![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/2c0ec13f-bbe8-4a07-94ee-adc9b8c5620a) +_Fig 4: Authentication_ + + +## Manage APIs + +### List of Private Apps + +Via the Private App management page, click on the Manage Private Apps button (Fig 5) to see a list of enabled and disabled Private Apps . + +![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/f363f047-6d33-4030-bda1-3fbedd612f7c) +_Fig 5: Manage Private Apps_ + +Each App is listed with its title, creation date, App ID, and a brief description. The list (Fig 6) can be filtered by App status. + +![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/75c7784e-35f4-4a40-b58a-0fb8007c0a0b) +_Fig 6: List of Private Apps_ + + +### Update a Private App + +Select the App you wish to modify, and then update the App information and permissions settings. Click the Save button to store the updated information on the Gateway. A pop-up window will confirm the successful App update . + +The App’s ClientID will not automatically regenerate when permissions or information is changed. If you are making significant changes to the permissions of an App we recommend either disabling or deleting the old Private App and creating a new one. + +Please note that deleting an App is an irreversible action. \ No newline at end of file diff --git a/docs/private-app-manage.md b/docs/private-app-manage.md new file mode 100644 index 0000000..3d2c30e --- /dev/null +++ b/docs/private-app-manage.md @@ -0,0 +1,22 @@ +## How to manage Private Apps + +### List Private Apps + +Via the Private App management page, click on the Manage Private Apps button (Fig 1) to see a list of enabled and disabled Private Apps . + +![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/f363f047-6d33-4030-bda1-3fbedd612f7c) +_Fig 1: Manage Private Apps_ + +Each App is listed with its title, creation date, App ID, and a brief description. The list (Fig 2) can be filtered by App status. + +![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/75c7784e-35f4-4a40-b58a-0fb8007c0a0b) +_Fig 2: List of Private Apps_ + + +### Update a Private App + +Select the App you wish to modify, and then update the App information and permissions settings. Click the Save button to store the updated information on the Gateway. A pop-up window will confirm the successful App update . + +The App’s ClientID will not automatically regenerate when permissions or information is changed. If you are making significant changes to the permissions of an App we recommend either disabling or deleting the old Private App and creating a new one. + +Please note that deleting an App is an irreversible action. \ No newline at end of file diff --git a/docs/private-app-what.md b/docs/private-app-what.md new file mode 100644 index 0000000..bd17a22 --- /dev/null +++ b/docs/private-app-what.md @@ -0,0 +1,15 @@ +## What is a Private App + +Private apps allow you to use the Gateway’s APIs to access specific data from your Gateway Team. You can define what features/services each Private App is able to access from the management page. An access token is generated called the “ClientID” which must be sent with each request to the Gateway APIs. + +Private Apps are perfect for users who want to programmatically interact with the features and data on the Gateway and how you interact with the Gateway APIs is entirely in your control. + + +## Glossary + +|Term|Description| +|------|-------------| +|Private App|An application/service/ETL tool that is developed by a user who wants to be able to programmatically interact with the Gateway. | +|AppID and ClientID |Tokens that are generated when creating a new Private App. Each Private App will have a unique AppID and ClientID that needs to be sent with each API request to authenticate and approve the action. | +|Team Admin/Developer |A role that can be assigned to a user when they are part of a ‘team’ on the Gateway. Please see the documentation [here](https://www.healthdatagateway.org/about/how-to-manage-teams-on-the-gateway) on roles and permissions on the Gateway. | +|Authenticated API Endpoint |While a lot of the Gateway APIs are accessible without authentication, any endpoint changing data requires authentication. The ClientID acts as an authentication token. | \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a856f7f..00f7f50 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,53 +1,58 @@ -site_name: Gateway Integrations Guide +site_name: Gateway Technical Guides theme: - name: material - #custom_dir: docs/overrides - palette: - scheme: hdruk - logo: images/logo.png - favicon: images/favicon.png - features: - - navigation.footer - - navigation.instant - - navigation.expand - - content.code.copy - - content.code.annotate - - toc.follow + name: material + #custom_dir: docs/overrides + palette: + scheme: hdruk + logo: images/logo.png + favicon: images/favicon.png + features: + - navigation.footer + - navigation.instant + - navigation.expand + - content.code.copy + - content.code.annotate + - toc.follow extra_css: - - stylesheets/custom.css + - stylesheets/custom.css nav: - - Home: index.md - - Gateway 2.0: - - Login: fe-login.md - - API Management: fe-creating-an-app.md - - FMA Setup: fe-creating-fma.md - - Metadata: - - Create: creating-metadata.md - - Validate: metadata-validation.md - - Exemplars: example-metadata.md - - Using the API: - - Datasets: - - Create: creating-a-dataset.md - - Retrieve: retrieving-a-dataset.md - - Update: updating-a-dataset.md - - Delete: deleting-a-dataset.md - - Using FMA: - - Test Server Example: fma-test-server.md + - Home: index.md + - Accessing Our APIs: + - What is a Private App: private-app-what.md + - Create a Private App: private-app-create.md + - Manage a Private App: private-app-manage.md + - Using the Gateway: + - Login: fe-login.md + - FMA Setup: fe-creating-fma.md + - Integrations: + - HDR UK Datasets Integration: integrations-hdruk-metadata.md + - Metadata: + - Create: creating-metadata.md + - Validate: metadata-validation.md + - Exemplars: example-metadata.md + - Using the API: + - Datasets: + - Create: creating-a-dataset.md + - Retrieve: retrieving-a-dataset.md + - Update: updating-a-dataset.md + - Delete: deleting-a-dataset.md + - Using FMA: + - Test Server Example: fma-test-server.md plugins: - - search + - search markdown_extensions: - - admonition - - pymdownx.details - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.inlinehilite - - pymdownx.snippets - - pymdownx.superfences - - pymdownx.tabbed: - alternate_style: true - - attr_list - - md_in_html + - admonition + - pymdownx.details + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - attr_list + - md_in_html From 97c7461a6da4581ebddd594e39d1844da712741e Mon Sep 17 00:00:00 2001 From: camilner-hdr Date: Wed, 3 Jul 2024 20:02:22 +0100 Subject: [PATCH 2/3] Range of updates as per pull/5 --- docs/private-app-create.md | 51 ++++++++------------------------------ docs/private-app-manage.md | 14 +++++------ docs/private-app-what.md | 4 ++- mkdocs.yml | 5 ++-- 4 files changed, 23 insertions(+), 51 deletions(-) diff --git a/docs/private-app-create.md b/docs/private-app-create.md index 401a39b..069a340 100644 --- a/docs/private-app-create.md +++ b/docs/private-app-create.md @@ -1,15 +1,6 @@ -## Glossary +# Introduction -|Term|Description| -|------|-------------| -|Private App|An application/service/ETL tool that is developed by a user who wants to be able to programmatically interact with the Gateway. | -|AppID and ClientID |Tokens that are generated when creating a new Private App. Each Private App will have a unique AppID and ClientID that needs to be sent with each API request to authenticate and approve the action. | -|Team Admin/Developer |A role that can be assigned to a user when they are part of a ‘team’ on the Gateway. Please see the documentation [here](https://www.healthdatagateway.org/about/how-to-manage-teams-on-the-gateway) on roles and permissions on the Gateway. | -|Authenticated API Endpoint |While a lot of the Gateway APIs are accessible without authentication, any endpoint changing data requires authentication. The ClientID acts as an authentication token. | - -## Introduction - -The Private Apps feature enables developers to create a Private App and corresponding ClientID which is used as a token to authenticate requests made to the Gateway API. This guide offers step-by-step instructions for setting up and managing Private Apps on the Gateway. +The Private Apps feature enables Developers to create a Private App and corresponding ClientID which is used as a token to authenticate requests made to the Gateway API. This guide offers step-by-step instructions for setting up and managing Private Apps on the Gateway. ## How to Create a new Private App @@ -19,7 +10,7 @@ _Please note that HDR UK cannot create Private Apps on behalf of users._ Sign in to the Gateway with your preferred login provider. Make sure you have a ‘team’ set up on the Gateway. If you are not a member of an existing ‘team’ you may need to ask a Team Admin to add you to the team (see documentation [here](https://www.healthdatagateway.org/about/how-to-manage-teams-on-the-gateway) on how to manage ‘team’ on the Gateway). If you need assistance with this step, contact the HDR UK Technology Team using the link below. -[https://www.healthdatagateway.org/about/contact-us](https://www.healthdatagateway.org/about/contact-us) +[https://hdruk.atlassian.net/servicedesk/customer/portal/7/group/14/create/29](https://hdruk.atlassian.net/servicedesk/customer/portal/7/group/14/create/29) ### Step 2: Access the Gateway Private App management page @@ -28,7 +19,7 @@ Providing you have the necessary roles (Team Admin or Developer), you can access - Navigate to your Team Management page by clicking on your name in the top-right corner of the window, and selecting the your ’team’ from the dropdown list. - In the menu on the left-hand side, select Integrations > Private Apps. -- Click on the Create Private App button to initiate the process (Fig 1) +- Click on the Create Private App button to initiate the process (Fig 1) ![](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/4dd0dbc8-10ae-46a0-b567-9c98c3367987) _Fig 1: How to create a new Private App_ @@ -41,6 +32,8 @@ To create a new Private App you will need to enter the following information (Fi - Description: A brief description of the App. - Notification contacts: Gateway user accounts for relevant notification recipients. +After completing the required fields, click the Save & Continue button to proceed to the permissions page. + ![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/5667e21e-576d-4aec-9a96-92448c4375fc) _Fig 2: App info_ @@ -51,42 +44,20 @@ Use the permissions matrix (Fig 3) to assign the appropriate permissions for sec If you have any questions about defining Private App permissions, please contact the HDR UK Technology Team using the URL below. -[https://www.healthdatagateway.org/about/contact-us ](https://www.healthdatagateway.org/about/contact-us) +[https://hdruk.atlassian.net/servicedesk/customer/portal/7/group/14/create/29](https://hdruk.atlassian.net/servicedesk/customer/portal/7/group/14/create/29) ![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/6146a122-e2fb-4daf-a514-f69d2008e178) _Fig 3: Permissions matrix_ We recommend only assigning permissions that the App will need and suggest a minimal permissions approach, for example: if an App is going to be managing Datasets we would recommend `datasets.create`,  `datasets.read`,  `datasets.update`,  and `datasets.delete`. There would be no need to grant the App permissions to manage Tools or Data Uses in this instance. -Once the desired permissions are set, click the Save & Finish button to complete the Private App setup. Please note, at the current time, only functionality for Datasets has been enabled on the Gateway. +Once the desired permissions are set, click the Save & Finish button to complete the Private App setup. + +**Please note, at the current time, only functionality for Datasets has been enabled on the Gateway.** ### Step 5: Authentication Keys Click on the newly created App entry. The AppID and ClientID will be accessible in the Authentication tab after completing the App setup (Fig 4). Both the AppID and Client ID are crucial as any requests to an authenticated Gateway API endpoint will require these to validate the request. Please see the documentation _link_ which demonstrates how to make an authenticated API request to the Gateway. ![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/2c0ec13f-bbe8-4a07-94ee-adc9b8c5620a) -_Fig 4: Authentication_ - - -## Manage APIs - -### List of Private Apps - -Via the Private App management page, click on the Manage Private Apps button (Fig 5) to see a list of enabled and disabled Private Apps . - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/f363f047-6d33-4030-bda1-3fbedd612f7c) -_Fig 5: Manage Private Apps_ - -Each App is listed with its title, creation date, App ID, and a brief description. The list (Fig 6) can be filtered by App status. - -![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/75c7784e-35f4-4a40-b58a-0fb8007c0a0b) -_Fig 6: List of Private Apps_ - - -### Update a Private App - -Select the App you wish to modify, and then update the App information and permissions settings. Click the Save button to store the updated information on the Gateway. A pop-up window will confirm the successful App update . - -The App’s ClientID will not automatically regenerate when permissions or information is changed. If you are making significant changes to the permissions of an App we recommend either disabling or deleting the old Private App and creating a new one. - -Please note that deleting an App is an irreversible action. \ No newline at end of file +_Fig 4: Authentication_ \ No newline at end of file diff --git a/docs/private-app-manage.md b/docs/private-app-manage.md index 3d2c30e..3dde7a8 100644 --- a/docs/private-app-manage.md +++ b/docs/private-app-manage.md @@ -1,8 +1,8 @@ -## How to manage Private Apps +# How to manage Private Apps -### List Private Apps +## List Private Apps -Via the Private App management page, click on the Manage Private Apps button (Fig 1) to see a list of enabled and disabled Private Apps . +Via the Private App management page, click on the Manage Private Apps button (Fig 1) to see a list of enabled and disabled Private Apps. ![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/f363f047-6d33-4030-bda1-3fbedd612f7c) _Fig 1: Manage Private Apps_ @@ -13,10 +13,10 @@ Each App is listed with its title, creation date, App ID, and a brief descriptio _Fig 2: List of Private Apps_ -### Update a Private App +## Update a Private App -Select the App you wish to modify, and then update the App information and permissions settings. Click the Save button to store the updated information on the Gateway. A pop-up window will confirm the successful App update . +Select the App you wish to modify, and then update the App information and permissions settings. Click the Save button to store the updated information on the Gateway. A pop-up window will confirm the successful App update. -The App’s ClientID will not automatically regenerate when permissions or information is changed. If you are making significant changes to the permissions of an App we recommend either disabling or deleting the old Private App and creating a new one. +**The App’s ClientID will not automatically regenerate when permissions or information is changed. If you are making significant changes to the permissions of an App we recommend either disabling or deleting the old Private App and creating a new one.** -Please note that deleting an App is an irreversible action. \ No newline at end of file +**Please note that deleting an App is an irreversible action.** \ No newline at end of file diff --git a/docs/private-app-what.md b/docs/private-app-what.md index bd17a22..7799161 100644 --- a/docs/private-app-what.md +++ b/docs/private-app-what.md @@ -1,6 +1,8 @@ +# Private Apps + ## What is a Private App -Private apps allow you to use the Gateway’s APIs to access specific data from your Gateway Team. You can define what features/services each Private App is able to access from the management page. An access token is generated called the “ClientID” which must be sent with each request to the Gateway APIs. +Private apps allow you to use the Gateway’s APIs to access specific data from your Gateway Team. You can define what features/services each Private App is able to access from the management page. Two access tokens will be generated called the "AppID" and “ClientID”, both of which must be sent with each request to the Gateway APIs. Private Apps are perfect for users who want to programmatically interact with the features and data on the Gateway and how you interact with the Gateway APIs is entirely in your control. diff --git a/mkdocs.yml b/mkdocs.yml index 00f7f50..bc0b413 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -24,9 +24,8 @@ nav: - Manage a Private App: private-app-manage.md - Using the Gateway: - Login: fe-login.md - - FMA Setup: fe-creating-fma.md - Integrations: - - HDR UK Datasets Integration: integrations-hdruk-metadata.md + - HDR UK Datasets Integration: integrations-hdruk-datasets.md - Metadata: - Create: creating-metadata.md - Validate: metadata-validation.md @@ -37,7 +36,7 @@ nav: - Retrieve: retrieving-a-dataset.md - Update: updating-a-dataset.md - Delete: deleting-a-dataset.md - - Using FMA: + - Using HDR uk Datasets Federation: - Test Server Example: fma-test-server.md plugins: - search From adf74d682ebfd2f2b2e4d0a1404ab867f5742776 Mon Sep 17 00:00:00 2001 From: camilner-hdr Date: Thu, 4 Jul 2024 11:01:11 +0100 Subject: [PATCH 3/3] Updated capitalisation on YAML --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index bc0b413..130d2cd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,7 +36,7 @@ nav: - Retrieve: retrieving-a-dataset.md - Update: updating-a-dataset.md - Delete: deleting-a-dataset.md - - Using HDR uk Datasets Federation: + - Using HDR UK Datasets Federation: - Test Server Example: fma-test-server.md plugins: - search