Skip to content

Commit b75a0d7

Browse files
committed
GSS login to english including screenshots
1 parent b53e150 commit b75a0d7

File tree

3 files changed

+71
-58
lines changed

3 files changed

+71
-58
lines changed

docs/related/collgs/gss_login.md

+71-58
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,90 @@
1-
# Autentizace uživatelů v GSS
2-
Tato sekce popisuje autentizaci uživatelů v systému GSS (Gael Store Service), a to jak interaktivní
3-
přihlášení v grafické komponentě COPSI, tak získání a výměnu tokenů pro strojové použití. Oba způsoby vyžadují registraci.
4-
Návod na použití tohoto software naleznete v sekci o [práci s daty družic Sentinel](./sentinel.md).
1+
## User Authentication in GSS
52

6-
## Grafické rozhraní
3+
This section describes user authentication in the GSS (Gael Store Service) system, including both interactive login via the graphical COPSI component and obtaining and exchanging tokens for machine use.
4+
5+
Both methods require registration.
6+
7+
Instructions on using this software can be found in the section on [working with Sentinel satellite data](./sentinel.md).
8+
9+
## Graphical Interface
710

811
![copsi_first_page.png](copsi_first_page.png)
912

10-
Při přístupu k aplikaci COPSI na adrese [https://collgs.cesnet.cz](https://collgs.cesnet.cz) se zobrazí okno vyžadující přihlášení.
11-
Po potvrzení tlačítkem _Sign In_ budete přesměrováni na výběr komunity, kterou se chcete přihlásit.
13+
When accessing the COPSI application at [https://collgs.cesnet.cz](https://collgs.cesnet.cz), a login window will appear.
14+
15+
After confirming by clicking _Sign In_, you will be redirected to select the community you want to log in with.
1216

1317
![copsi_community.png](copsi_community.png)
1418

15-
Pokud nemáte účet ani v jedné z komunit, zvolte variantu _E-INFRA CZ_.
16-
Ve výběru následně zvolte Vaši přidruženou instituci, nebo zvolte sociální identitu (např. ORCID).
19+
If you do not have an account in any of the communities, choose the option _E-INFRA CZ_. Then select your affiliated institution or choose a social identity (e.g., ORCID).
1720

1821
![copsi_idps.png](copsi_idps.png)
1922

20-
Dokončete přihlášení. Pokud se přihlašujete poprvé, budete přesměrováni na registrační formulář.
21-
V něm vyplňte požadované údaje. Odesláním vyplněné přihlášky se zakládá účet v IAM systému Perun.
22-
Ten je aktivní po dobu dvou let, před expirací účtu obdržíte emailem upozornění na prodloužení platnosti účtu.
23+
Complete the login process. If this is your first login, you will be redirected to a registration form.
24+
25+
Fill in the required details in the form. By submitting the completed application, an account is created in the IAM Perun system.
26+
27+
The account remains active for two years, and you will receive an email notification before the account expires to extend its validity.
2328

2429
![perun_registration.png](perun_registration.png)
2530

26-
Podle vybrané komunity při přihlášení budete buď následně přesměrováni zpět do aplikace Copsi,
27-
nebo Vaše přihláška bude čekat na schválení správcem organizace. V případě, že Vás i po schválení přihlášky aplikace
28-
přesměruje na stránku, která informuje o tom, že jste již registrováni, zkuste do aplikace přistoupit v anonymním okně,
29-
nebo smažte cookies.
31+
Based on the selected community during login, you will either be redirected back to the COPSI application, or your application will wait for approval by the organization administrator.
3032

31-
## Strojový přístup
33+
If, after approval, the application redirects you to a page informing you that you are already registered, try accessing the application in an incognito window or clearing your cookies.
3234

33-
Pro stažení produktů pomocí OData API je nutné k požadavkům přidat autentizaci formou access tokenu.
34-
Tokeny lze získat na adrese [https://keycloak.grid.cesnet.cz/token-portal](https://keycloak.grid.cesnet.cz/token-portal).
35+
## Machine Access
36+
37+
To download products via the OData API, authentication using an access token must be added to the requests.
38+
39+
Tokens can be obtained at [https://keycloak.grid.cesnet.cz/token-portal](https://keycloak.grid.cesnet.cz/token-portal).
3540

3641
![token_portal_intro.png](token_portal_intro.png)
3742

38-
Na stránce portálu pokračujte přes volbu _Authorise_. Pokud tokeny generujete poprvé, bude nutné provést registraci. V opačném
39-
případě se přihlaste, podobně jako v případě přístupu přes [Grafické rozhraní](#grafické-rozhraní).
43+
On the portal page, proceed by selecting _Authorise_. If you are generating tokens for the first time, you will need to register.
44+
45+
Otherwise, log in similarly to the process described in [Graphical Interface](#graphical-interface).
4046

4147
![token_portal.png](token_portal.png)
4248

43-
Na stránce _Generate Tokens_ jsou následující položky:
49+
On the _Generate Tokens_ page, the following items are available:
4450

45-
**Access Token** - slouží k autentizaci a autorizaci při přístupu k API. Má platnost 8 hodin.
51+
**Access Token** - Used for authentication and authorization when accessing the API. It is valid for 8 hours.
4652

47-
**Refresh Token** - slouží k obnovení access tokenu bez nutnosti opakovaného přihlášení. Platí 30 dnů. Při každé
48-
žádosti o výměnu access tokenu se vydá zároveň nový refresh token. Původní refresh token se
49-
tím stává nevalidním, a pro příští výměnu tokenů je nutné použít nový refresh token. Nový refresh token bude mít platnost 30 dnů.
53+
**Refresh Token** - Used to renew the access token without the need to log in again. It is valid for 30 days. Each time an access token is exchanged, a new refresh token is issued, and the previous one becomes invalid. For the next token exchange, the new refresh token must be used. The new refresh token will also have a validity of 30 days.
5054

51-
**Client ID a Client Secret** - slouží pro autentizaci aplikace při výměně tokenů.
55+
**Client ID and Client Secret** - Used to authenticate the application during token exchange.
5256

53-
**Příkaz pro výměnu tokenů** - tímto příkazem při expiraci access tokenu získáte nový access token a refresh token s plnou platností.
57+
**Token Exchange Command** - This command allows you to obtain a new access token and refresh token with full validity when the access token expires.
5458

55-
**Odkaz na správu tokenů** - vede na aplikaci ke správě účtu a tokenů. Zde se můžete odhlásit ze zařízení a revokovat
56-
tak refresh token.
59+
**Token Management Link** - Provides access to the application for managing your account and tokens. Here, you can log out from a device and revoke the refresh token.
5760

58-
### Jak pracovat s tokeny
59-
#### 1. Přístup k API s Access Tokenem
60-
Po získání access tokenu ho přípojíte k požadavkům na API jako autorizační hlavičku:
61+
### How to Work with Tokens
62+
63+
#### 1. Accessing the API with an Access Token
64+
65+
After obtaining an access token, include it in your API requests as an authorization header:
6166

6267
Authorization: Bearer <access_token>
6368

64-
Přidání této hlavičky k požadavkům umožní API ověřit vaši identitu a získat potřebná oprávnění.
65-
Volání GSS OData API pak může vypadat následovně:
69+
Adding this header to your requests allows the API to verify your identity and grant the necessary permissions.
70+
71+
A GSS OData API call may look as follows:
72+
6673
```shell
6774
curl -X GET "https://collgs.cesnet.cz/odata/v1/Products?\$filter=startswith(Name,'S1')%20and%20contains(Name,'SLC')" \
6875
-H "Authorization: Bearer $ACCESS_TOKEN" \
6976
-H "Accept: application/json"
7077
```
7178

72-
#### 2. Obnovení access tokenu pomocí refresh tokenu
73-
Jakmile access token vyprší, místo opětovného přihlášení můžete využít refresh token k získání nového access tokenu.
74-
Proces probíhá zasláním POST požadavku, který je předpřipravený jako _curl_ dotaz
75-
na stránce Token portálu. Tento požadavek využívá volání Pythonu, pokud využíváte Python verzi 3, nahraďte v příkazu
76-
_python_ za _python3_. Tento požadavek Vám spolu s dalšími informacemi vydá nový access token, který má platnost 8 hodin,
77-
a refresh token s platností 30 dní.
78-
Ve formátu JSON bude odpověď vypadat následovně:
79+
#### 2. Refreshing the Access Token Using the Refresh Token
80+
81+
When the access token expires, you can use the refresh token to obtain a new access token without logging in again.
82+
83+
The process involves sending a POST request, which is pre-configured as a _curl_ command on the Token Portal page. If you are using Python version 3, you may need to replace _python_ with _python3_ in the command.
84+
85+
This request will return a new access token with an 8-hour validity, along with a refresh token valid for 30 days.
86+
87+
The response in JSON format will look as follows:
7988

8089
{
8190
"access_token": "eyJh....gywQ",
@@ -89,27 +98,31 @@ Ve formátu JSON bude odpověď vypadat následovně:
8998
"scope": "openid email profile"
9099
}
91100

92-
Nový access token lze dále využívat pro dotazy v GSS, novým refresh tokenem nahraďte ten starý.
101+
You can use the new access token for further requests in GSS, and replace the old refresh token with the new one.
102+
103+
#### 3. Secure Token Storage
93104

94-
#### 3. Bezpečné ukládání tokenů
95-
**Access token**: Ukládejte v paměti (např. v proměnné nebo cache) pouze po dobu, kdy je aktivní. Jelikož má kratší platnost,
96-
není potřeba jej dlouhodobě uchovávat.
105+
**Access Token**:
106+
Store in memory (e.g., a variable or cache) only while it is active. Since it has a shorter validity period, there is no need for long-term storage.
97107

98-
**Refresh token**: Doporučuje se ukládat do bezpečného úložiště, např. do databáze nebo do šifrovaného úložiště.
99-
Refresh token má delší platnost, a proto by měl být uložen na bezpečném místě s omezeným přístupem.
108+
**Refresh Token**:
109+
It is recommended to store in a secure location, such as a database or encrypted storage.
100110

101-
#### 4. Revokování tokenů
102-
V případě potřeby lze tokeny revokovat pomocí aplikace na správu účtů, která je odkazována
103-
ve spodní části Token portálu. Odhlášení (revokace tokenu) se nachází v části Account security > Device activity.
104-
Volbou _Sign out_ se odhlásí vybrané zařízení, volba _Sign out all devices_ slouží pro hromadné odhlášení.
111+
Since the refresh token has a longer validity period, it should be stored securely with limited access.
112+
113+
#### 4. Token Revocation
114+
115+
If necessary, tokens can be revoked using the account management application linked at the bottom of the Token Portal.
116+
117+
Revocation (logging out) is located under **Account Security > Device Activity**.
118+
119+
Use the _Sign out_ option to log out a specific device, or _Sign out all devices_ for a complete logout.
105120

106121
![token_revoke.png](token_revoke.png)
107122

108-
### Výměna tokenů
109-
V případě, že již pracujete s tokeny z EGI Check-inu, je možné je bez nutnosti dalšího přihlášení vyměnit
110-
za tokeny umožňující přístup do systému GSS. V takovém případě odešlete platný access token vydaný EGI Check-inem
111-
metodou POST na endpoint [https://keycloak.grid.cesnet.cz/realms/collgs/protocol/openid-connect/token](https://keycloak.grid.cesnet.cz/realms/collgs/protocol/openid-connect/token) a do těla požadavku
112-
připojíte následující:
123+
### Token Exchange
124+
125+
If you are already working with tokens from EGI Check-in, it is possible to exchange them for tokens granting access to the GSS system without further login. In this case, send a valid access token issued by EGI Check-in via POST method to the endpoint [https://keycloak.grid.cesnet.cz/realms/collgs/protocol/openid-connect/token](https://keycloak.grid.cesnet.cz/realms/collgs/protocol/openid-connect/token) and attach the following to the request body:
113126

114127
{
115128
"client_id": "token-exchange",
@@ -118,4 +131,4 @@ připojíte následující:
118131
"subject_issuer": "https://aai.egi.eu/auth/realms/egi"
119132
}
120133

121-
V odpovědi získáte access token, který lze použít pro volání API GSS.
134+
In the response, you will receive an access token that can be used for GSS API calls.
-7.97 KB
Loading

docs/related/collgs/token_portal.png

-82.7 KB
Loading

0 commit comments

Comments
 (0)