You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Portal User Guide.md
+36-9Lines changed: 36 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1257,28 +1257,32 @@ For example, you have 3 operations - GET /api/v1/packages, GET /api/v1/package/{
1257
1257
1258
1258
When you specify value of the parameter, there is an option "Recalculate groups in all published versions". If you select it, then after saving the value of the parameter, the system re-calculates groups for all existing versions of current package. If you do not select recalculate option, then configuration will be applied only for the newly published versions.
1259
1259
1260
-
**Versions**
1260
+
## Versions
1261
1261
The Versions tab contains a list of all versions published in the current package or dashboard. You can edit status and/or labels of the version, to do this, hover over the row with the required version and click **Edit**.
1262
1262
1263
1263
On the current page you can also delete version (with all its revisions). To do this, hover over the row with the required version and click **Delete**.
1264
1264
1265
-
**Access Tokens**
1266
-
In the Access Tokens tab contains you can generate API key for the current group/package/dashboard. API key does not have a period of life and it must be stored on a client side because it shows only once after generation.
1265
+
## Access Tokens
1267
1266
1268
-
To generate an access token, you need to fill the following fields:
1269
-
- Name - unique API key name
1267
+
API key allows you to authenticate to APIHUB when using APIHUB API. Unlike a Bearer token or [personal access token](#personal-access-token), an API key does not identify the principal (user). Instead, it is primarily used to identify the calling project—such as an application or website—making the APIHUB API call.
1268
+
API key is associated with a specific workspace, group, package, or dashboard, limiting its scope. API key does not have a period of life and it must be stored on a client side because it shows only once after generation.
1269
+
1270
+
To generate an API key, fill the following fields:
1271
+
- Name - unique API key name.
1270
1272
- Roles - optional field. This field defines the role(s) (i.e. set of permissions) associated with the API key. Multiple values are allowed. If you do not specify a role, the roles of the user who generated the token will be used by default.
1271
-
- Created For - owner of the API key. By default, owner of key is current user.
1272
-
Once you fill in the required fields, click the Generate button. The system generates the token and displays it. If you leave the page or reload it, the token is not shown again.
1273
-
To delete the generated token, hover over the desired token and click **Revoke**.
1273
+
- Created For - owner of the API key. By default, owner of key is current user.
1274
+
1275
+
Once you fill in the required fields, click the **Generate** button. The system generates the token and displays it. If you leave the page or reload it, the token is not shown again.
1276
+
1277
+
To delete API key, hover over the API key and click **Revoke**.
1274
1278
1275
1279
1276
1280
## User Access Control
1277
1281
User Access Control tab allows you to manage members of group/package/dashboard and their roles.
1278
1282
1279
1283
- User **role** is an entity with a specific set of permissions. You can always see list of available roles and their permissions if you click on question mark on User Access Control page. Roles have hierarchical structure, so even if you have permission to assign roles to the users, you cannot assign the role which is higher than your own role.
1280
1284
- **Member** is a user which is added to the package/dashboard/group with some role(s). One member can have multiple roles in this case, the list of permissions from each specified role will be combined for the current user.
1281
-
Member's roles are inherited from parent groups and workspaces. If some role was assigned to the user, for example, in the group, then it is impossible to remove this role on the child package/package/dashboard. However you can add additional role on the child package/package/dashboard.
1285
+
Member's roles are inherited from parent groups and workspaces. If some role was assigned to the user, for example, in the group, then it is impossible to remove this role on the child package/package/dashboard. However, you can add additional role on the child package/package/dashboard.
1282
1286
1283
1287
To add a new member to the package:
1284
1288
1. Click **Add User**.
@@ -1292,3 +1296,26 @@ To update the role of an existing member:
1292
1296
To remove a member from the package/dashboard/group:
1293
1297
1. Hover over the row of the required member and click **Delete**.
1294
1298
2. You cannot remove a member from the package the member has at least one inherited role or if member have at least one role that is higher than your own role in the current package/dashboard/group.
1299
+
1300
+
# My Profile
1301
+
1302
+
My Profile page contains your personal settings of APIHUB. To access this page, click on your username located in the top-right corner of the portal header and select My Profile.
1303
+
1304
+
The following tabs are available in the My Profile page:
1305
+
1306
+
- **Personal Access Tokens** – allows you to manage your personal access tokens.
1307
+
1308
+
## Personal Access Tokens
1309
+
1310
+
Personal access tokens are an alternative to using API key or Bearer token for authentication to APIHUB when using APIHUB API. Personal access tokens are designed to access APIHUB resources on your behalf.
1311
+
1312
+
To generate a personal access token:
1313
+
1. Open Personal Access Tokens tab in My Profile page.
1314
+
2. Enter a unique token name and select the expiration date.
1315
+
3. Click **Generate** button. The system generates the token and displays it. Copy and store the token securely, as it will only be displayed once. If you leave the page or reload it, the token will no longer be shown.
1316
+
1317
+
When a token expires, it becomes inactive and can no longer be used to authenticate to APIHUB.
1318
+
1319
+
**Note**: You can have up to 100 personal access tokens. If you already have 100 tokens, you must delete some before generating a new one.
1320
+
1321
+
To delete the personal access token, hover over the token and click **Revoke**.
Copy file name to clipboardExpand all lines: packages/editor/src/routes/root/EditorPage/ProjectEditorPage/ProjectEditorToolbar/PublishProjectVersionDialog.tsx
0 commit comments