Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: token auth documentation is added #72

Merged
merged 3 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/references/data/2018-03-09-reference-data-accesscontrol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Access control"
categories:
- "help-page-category-reference"
- "help-page-subcategory-reference-data"
layout: help-detail
language: en
sidebar_position: 2

---

The Access control section displays options to restrict access to hale»connect services. Toggle «Authentication with Organisation Token» to enable secure service requests. View and download services can be configured separately.

Authentication tokens can be generated on the organisation profile page. Click the «Generate token» button to generate an authentication token. Tokens are valid for two weeks and are stored in the browser cache. The ```kelvin_token``` parameter is automatically added to services protected via token authentication. The token must be included in the URL to access the protected service.

<img src={require("/images/help/en/token_auth.png").default} alt="" title="Generating an authentication token on the organisation profile page" className="img-responsive img-inline-help"/>

Toggle &laquo;Basic Authentication with a fixed Username and Password&raquo; to enable password protection. Basic password protection is not as secure as token authentication. Using this protection mechanism, access to services require that a user enter a username and password.

Changes to access controls require that services are republished to take effect.

Currently, token authentication for series or series sub-datasets is not supported.
21 changes: 21 additions & 0 deletions docs/setup-hc/config-access-control/2015-02-10-access-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Configure access control"
categories:
- "help-page-category-setup-haleconnect"
- "help-page-subcategory-setup-haleconnect-accesscontrol"
layout: help-detail
language: en

---

The access control section defines how published hale»connect services can be accessed. hale»connect supports secure service requests through the use of authentication tokens. Toggle &laquo;Authentication with Organisation Token&raquo; to enable secure service requests. View and download services can be configured separately.

Authentication tokens can be generated on the organisation profile page. Click the &laquo;Generate token&raquo; button to generate an authentication token. Tokens are valid for two weeks and are stored in the browser cache. The ```kelvin_token``` parameter is automatically added to services protected via token authentication. The token must be included in the URL to access the protected service.

<img src={require("/images/help/en/token_auth.png").default} alt="" title="Generating an authentication token on the organisation profile page" className="img-responsive img-inline-help"/>

Basic password protection can also be enabled. Basic password protection is not as secure as token authentication. Toggle &laquo;Basic Authentication with a fixed Username and Password&raquo; to enable password protection. Using this protection mechanism, access to services require that a user enter a username and password.

Changes to access controls require that services are republished to take effect.

Currently, token authentication for series or series sub-datasets is not supported.
8 changes: 8 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,14 @@ const sidebars = {
}
]
},
{
'Configure access control': [
{
type: 'autogenerated',
dirName: 'setup-hc/config-access-control'
}
]
},
{
'Configure source data': [
{
Expand Down
Binary file added static/images/help/de/token_auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/help/en/token_auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading