@syndew/oluso-admin-ui 0.0.0-stage → 1.30.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +76 -0
- package/README.md +29 -2
- package/fesm2022/syndew-oluso-admin-ui-entitlements-page.component-BeZtIUnk.mjs +149 -0
- package/fesm2022/syndew-oluso-admin-ui-entitlements-page.component-BeZtIUnk.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui-license-status-page.component-JQmj_qhz.mjs +205 -0
- package/fesm2022/syndew-oluso-admin-ui-license-status-page.component-JQmj_qhz.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui-platform-clients-page.component-ab3WDRsI.mjs +80 -0
- package/fesm2022/syndew-oluso-admin-ui-platform-clients-page.component-ab3WDRsI.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui-search-results-page.component-EH82yuW3.mjs +543 -0
- package/fesm2022/syndew-oluso-admin-ui-search-results-page.component-EH82yuW3.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui-syndew-oluso-admin-ui-BVs_bAxm.mjs +22987 -0
- package/fesm2022/syndew-oluso-admin-ui-syndew-oluso-admin-ui-BVs_bAxm.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui-team-detail-page.component-CjrQ89qU.mjs +566 -0
- package/fesm2022/syndew-oluso-admin-ui-team-detail-page.component-CjrQ89qU.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui-unauthorized-page.component-CWYFN6mp.mjs +73 -0
- package/fesm2022/syndew-oluso-admin-ui-unauthorized-page.component-CWYFN6mp.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui-webhook-detail-page.component-Bh5dZwt-.mjs +728 -0
- package/fesm2022/syndew-oluso-admin-ui-webhook-detail-page.component-Bh5dZwt-.mjs.map +1 -0
- package/fesm2022/syndew-oluso-admin-ui.mjs +3 -0
- package/fesm2022/syndew-oluso-admin-ui.mjs.map +1 -0
- package/help/en/admin.api-scopes.detail.md +43 -0
- package/help/en/admin.api-scopes.md +37 -0
- package/help/en/admin.audit-logs.md +44 -0
- package/help/en/admin.clients.create.md +60 -0
- package/help/en/admin.clients.detail.md +61 -0
- package/help/en/admin.clients.md +48 -0
- package/help/en/admin.dashboard.md +28 -0
- package/help/en/admin.experience.journeys.builder.md +115 -0
- package/help/en/admin.experience.journeys.md +54 -0
- package/help/en/admin.experience.plugins.md +83 -0
- package/help/en/admin.experience.submissions.md +71 -0
- package/help/en/admin.feedback.detail.md +36 -0
- package/help/en/admin.feedback.md +42 -0
- package/help/en/admin.grants.md +42 -0
- package/help/en/admin.identity-providers.detail.md +46 -0
- package/help/en/admin.identity-providers.md +39 -0
- package/help/en/admin.identity-resources.md +47 -0
- package/help/en/admin.module-seats.md +45 -0
- package/help/en/admin.organizations.detail.md +51 -0
- package/help/en/admin.organizations.md +38 -0
- package/help/en/admin.platform.clients.create.md +34 -0
- package/help/en/admin.platform.clients.detail.md +28 -0
- package/help/en/admin.platform.clients.md +38 -0
- package/help/en/admin.resources.detail.md +44 -0
- package/help/en/admin.resources.md +43 -0
- package/help/en/admin.roles.md +33 -0
- package/help/en/admin.settings.license.md +39 -0
- package/help/en/admin.settings.md +70 -0
- package/help/en/admin.signing-keys.md +47 -0
- package/help/en/admin.tenants.detail.md +58 -0
- package/help/en/admin.tenants.md +46 -0
- package/help/en/admin.users.detail.md +41 -0
- package/help/en/admin.users.md +56 -0
- package/help/en/admin.webhooks.detail.md +41 -0
- package/help/en/admin.webhooks.md +37 -0
- package/package.json +51 -3
- package/types/syndew-oluso-admin-ui.d.ts +5786 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Journey Builder
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- User Journeys | admin.experience.journeys
|
|
5
|
+
- Plugins | admin.experience.plugins
|
|
6
|
+
- Data Collection | admin.experience.submissions
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
The journey builder is a visual editor for creating and editing multi-step authentication and data collection flows. The left panel shows the journey configuration and step list; the right panel shows settings for the selected step.
|
|
10
|
+
|
|
11
|
+
## Journey Settings
|
|
12
|
+
|
|
13
|
+
### Basic Properties
|
|
14
|
+
|
|
15
|
+
- **Name** — identifies the journey in the admin portal and API
|
|
16
|
+
- **Type** — the journey category (Sign In, Sign Up, Data Collection, etc.)
|
|
17
|
+
- **Priority** — lower numbers take precedence when multiple journeys match
|
|
18
|
+
|
|
19
|
+
### UI Customization
|
|
20
|
+
|
|
21
|
+
Customize the look of the authentication screens:
|
|
22
|
+
|
|
23
|
+
- **Theme** — light, dark, or minimal
|
|
24
|
+
- **Login Template** — Standard, Social First, Passkey First, or Combined (Tabs)
|
|
25
|
+
- **Logo URL** — your brand logo
|
|
26
|
+
- **Page Title** — heading text
|
|
27
|
+
- **Primary / Background Color** — brand colors with a color picker
|
|
28
|
+
- **Custom CSS** — override any style with free-form CSS
|
|
29
|
+
|
|
30
|
+
### Data Collection Settings
|
|
31
|
+
|
|
32
|
+
Available for data collection journey types (Waitlist, Survey, Contact Form, etc.):
|
|
33
|
+
|
|
34
|
+
- **Save form submissions** — persist submitted data for review
|
|
35
|
+
- **Require authentication** — users must sign in before submitting
|
|
36
|
+
- **Allow duplicate submissions** — whether users can submit more than once
|
|
37
|
+
- **Max submissions** — cap the total number of submissions (0 = unlimited)
|
|
38
|
+
- **Success redirect URL** — where to send users after submission
|
|
39
|
+
- **Success message** — confirmation text shown on completion
|
|
40
|
+
|
|
41
|
+
### Embed Settings
|
|
42
|
+
|
|
43
|
+
Control how the journey can be embedded on external sites:
|
|
44
|
+
|
|
45
|
+
- **Allowed Origins** — domains permitted to embed the journey (use `*` for all)
|
|
46
|
+
- **Require API key** — protect public access with an API key
|
|
47
|
+
- **API Key** — generate a `pk_` prefixed key for embedding
|
|
48
|
+
|
|
49
|
+
## Steps
|
|
50
|
+
|
|
51
|
+
Steps are the building blocks of a journey. They execute in order and can branch based on conditions.
|
|
52
|
+
|
|
53
|
+
### Step Types
|
|
54
|
+
|
|
55
|
+
| Category | Steps |
|
|
56
|
+
|---|---|
|
|
57
|
+
| **Authentication** | Sign In, Social Login, Combined Login, MFA, Consent |
|
|
58
|
+
| **User Interaction** | Custom Form, Terms Acceptance, CAPTCHA |
|
|
59
|
+
| **User Management** | User Registration, Password Reset |
|
|
60
|
+
| **Verification** | Business Verification (company registry check or the provider's hosted flow, plus the applicant's right to act for the business; resumes where an earlier attempt left off; branches verified / not verified / pending / provider unavailable; outputs `kyb_status`, `kyb_business_id`, `kyb_applicant_id`, `kyb_business_name`, `kyb_registration_number`, `kyb_country`, `kyb_relationship`) |
|
|
61
|
+
| **Flow Control** | Conditional Logic, Data Transformation |
|
|
62
|
+
| **Logic** | HTTP Request (API Call) |
|
|
63
|
+
| **Plugins** | Custom WASM Plugin |
|
|
64
|
+
|
|
65
|
+
### Step Configuration
|
|
66
|
+
|
|
67
|
+
Every step has:
|
|
68
|
+
|
|
69
|
+
- **Step ID** — unique identifier within the journey
|
|
70
|
+
- **Display Name** — label shown in the builder and optionally to users
|
|
71
|
+
- **Optional** — if checked, the journey continues even if this step fails
|
|
72
|
+
|
|
73
|
+
### Flow Control
|
|
74
|
+
|
|
75
|
+
Control what happens after each step:
|
|
76
|
+
|
|
77
|
+
- **On Success** — which step to go to next (default: next in list)
|
|
78
|
+
- **On Failure** — which step to go to on error (default: fail the journey)
|
|
79
|
+
- **Branches** — named conditional paths for complex routing
|
|
80
|
+
|
|
81
|
+
### Execution Conditions
|
|
82
|
+
|
|
83
|
+
Make steps conditional. A step can check journey data, user claims, or context values using operators like equals, contains, starts_with, regex, exists, and more. Combine multiple conditions with AND/OR logic.
|
|
84
|
+
|
|
85
|
+
## Key Step Types
|
|
86
|
+
|
|
87
|
+
### Custom Form (DynamicForm)
|
|
88
|
+
|
|
89
|
+
Build forms with fields of any type — text, email, number, date, select, radio, checkbox, textarea. Each field can:
|
|
90
|
+
|
|
91
|
+
- Map to a **claim type** for downstream use
|
|
92
|
+
- Be marked **required** with validation rules (min/max length, regex pattern)
|
|
93
|
+
- Be **saved to the user profile** (maps to standard or custom user properties)
|
|
94
|
+
- Include **help text** and **placeholder** guidance
|
|
95
|
+
|
|
96
|
+
**File upload** fields take documents and photos. Choose the accepted kinds (PDF, JPEG, PNG, HEIC, WebP, GIF), the largest file (MB, 10 by default) and how many files (1 by default). Files are checked by their content, not their name or the type the browser claims, and a file whose name doesn't match its content is refused. They're stored privately with the submission (never at a public URL): the person who uploaded them, and administrators who can read submissions, open them through the signed-in file endpoint. The field's value is the uploaded files' ids. Turn on **Take a photo** to also offer the phone's camera; when the journey is embedded in another site, the host's iframe needs `allow="camera"`.
|
|
97
|
+
|
|
98
|
+
### API Call
|
|
99
|
+
|
|
100
|
+
Make HTTP requests to external services during the journey:
|
|
101
|
+
|
|
102
|
+
- Configure URL, method, headers, and request body with **placeholders** like `{claim:email}` or `{state:userId}`
|
|
103
|
+
- Set authentication (Bearer, Basic, API Key)
|
|
104
|
+
- Map response fields to claims for use in later steps
|
|
105
|
+
- Configure retry logic and error handling
|
|
106
|
+
|
|
107
|
+
### Conditional Logic
|
|
108
|
+
|
|
109
|
+
Branch the journey based on data. Evaluate conditions on claims, journey state, or context, then route to different steps based on the result.
|
|
110
|
+
|
|
111
|
+
## Validation and Saving
|
|
112
|
+
|
|
113
|
+
- Click **Validate** to check for configuration errors before saving
|
|
114
|
+
- Click **Save** to create or update the journey
|
|
115
|
+
- Validation errors are shown inline if the journey has issues
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: User Journeys
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Journey Builder | admin.experience.journeys.builder
|
|
5
|
+
- Data Collection | admin.experience.submissions
|
|
6
|
+
- Plugins | admin.experience.plugins
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
User Journeys are configurable multi-step flows that define how users authenticate, register, and interact with your application. They are similar to Azure AD B2C user flows and custom policies.
|
|
10
|
+
|
|
11
|
+
## Journey Types
|
|
12
|
+
|
|
13
|
+
### Authentication Journeys
|
|
14
|
+
|
|
15
|
+
| Type | Purpose |
|
|
16
|
+
|---|---|
|
|
17
|
+
| **Sign In** | Authenticate existing users |
|
|
18
|
+
| **Sign Up** | Register new users |
|
|
19
|
+
| **Sign In / Sign Up** | Combined flow — sign in or register on one screen |
|
|
20
|
+
| **Password Reset** | Self-service password recovery |
|
|
21
|
+
| **Profile Edit** | Let users update their profile information |
|
|
22
|
+
| **Link Account** | Connect an external identity to an existing account |
|
|
23
|
+
| **Consent** | Collect user consent for scopes or terms |
|
|
24
|
+
|
|
25
|
+
### Data Collection Journeys
|
|
26
|
+
|
|
27
|
+
| Type | Purpose |
|
|
28
|
+
|---|---|
|
|
29
|
+
| **Waitlist** | Collect interest before launch |
|
|
30
|
+
| **Contact Form** | Gather inquiries from visitors |
|
|
31
|
+
| **Survey** | Collect structured feedback |
|
|
32
|
+
| **Feedback** | Free-form user feedback |
|
|
33
|
+
| **Data Collection** | General-purpose form submission |
|
|
34
|
+
|
|
35
|
+
## Journey List
|
|
36
|
+
|
|
37
|
+
The table shows each journey's name, type, status, number of steps, and priority. **Priority** determines which journey is used when multiple match — lower numbers take precedence.
|
|
38
|
+
|
|
39
|
+
## Global vs Tenant Journeys
|
|
40
|
+
|
|
41
|
+
- **Global journeys** (globe icon) are system-provided templates. They cannot be edited or disabled directly, but you can **clone** them to create a tenant-specific copy.
|
|
42
|
+
- **Tenant journeys** (building icon) are created by you and fully editable.
|
|
43
|
+
|
|
44
|
+
Toggle **Show global policies** to include system templates in the list.
|
|
45
|
+
|
|
46
|
+
## Creating a Journey
|
|
47
|
+
|
|
48
|
+
Click **Create Journey** to open the journey builder. You will define the journey type, configure its steps, and optionally customize the UI appearance.
|
|
49
|
+
|
|
50
|
+
## Managing Journeys
|
|
51
|
+
|
|
52
|
+
- Click a journey row to edit it in the builder
|
|
53
|
+
- Use the **clipboard icon** to clone a global journey
|
|
54
|
+
- Toggle the **status switch** to enable or disable a journey
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Plugins
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- User Journeys | admin.experience.journeys
|
|
5
|
+
- Journey Builder | admin.experience.journeys.builder
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Plugins are custom WebAssembly (WASM) modules that extend journey functionality with your own business logic. Use them to validate data, enrich user profiles from external systems, integrate with third-party services, or trigger custom workflows.
|
|
9
|
+
|
|
10
|
+
## Plugin List
|
|
11
|
+
|
|
12
|
+
The table shows all registered plugins:
|
|
13
|
+
|
|
14
|
+
- **Plugin** — display name and internal identifier
|
|
15
|
+
- **Scope** — **Global** (system-provided, read-only) or **Tenant** (created by you)
|
|
16
|
+
- **Version** — semantic version number
|
|
17
|
+
- **Size** — compiled WASM file size
|
|
18
|
+
- **Status** — whether the plugin is loaded and ready to execute
|
|
19
|
+
- **Updated** — last modification date
|
|
20
|
+
|
|
21
|
+
## Uploading a Plugin
|
|
22
|
+
|
|
23
|
+
Click **Upload Plugin** and provide:
|
|
24
|
+
|
|
25
|
+
- **WASM File** — the compiled `.wasm` file (max 10 MB)
|
|
26
|
+
- **Plugin Name** — internal identifier (defaults to filename)
|
|
27
|
+
- **Display Name** — human-readable name shown in the admin portal
|
|
28
|
+
- **Description** — what the plugin does
|
|
29
|
+
- **Version** — semantic version (e.g., 1.0.0)
|
|
30
|
+
- **Author** — who created the plugin
|
|
31
|
+
|
|
32
|
+
## Plugin Details
|
|
33
|
+
|
|
34
|
+
Click the **info icon** on any plugin to view its full configuration across four tabs:
|
|
35
|
+
|
|
36
|
+
### Info
|
|
37
|
+
|
|
38
|
+
Plugin metadata including name, version, author, scope, size, and description. Also shows:
|
|
39
|
+
|
|
40
|
+
- **Required Claims** — claims the plugin expects as input
|
|
41
|
+
- **Output Claims** — claims the plugin produces
|
|
42
|
+
- **Config Schema** — JSON schema describing the plugin's configuration options
|
|
43
|
+
|
|
44
|
+
### Hook Bindings
|
|
45
|
+
|
|
46
|
+
Hooks define **when** a plugin executes. Each hook binds to a domain event:
|
|
47
|
+
|
|
48
|
+
- **Domain** — the system area the hook targets
|
|
49
|
+
- **Entity Type** — which entity triggers the hook (use `*` for all)
|
|
50
|
+
- **Event Type** — which event triggers the hook (use `*` for all)
|
|
51
|
+
- **Function Name** — the WASM function to call
|
|
52
|
+
- **Order** — execution priority (lower runs first)
|
|
53
|
+
- **On Failure** — whether to **Continue** (ignore errors) or **Reject** (fail the operation)
|
|
54
|
+
|
|
55
|
+
You can add, edit, enable/disable, and delete hook bindings.
|
|
56
|
+
|
|
57
|
+
### Network
|
|
58
|
+
|
|
59
|
+
Control the plugin's ability to make HTTP requests:
|
|
60
|
+
|
|
61
|
+
| Mode | Description |
|
|
62
|
+
|---|---|
|
|
63
|
+
| **None** | No network access |
|
|
64
|
+
| **Self** | Can only call your own API endpoints |
|
|
65
|
+
| **Whitelist** | Can call specific allowed hosts |
|
|
66
|
+
| **All** | Can call any host (requires approval) |
|
|
67
|
+
|
|
68
|
+
For Whitelist mode, specify allowed hosts one per line. Configure **timeout** and **max requests per execution** to prevent abuse.
|
|
69
|
+
|
|
70
|
+
### Executions
|
|
71
|
+
|
|
72
|
+
View recent execution logs showing when the plugin ran, which event triggered it, how long it took, and whether it succeeded or failed. Use this tab to debug issues.
|
|
73
|
+
|
|
74
|
+
## Using Plugins in Journeys
|
|
75
|
+
|
|
76
|
+
After uploading a plugin, add a **Custom Plugin** step in the journey builder. The step will execute your WASM function as part of the journey flow, with access to claims and journey data.
|
|
77
|
+
|
|
78
|
+
## Tips
|
|
79
|
+
|
|
80
|
+
- Global plugins cannot be deleted — they are maintained by the system
|
|
81
|
+
- Use the **reload** button to hot-swap a plugin without restarting
|
|
82
|
+
- Start with **None** or **Self** network access and only expand if needed
|
|
83
|
+
- Check the **Executions** tab when debugging plugin issues
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Data Collection
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- User Journeys | admin.experience.journeys
|
|
5
|
+
- Journey Builder | admin.experience.journeys.builder
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Review and manage form submissions from data collection journeys — waitlists, surveys, contact forms, and other custom forms. The left panel lists your data collection policies; the right panel shows submissions for the selected policy.
|
|
9
|
+
|
|
10
|
+
## Viewing Submissions
|
|
11
|
+
|
|
12
|
+
Select a data collection policy on the left to load its submissions. Each policy shows its name, submission count (relative to the max limit), and active/inactive status.
|
|
13
|
+
|
|
14
|
+
The submissions table displays:
|
|
15
|
+
|
|
16
|
+
- **Submitted** — when the submission was made (with relative time)
|
|
17
|
+
- **Data Preview** — the first few fields submitted
|
|
18
|
+
- **Source** — country and IP address of the submitter
|
|
19
|
+
- **Tags** — labels applied during review
|
|
20
|
+
- **Status** — the current review status
|
|
21
|
+
|
|
22
|
+
## Submission Statuses
|
|
23
|
+
|
|
24
|
+
| Status | Meaning |
|
|
25
|
+
|---|---|
|
|
26
|
+
| **New** | Just received, not yet reviewed |
|
|
27
|
+
| **Reviewed** | Looked at by an admin |
|
|
28
|
+
| **Processing** | Being acted on |
|
|
29
|
+
| **Approved** | Accepted |
|
|
30
|
+
| **Rejected** | Declined |
|
|
31
|
+
| **Follow Up** | Needs further action |
|
|
32
|
+
| **Archived** | Filed away, no longer active |
|
|
33
|
+
|
|
34
|
+
Change a submission's status directly from the table dropdown or from the detail view.
|
|
35
|
+
|
|
36
|
+
## Filtering
|
|
37
|
+
|
|
38
|
+
Use the filter bar to narrow submissions:
|
|
39
|
+
|
|
40
|
+
- **Search** — free-text search across submitted data
|
|
41
|
+
- **Status** — filter by review status
|
|
42
|
+
- **Date range** — filter by submission date
|
|
43
|
+
|
|
44
|
+
Click **Apply** to run filters or **Clear** to reset.
|
|
45
|
+
|
|
46
|
+
## Submission Details
|
|
47
|
+
|
|
48
|
+
Click the **eye icon** on any row to open the full submission view:
|
|
49
|
+
|
|
50
|
+
- **Collected Data** — all fields and values submitted
|
|
51
|
+
- **Metadata** — IP address, country, locale, referrer, user agent, device, browser, and OS
|
|
52
|
+
- **Tags** — add, remove, and manage labels. Suggested tags from other submissions appear for consistency.
|
|
53
|
+
- **Notes** — free-text notes for internal review
|
|
54
|
+
- **Review info** — who reviewed it and when
|
|
55
|
+
|
|
56
|
+
## Bulk Actions
|
|
57
|
+
|
|
58
|
+
Select multiple submissions using the checkboxes, then use the bulk action bar to:
|
|
59
|
+
|
|
60
|
+
- **Approve** — mark selected as approved
|
|
61
|
+
- **Reject** — mark selected as rejected
|
|
62
|
+
- **Archive** — move selected to archived
|
|
63
|
+
- **Delete** — permanently remove selected submissions
|
|
64
|
+
|
|
65
|
+
## Exporting
|
|
66
|
+
|
|
67
|
+
Click **CSV** or **JSON** in the header to export the current policy's submissions. Exports respect any active filters.
|
|
68
|
+
|
|
69
|
+
## Journey URL
|
|
70
|
+
|
|
71
|
+
The **Journey URL** shown in the header is the public link for the data collection form. Click the copy icon to copy it to your clipboard for sharing or embedding.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Feedback Details
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Beta Feedback | admin.feedback
|
|
5
|
+
- Webhooks | admin.webhooks
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
View the full details of a feedback submission including the description, metadata, and any attached screenshot.
|
|
9
|
+
|
|
10
|
+
## Description
|
|
11
|
+
|
|
12
|
+
The user's full feedback text, exactly as submitted.
|
|
13
|
+
|
|
14
|
+
## Details
|
|
15
|
+
|
|
16
|
+
Contextual information captured automatically at submission time:
|
|
17
|
+
|
|
18
|
+
- **Submitted By** — user name and email
|
|
19
|
+
- **Portal** — Admin or Workspace
|
|
20
|
+
- **Page URL** — the page the user was on when they submitted
|
|
21
|
+
- **Element** — CSS selector of a highlighted UI element (if the user selected one)
|
|
22
|
+
- **Viewport** — the user's screen resolution
|
|
23
|
+
- **Browser** — the user agent string
|
|
24
|
+
|
|
25
|
+
## Screenshot
|
|
26
|
+
|
|
27
|
+
If the user captured a screenshot, it is displayed at the bottom of the page. Click the image to view it at full size.
|
|
28
|
+
|
|
29
|
+
## Updating Status
|
|
30
|
+
|
|
31
|
+
Click **Update Status** to change the triage state. Available statuses:
|
|
32
|
+
|
|
33
|
+
- **New** — default for incoming submissions
|
|
34
|
+
- **Reviewed** — you've seen it and are considering action
|
|
35
|
+
- **Resolved** — the underlying issue or request has been addressed
|
|
36
|
+
- **Dismissed** — closed without action (e.g., duplicate, out of scope)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Beta Feedback
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Webhooks | admin.webhooks
|
|
5
|
+
- Activity Logs | admin.audit-logs
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Review and manage feedback submissions from users in every tenant, across both the admin and workspace portals. During beta testing, this page collects bug reports, feature requests, and general notes submitted via the in-app feedback widget.
|
|
9
|
+
|
|
10
|
+
## Feedback List
|
|
11
|
+
|
|
12
|
+
The table shows all submissions with:
|
|
13
|
+
|
|
14
|
+
- **Title** — a short summary of the feedback (camera icon indicates a screenshot is attached)
|
|
15
|
+
- **Category** — Bug, Feature Request, or Note
|
|
16
|
+
- **Status** — current triage status (new, reviewed, resolved, dismissed)
|
|
17
|
+
- **Tenant** - the tenant the user submitted it from
|
|
18
|
+
- **Portal** — whether it was submitted from the Admin or Workspace portal
|
|
19
|
+
- **Submitted By** — the user who submitted the feedback
|
|
20
|
+
- **Date** — when the feedback was submitted
|
|
21
|
+
|
|
22
|
+
Click any row to view the full details.
|
|
23
|
+
|
|
24
|
+
## Filtering
|
|
25
|
+
|
|
26
|
+
Use the dropdowns to narrow results by:
|
|
27
|
+
|
|
28
|
+
- **Category** — show only bugs, feature requests, or notes
|
|
29
|
+
- **Status** — show only items in a specific triage state
|
|
30
|
+
|
|
31
|
+
## Statuses
|
|
32
|
+
|
|
33
|
+
| Status | Meaning |
|
|
34
|
+
|---|---|
|
|
35
|
+
| **New** | Just submitted, not yet reviewed |
|
|
36
|
+
| **Reviewed** | Acknowledged by an admin |
|
|
37
|
+
| **Resolved** | The issue has been addressed or the feature shipped |
|
|
38
|
+
| **Dismissed** | Closed without action |
|
|
39
|
+
|
|
40
|
+
## Webhooks
|
|
41
|
+
|
|
42
|
+
When feedback is submitted, a `feedback.submitted` webhook event is fired. Configure a webhook to forward submissions to Slack, email, or your issue tracker.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Grants & Sessions
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Users | admin.users
|
|
5
|
+
- Clients | admin.clients
|
|
6
|
+
- Activity Logs | admin.audit-logs
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Manage persisted grants and active user sessions. This page gives you direct control over the tokens and sessions that keep users authenticated.
|
|
10
|
+
|
|
11
|
+
## Persisted Grants
|
|
12
|
+
|
|
13
|
+
Persisted grants are long-lived tokens stored by the authorization server, including refresh tokens, authorization codes, and reference tokens.
|
|
14
|
+
|
|
15
|
+
The table shows:
|
|
16
|
+
|
|
17
|
+
- **Type** — the grant type (RefreshToken, AuthorizationCode, ReferenceToken, etc.)
|
|
18
|
+
- **Client** — the application the grant was issued to
|
|
19
|
+
- **Subject** — the user the grant belongs to
|
|
20
|
+
- **Created** — when the grant was issued
|
|
21
|
+
- **Expires** — when the grant will expire
|
|
22
|
+
|
|
23
|
+
Click **Revoke** to immediately invalidate a grant. This forces the user to re-authenticate with that client.
|
|
24
|
+
|
|
25
|
+
## Active Sessions
|
|
26
|
+
|
|
27
|
+
Server-side authentication sessions that track logged-in users.
|
|
28
|
+
|
|
29
|
+
The table shows:
|
|
30
|
+
|
|
31
|
+
- **Subject** — the user's identifier
|
|
32
|
+
- **Display Name** — the user's name
|
|
33
|
+
- **Scheme** — the authentication scheme used (e.g., local, Google, OIDC)
|
|
34
|
+
- **Created / Renewed / Expires** — session timestamps
|
|
35
|
+
|
|
36
|
+
Click **Terminate** to end a specific session, or use this page to audit which users are currently signed in.
|
|
37
|
+
|
|
38
|
+
## When to Use This
|
|
39
|
+
|
|
40
|
+
- **Compromised account** — revoke all grants and terminate sessions for a user
|
|
41
|
+
- **Client rotation** — revoke grants for an old client after migrating to a new one
|
|
42
|
+
- **Debugging** — verify that tokens and sessions are being created as expected
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Identity Provider Details
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Identity Providers | admin.identity-providers
|
|
5
|
+
- Clients | admin.clients
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Configure or view the full settings of an external authentication provider. The form adapts to the selected provider type.
|
|
9
|
+
|
|
10
|
+
## Basic Information
|
|
11
|
+
|
|
12
|
+
- **Provider Type** — the protocol (set at creation, cannot be changed)
|
|
13
|
+
- **Scheme Name** — unique identifier used in authentication URLs (set at creation)
|
|
14
|
+
- **Display Name** — label shown on the login page
|
|
15
|
+
- **Enabled** — toggle the provider on or off
|
|
16
|
+
|
|
17
|
+
## Provider Configuration
|
|
18
|
+
|
|
19
|
+
Each provider type has specific fields:
|
|
20
|
+
|
|
21
|
+
- **Google / Microsoft / GitHub / Facebook** — Client ID and Client Secret from the provider's developer console, plus provider-specific options (hosted domain, tenant ID, allowed organizations, etc.)
|
|
22
|
+
- **OIDC** — Authority URL, client credentials, scopes, and optional endpoint overrides for non-standard providers
|
|
23
|
+
- **OAuth2** — Manual endpoint configuration (authorization, token, userinfo) with custom claim mappings
|
|
24
|
+
- **SAML2** — Entity ID, metadata URL, SSO service URL, signing certificate, and security settings
|
|
25
|
+
- **LDAP** — Server address, bind credentials, search base DN, user filter, and attribute mappings
|
|
26
|
+
|
|
27
|
+
## Proxy Mode (Federation Broker)
|
|
28
|
+
|
|
29
|
+
Advanced settings for pass-through federation:
|
|
30
|
+
|
|
31
|
+
- **Proxy Mode** — forward tokens from the external provider without re-issuing
|
|
32
|
+
- **Store User Details Locally** — cache user profile data
|
|
33
|
+
- **Token Pass-through** — include the external provider's access or ID token in your tokens
|
|
34
|
+
- **Claim Filtering** — control which claims from the external provider are included or excluded
|
|
35
|
+
|
|
36
|
+
## Setup Instructions
|
|
37
|
+
|
|
38
|
+
Each provider type shows context-specific setup steps, including:
|
|
39
|
+
|
|
40
|
+
- The **Callback URL** to register with the external provider
|
|
41
|
+
- The **Discovery URL** for OIDC providers
|
|
42
|
+
- **ACS URL** and **Entity ID** for SAML2 providers
|
|
43
|
+
|
|
44
|
+
## Testing
|
|
45
|
+
|
|
46
|
+
Click **Test Connection** to verify that the provider is reachable and credentials are valid before enabling it for users.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Identity Providers
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Clients | admin.clients
|
|
5
|
+
- Users | admin.users
|
|
6
|
+
- Settings | admin.settings
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Configure external authentication providers to enable single sign-on (SSO) and social login. Users can authenticate with a third-party identity provider instead of (or in addition to) a local username and password.
|
|
10
|
+
|
|
11
|
+
## Provider List
|
|
12
|
+
|
|
13
|
+
The table shows all configured providers with:
|
|
14
|
+
|
|
15
|
+
- **Provider** — icon, display name, and scheme identifier
|
|
16
|
+
- **Type** — the protocol or service (Google, Microsoft, OIDC, SAML2, LDAP, etc.)
|
|
17
|
+
- **Status** — Enabled or Disabled
|
|
18
|
+
- **Clients** — how many clients are configured to use this provider
|
|
19
|
+
|
|
20
|
+
Click a row to view or edit the provider's configuration. Use the play/pause button to quickly enable or disable a provider without opening the detail page.
|
|
21
|
+
|
|
22
|
+
## Supported Provider Types
|
|
23
|
+
|
|
24
|
+
| Type | Protocol | Use Case |
|
|
25
|
+
|---|---|---|
|
|
26
|
+
| **Google** | OAuth 2.0 | Google Workspace / Gmail users |
|
|
27
|
+
| **Microsoft** | OAuth 2.0 | Azure AD / Microsoft 365 users |
|
|
28
|
+
| **GitHub** | OAuth 2.0 | Developer teams using GitHub |
|
|
29
|
+
| **Facebook** | OAuth 2.0 | Consumer-facing social login |
|
|
30
|
+
| **Apple** | OAuth 2.0 | Apple ID sign-in |
|
|
31
|
+
| **LinkedIn / Twitter** | OAuth 2.0 | Professional / social networks |
|
|
32
|
+
| **OIDC** | OpenID Connect | Any standards-compliant IdP |
|
|
33
|
+
| **OAuth2** | OAuth 2.0 | Custom OAuth providers |
|
|
34
|
+
| **SAML2** | SAML 2.0 | Enterprise SSO (Okta, ADFS, etc.) |
|
|
35
|
+
| **LDAP** | LDAP/LDAPS | On-premises Active Directory |
|
|
36
|
+
|
|
37
|
+
## Adding a Provider
|
|
38
|
+
|
|
39
|
+
Click **Add Provider**, select the provider type, and configure the required credentials (client ID, secret, endpoints). Each provider type has its own setup instructions shown on the configuration page.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Identity Resources
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- API Scopes | admin.api-scopes
|
|
5
|
+
- Resources | admin.resources
|
|
6
|
+
- Clients | admin.clients
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Identity resources are the OIDC identity scopes — `openid`, `profile`, `email`, `phone`, and any custom scopes you define. Each one declares the set of user claims it releases into the ID token and the userinfo response when a client is granted that scope.
|
|
10
|
+
|
|
11
|
+
## Resource List
|
|
12
|
+
|
|
13
|
+
The table shows all configured identity resources with:
|
|
14
|
+
|
|
15
|
+
- **Name** — the scope name clients request (e.g., `profile`, `email`)
|
|
16
|
+
- **Display Name** — human-readable label shown on consent screens
|
|
17
|
+
- **Status** — Enabled or Disabled
|
|
18
|
+
- **Claims** — the number of user claims this scope releases
|
|
19
|
+
|
|
20
|
+
Click a row to view or edit the resource.
|
|
21
|
+
|
|
22
|
+
## Standard scopes and overrides
|
|
23
|
+
|
|
24
|
+
The standard OIDC scopes have built-in default claim sets (for example `profile` releases `name`, `given_name`, `family_name`, and `picture`). Those defaults apply automatically — you do not have to configure anything.
|
|
25
|
+
|
|
26
|
+
If you add user claims to a standard scope here, your configured list **replaces** the built-in default for that scope. This lets you tighten or redefine exactly what a standard scope releases.
|
|
27
|
+
|
|
28
|
+
## Creating a Resource
|
|
29
|
+
|
|
30
|
+
Click **Add Identity Resource** and provide:
|
|
31
|
+
|
|
32
|
+
- **Name** (required) — the scope name used in `scope` parameters
|
|
33
|
+
- **Display Name** — what users see on the consent screen
|
|
34
|
+
- **Description** — additional context shown during consent
|
|
35
|
+
- **Enabled** — whether clients can request this scope
|
|
36
|
+
- **Required** — automatically include in every token
|
|
37
|
+
- **Emphasize** — highlight this scope on the consent screen
|
|
38
|
+
- **Show in Discovery** — include in the `.well-known/openid-configuration` document
|
|
39
|
+
|
|
40
|
+
## User Claims
|
|
41
|
+
|
|
42
|
+
Use **Edit Claims** to manage which claims the scope releases. Custom claim types resolve from the user's standard profile fields or custom properties; if a user has no value for a claim, it is simply omitted.
|
|
43
|
+
|
|
44
|
+
## Tips
|
|
45
|
+
|
|
46
|
+
- Platform claims such as `tenant_id` and `role` are always issued and are not controlled here.
|
|
47
|
+
- Standard OIDC scopes cannot be deleted.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Module Seats
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Users | admin.users
|
|
5
|
+
- Roles & Permissions | admin.roles
|
|
6
|
+
- Subscription | admin.billing.subscriptions
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Manage which users have access to each licensed module. Each module enforces its own seat limit based on your subscription, and only users assigned to a module can sign in to its features.
|
|
10
|
+
|
|
11
|
+
## Module List
|
|
12
|
+
|
|
13
|
+
The page lists every module enabled for your tenant. Each card shows:
|
|
14
|
+
|
|
15
|
+
- **Module name** and short description
|
|
16
|
+
- **Seats used** vs **seats licensed** (e.g. 12 / 25)
|
|
17
|
+
- **Status** — whether the module is at capacity or has free seats
|
|
18
|
+
|
|
19
|
+
Click a module to open its detail view and manage its assigned users.
|
|
20
|
+
|
|
21
|
+
## Module Detail
|
|
22
|
+
|
|
23
|
+
Selecting a module reveals:
|
|
24
|
+
|
|
25
|
+
- **Assigned Users** — users who currently consume a seat on this module
|
|
26
|
+
- **Add User** — search across all tenant users and grant a seat
|
|
27
|
+
- **Remove** — revoke a user's seat (frees it for someone else)
|
|
28
|
+
|
|
29
|
+
When all licensed seats are taken, **Add User** is disabled until you remove someone or upgrade the plan.
|
|
30
|
+
|
|
31
|
+
## Adding a User
|
|
32
|
+
|
|
33
|
+
1. Click **Add User** on the module card.
|
|
34
|
+
2. Search by name or email.
|
|
35
|
+
3. Select the user and confirm. The seat is consumed immediately and the user gains access on next sign-in.
|
|
36
|
+
|
|
37
|
+
## Removing a User
|
|
38
|
+
|
|
39
|
+
Click the **Remove** action next to a user, then confirm. The user keeps their account and other module seats — only this module's access is revoked.
|
|
40
|
+
|
|
41
|
+
## Tips
|
|
42
|
+
|
|
43
|
+
- Seat counts are enforced at the API layer, not just the UI — a removed user is locked out immediately.
|
|
44
|
+
- If you're at capacity, check **Last Login** in the user list to identify dormant users you can reclaim seats from.
|
|
45
|
+
- Module seat consumption is reflected on the billing **Subscription** page so you can see usage trending into the next renewal.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Organization Details
|
|
3
|
+
relatedTopics:
|
|
4
|
+
- Organizations | admin.organizations
|
|
5
|
+
- Tenants | admin.tenants
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Manage a single organization's settings, features, tenants, and members. The detail page is organized into tabs.
|
|
9
|
+
|
|
10
|
+
## General
|
|
11
|
+
|
|
12
|
+
Two sections side by side:
|
|
13
|
+
|
|
14
|
+
- **Identity** — Name, Slug (read-only), Description, and Enabled toggle
|
|
15
|
+
- **Configuration** — Logo URL, Website URL, Max Members, and Max Tenants limits
|
|
16
|
+
|
|
17
|
+
Changes are saved when you click **Save Changes**.
|
|
18
|
+
|
|
19
|
+
## Features
|
|
20
|
+
|
|
21
|
+
A grid of feature cards representing the modules and capabilities available to this organization. Each card shows:
|
|
22
|
+
|
|
23
|
+
- **Feature name** and description
|
|
24
|
+
- **Granted at / Expires at** dates (if time-limited)
|
|
25
|
+
- **Toggle** to enable or disable the feature
|
|
26
|
+
|
|
27
|
+
Enabling a feature here makes it available for the organization's tenants to activate. Disabling it hides the feature from all tenants under this organization.
|
|
28
|
+
|
|
29
|
+
## Tenants
|
|
30
|
+
|
|
31
|
+
A table of all tenants belonging to this organization, showing Name, Identifier, Status, and Created date.
|
|
32
|
+
|
|
33
|
+
Click **Add Tenant** to create a new tenant with:
|
|
34
|
+
|
|
35
|
+
- **Name** and **Display Name**
|
|
36
|
+
- **Identifier** — unique tenant slug
|
|
37
|
+
- **Environment** — Development, Staging, or Production
|
|
38
|
+
- **Description**
|
|
39
|
+
|
|
40
|
+
Use the settings icon on each row to jump to that tenant's configuration page.
|
|
41
|
+
|
|
42
|
+
## Members
|
|
43
|
+
|
|
44
|
+
Organization members are users with administrative access to this organization. The table shows each member's User, Role, and Joined date.
|
|
45
|
+
|
|
46
|
+
Click **Add Member** and provide:
|
|
47
|
+
|
|
48
|
+
- **User ID** — the user to add
|
|
49
|
+
- **Role** — Member, Admin, or Owner
|
|
50
|
+
|
|
51
|
+
Owners have full control over the organization. Admins can manage tenants and members. Members have read access.
|