Skip to content

Commit

Permalink
Merge branch 'master' into aes-256
Browse files Browse the repository at this point in the history
  • Loading branch information
himeshsiriwardana authored Nov 6, 2024
2 parents 1678623 + d7e0ab9 commit c0783d0
Show file tree
Hide file tree
Showing 91 changed files with 2,295 additions and 796 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.0.215
0.0.232
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ paths:
"groups": [
"48badf-rty20-48ba-935b-f7b460f58e5c",
"fd234100-c115-45dc-ad11-70846b783866"
],
"properties": [
{
"key": "manageNotificationsInternally",
"value": "true"
}
]
}'
x-codegen-request-body-name: body
Expand Down Expand Up @@ -380,6 +386,12 @@ components:
example:
- 48badf-rty20-48ba-935b-f7b460f58e5c
- fd234100-c115-45dc-ad11-70846b783866
properties:
type: array
description: Custom properties of invitation which can be used in runtime but doesn't
persist as invitation information.
items:
$ref: '#/components/schemas/Property'
example:
{
"usernames": [
Expand All @@ -393,6 +405,12 @@ components:
"groups": [
"48badf-rty20-48ba-935b-f7b460f58e5c",
"fd234100-c115-45dc-ad11-70846b783866"
],
"properties": [
{
"key" : "manageNotificationsInternally",
"value" : "true"
}
]
}
InvitationSuccessListResponse:
Expand Down Expand Up @@ -444,7 +462,10 @@ components:
errorDescription:
type: string
example: Some Error Description

confirmationCode:
type: string
description: Confirmation code for the invitation when internally managed notifications are disabled.
example: "3363329b-c8c5-4c71-9500-9ea8c4e77d45"
IntrospectRequestBody:
type: object
required:
Expand Down Expand Up @@ -658,6 +679,15 @@ components:
type:
type: string
example: 'organization'
Property:
type: object
properties:
key:
type: string
example: "manageNotificationsInternally"
value:
type: string
example: "false"
Error:
type: object
required:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions en/asgardeo/docs/concepts/api-security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../includes/concepts/api-security.md" %}
1 change: 1 addition & 0 deletions en/asgardeo/docs/concepts/customer-iam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../includes/concepts/customer-iam.md" %}
1 change: 1 addition & 0 deletions en/asgardeo/docs/concepts/workforce-iam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../includes/concepts/workforce-iam.md" %}
2 changes: 1 addition & 1 deletion en/asgardeo/docs/guides/asgardeo-logs/diagnostic-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Diagnostic logs in Asgardeo are designed to help developers diagnose and trouble

## Access diagnostic logs

To access audit logs:
To access diagnostics logs:

1. On the Asgardeo Console, go to **Log**

Expand Down
10 changes: 1 addition & 9 deletions en/asgardeo/docs/guides/branding/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1 @@
# Branding

By default, the business applications of your organization in Asgardeo are presented to your users with Asgardeo branding. You have the option of using your own branding as follows:

- [Customize the user interfaces (UIs)]({{base_path}}/guides/branding/configure-ui-branding/) of the user login, sign-up, and account recovery flows.

- [Customize the domain name]({{base_path}}/guides/branding/configure-custom-domains/) <sup>`Paid subscription required`</sup>

- [Customize email notifications]({{base_path}}/guides/branding/customize-email-templates/)
{% include "../../../../includes/guides/branding/index.md" %}
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{% set host_name = "console.asgardeo.io" %}
{% set console_path = "" %}
{% set organization_name = "{organization-name}" %}

{% include "../../../../includes/guides/organization-management/invite-parent-organization-users.md" %}
10 changes: 5 additions & 5 deletions en/asgardeo/docs/guides/users/manage-administrators.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Let's look at how administrators can onboard another administrator by sending an

To onboard an administrator:

1. On the Asgardeo Console, go to **Administrators**.
1. On the Asgardeo Console, go to **Console Settings** > **Administrators**.

2. Click **Add Administrator** and provide the required details.

Expand Down Expand Up @@ -56,21 +56,21 @@ You can assign admin privileges to existing business users only if it is allowed

First, configure administrator settings for the organization:

1. On the Asgardeo Console, go to **Administrators**.
1. On the Asgardeo Console, go to **Console Settings** > **Administrators**.

2. Click the settings icon next to **+ Add Administrator** to open the **Administrator Settings** page.

3. Switch on the **Enable users to manage the organization** toggle.

![Assign an existing user as an admin]({{base_path}}/assets/img/guides/users/enable-users-to-manage-organizations.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

4. Go back to the **Administrators** page and see that the **+ Add Administrator** list is updated as follows:
4. Go back to the **Administrators** tab and see that the **+ Add Administrator** list is updated as follows:

![Add administrator dropdown]({{base_path}}/assets/img/guides/users/add-administrator-dropdown.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

Now, let's assign admin privileges to a user:

1. On the **Administrator** page, click **+Add Administrator > Assign admins from users**.
1. On the **Console Settings** > **Administrator** page, click **+Add Administrator > Assign admins from users**.
2. Select the user you want to add as an administrator and click **Add**.

The new administrator can now access the Asgardeo Console using the following URL:
Expand Down Expand Up @@ -111,7 +111,7 @@ On the Asgardeo Console, go to **Administrators**. You will see the list of admi

To delete an administrator:

1. On the Asgardeo Console, click **Administrators**.
1. On the Asgardeo Console, click **Console Settings** > **Administrators**.
2. Click **Delete** for the administrator you want to remove.
3. Select the checkbox to confirm your action.
4. Click **Confirm**.
59 changes: 26 additions & 33 deletions en/asgardeo/docs/quick-starts/react.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
template: templates/quick-start.html
heading: React Quickstart
description: Welcome to the React Quickstart guide! In this document, you will learn to build a React application, add user login and display user profile information using Asgardeo.
description: Welcome to the React Quickstart guide! In this document, you will learn to build a React app, add user login and display user profile information using Asgardeo.
what_you_will_learn:
- Create new React app using Vite
- Install <a href="https://github.com/asgardeo/asgardeo-auth-react-sdk" target="_blank">@asgardeo/auth-react</a> package
Expand All @@ -18,30 +18,29 @@ whats_next:
- Try out Asgardeo user onboarding complete guide for React
- Read Asgardeo security best practices for React app guide
---

## Configure an application Asgardeo
## Configure an Application in Asgardeo

- Sign into Asgardeo console and navigate to Applications > New Application.
- Select Single Page Application and complete the wizard popup by providing a suitable name and an authorized redirect URL

- Select Single Page Application and Complete the wizard popup by providing a suitable name and an authorized redirect URL
- Name - Asgardeo-React
- Authorized redirect URL - `https://localhost:5173`
- Authorized redirect URL - `http://localhost:5173`

!!! abstract

The authorized redirect URL determines where Asgardeo should send users after they successfully log in. Typically, this will be the web address where your application is hosted. For this guide, we'll use `https://localhost:5173`, as the sample application will be accessible at this URL.
The authorized redirect URL determines where Asgardeo should send users after they successfully log in. Typically, this will be the web address where your app is hosted. For this guide, we'll use`http://localhost:5173`, as the sample app will be accessible at this URL.

!!! note

Note down the following values : you will need them during the **Step 4**
Note down the following values : you will need them during the**Step 4**

- `client-id`
- `base-url`
-`client-id`
- `base-url`
- `redirect-url`

## Create a React application using Vite
## Create a React app using Vite

Create (a.k.a scaffold) your new React application using Vite.
Create (a.k.a scaffold) your new React app using Vite.

=== "npm"

Expand Down Expand Up @@ -79,42 +78,36 @@ Create (a.k.a scaffold) your new React application using Vite.
pnpm run dev
```

## Install @asgardeo/auth-react
## Install @asgardeo/auth-react

Asgardeo React SDK provides all the components and hooks you need to integrate Asgardeo into your app. To get started, simply add the Asgardeo React SDK to the project.

=== "npm"

``` bash
npm install @asgardeo/auth-react
```
``bash npm install @asgardeo/auth-react ``

=== "yarn"

``` bash
yarn add @asgardeo/auth-react
```
``bash yarn add @asgardeo/auth-react ``

=== "pnpm"

``` bash
pnpm add @asgardeo/auth-react
```
``bash pnpm add @asgardeo/auth-react ``

## Add <AuthProvider /> to your app
## Add `<AuthProvider />` to your app

The `<AuthProvider />` serves as a context provider for user login in the app. You can add the AuthProvider to your app by wrapping the root component.
The `<AuthProvider />` serves as a context provider for user login in the app. You can add the AuthProvider to your app by wrapping the root component.

Add the following changes to the `main.jsx` file.

!!! note

Replace below placeholders with your registered organization name in Asgardeo and the generated `client-id` from the app you registered in Asgardeo.
Replace below placeholders with your registered organization name in Asgardeo and the generated`client-id` from the app you registered in Asgardeo.

- `<your-app-client-id>`
- `https://api.asgardeo.io/t/<your-organization-name>`
-`<your-app-client-id>`
- `https://api.asgardeo.io/t/<your-organization-name>`

```javascript title="src/main.jsx" hl_lines="4 7-13 17 19" linenums="1"
```javascript
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App.jsx';
Expand All @@ -139,13 +132,13 @@ ReactDOM.createRoot(document.getElementById('root')).render(

```

## Add login and logout link to your app
## Add login and logout link to your app

Asgardeo provides `useAuthContext` hook to conveniently access user authentication data and sign-in and sign-out methods.
Asgardeo provides `useAuthContext` hook to conveniently access user authentication data and sign-in and sign-out methods.

Replace the existing content of the `App.jsx` file with following content.

```javascript title="src/App.jsx" hl_lines="1 5 9-13" linenums="1"
```javascript
import { useAuthContext } from "@asgardeo/auth-react";
import './App.css';

Expand All @@ -166,17 +159,17 @@ return (
export default App;
```

Visit your app's homepage at [http://localhost:5173](http://localhost:5173).
Visit your app's homepage at [http://localhost:5173](http://localhost:5173).

!!! tip

You need to create a test user in Asgardeo by following this guide to tryout login and logout features.
You need to create a test user in Asgardeo by following this guide to tryout login and logout features.

## Display logged in user details

Modified the code as below to see logged in user details.

```javascript title="src/App.jsx" hl_lines="8-15" linenums="1"
```javascript
...

const App = () => {
Expand Down
2 changes: 2 additions & 0 deletions en/asgardeo/docs/references/grant-types.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{% set product_name = "Asgardeo" %}
{% set grant_type_configs_note = "" %}
{% set base_url = "https://api.asgardeo.io/t/{organization_name}" %}
{% set base_url_example = "https://api.asgardeo.io/t/bifrost" %}
{% include "../../../includes/references/grant-types.md" %}
3 changes: 2 additions & 1 deletion en/asgardeo/docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ See the topics listed below for end-to-end tutorials on how to use Asgardeo with
- [Authenticate users into Flutter applications using Asgardeo]({{base_path}}/tutorials/auth-users-into-flutter-apps/)
- [Connect Asgardeo as an OIDC attribute provider for verifiable credentials (VC) with Microsoft Entra Verified ID]({{base_path}}/tutorials/connect-asgardeo-with-ms-entra/)
- [Connect Asgardeo as an OIDC attribute provider for verifiable credentials (VC) with MATTR]({{base_path}}/tutorials/connect-asgardeo-with-mattr/)
- [Secure Spring Boot API with Asgardeo]({{base_path}}/tutorials/secure-spring-boot-api/)
- [Secure Spring Boot API with Asgardeo]({{base_path}}/tutorials/secure-spring-boot-api/)
- [Integrate Asgardeo with SMART on FHIR healthcare apps]({{base_path}}/tutorials/smart-on-fhir/)
Loading

0 comments on commit c0783d0

Please sign in to comment.