Skip to content

Commit

Permalink
Merge pull request wso2#4559 from divyaamunugama/guides-updates
Browse files Browse the repository at this point in the history
Guides updates
  • Loading branch information
divyaamunugama authored Apr 22, 2024
2 parents 4828504 + 3597f35 commit 559e91f
Show file tree
Hide file tree
Showing 155 changed files with 412 additions and 197 deletions.
2 changes: 1 addition & 1 deletion en/asgardeo/docs/apis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ The process of obtaining access tokens is different for management APIs and othe

- [get access tokens for management APIs]({{base_path}}/apis/authentication/).
- [get access tokens for other APIs]({{base_path}}/guides/authentication/oidc/implement-auth-code/).
- [get access tokens for suborganization APIs]({{base_path}}/apis/organization-management/authentication/).
- [get access tokens for organization APIs]({{base_path}}/apis/organization-management/authentication/).
12 changes: 6 additions & 6 deletions en/asgardeo/docs/apis/organization-apis/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Follow the steps given below to get an access token with the required permission

1. [Register a management app](#register-a-management-app)
2. [Request for authorization code](#get-the-authorization-code)
3. [Request an access token against the root organization](#step-1-for-the-root-organization)
4. [Request an access token against the suborganization](#step-2-for-the-suborganization)
3. [Request an access token against the primary organization](#step-1-for-the-root-organization)
4. [Request an access token against the organization](#step-2-for-the-organization)

## Register a management app

Expand Down Expand Up @@ -69,7 +69,7 @@ https://{{ host_name }}/t/<root_organization_name>/oauth2/authorize?response_typ
</table>

## Get access tokens
In this flow, the application needs to get tokens for the root organization and exchange the obtained token to get an access token for the suborganization.
In this flow, the application needs to get tokens for the root organization and exchange the obtained token to get an access token for the organization.

Let's see how this works:

Expand Down Expand Up @@ -113,7 +113,7 @@ This token request has the following parameters:
</tr>
</table>

### Step 2: For the suborganization
### Step 2: For the organization

You can now request an access token from the token endpoint by exchanging the access token of the root organization and specifying the internal scopes (permission level) you require to access.

Expand All @@ -130,7 +130,7 @@ curl -X POST \
--data-urlencode 'grant_type=organization_switch' \
--data-urlencode 'token=<access token from step 1>' \
--data-urlencode 'scope=<required scopes>' \
--data-urlencode 'switching_organization=<suborganization id>'
--data-urlencode 'switching_organization=<organization id>'
```

Replace the following variables in the above request.
Expand Down Expand Up @@ -163,7 +163,7 @@ Replace the following variables in the above request.
</tr>
<tr>
<td><code>switching_organization</code><Badge text="Required" type="mandatory"/></td>
<td>The organization ID of the suborganization you are switching to. </td>
<td>The ID of the organization you are switching to. </td>
</tr>
</table>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,7 @@ components:
properties:
$ref:
type: string
example: https://api.asgardeo.io/o/{suborganization-id}/scim2/Users/3a12bae9-4386-44be-befd-caf349297f45
example: https://api.asgardeo.io/o/{organization-id}/scim2/Users/3a12bae9-4386-44be-befd-caf349297f45
display:
type: string
example: kim
Expand Down Expand Up @@ -705,7 +705,7 @@ components:
properties:
$ref:
type: string
example: https://api.asgardeo.io/o/{suborganization-id}/scim2/v2/Roles/4645709c-ea8c-4495-8590-e1fa0efe3de0
example: https://api.asgardeo.io/o/{organization-id}/scim2/v2/Roles/4645709c-ea8c-4495-8590-e1fa0efe3de0
display:
type: string
example: loginRole
Expand Down
10 changes: 3 additions & 7 deletions en/asgardeo/docs/apis/restapis/oauth-dcr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ paths:
summary: |
Register an OAuth2 app
description: "This API is used to create an OAuth2 application.
\nIf your want to create your application to use the `implicit` or `authorization_code` grant types, you need to provide the `redirect_uri` field in your request.\
\n If your want to create your application to use the `implicit` or `authorization_code` grant types, you need to provide the `redirect_uri` field in your request.\
\n If you are using any other grant type, \nsuch as `password`, you don't need to send the `redirect_uri` field in the request.
\n Check the sample request given below.\n\n <b>Scope required:</b> `internal_application_mgt_create`."
operationId: registerApplication
Expand Down Expand Up @@ -300,10 +300,10 @@ components:
client_name:
type: string
description: The name of the OAuth2 client application.
client_id:
ext_param_client_id:
type: string
description: The public identifier of the application.
client_secret:
ext_param_client_secret:
type: string
description: The secret corresponding to the `clientId` of the application. This is confidential and will be used to make requests and authenticate into your application.
grant_types:
Expand All @@ -327,10 +327,6 @@ components:
type: string
url:
type: string
ext_param_client_id:
type: string
ext_param_client_secret:
type: string
contacts:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.0
info:
version: "v1"
title: 'B2B Self-Service Management API Definition'
description: 'This is the RESTful API for Self Service Organization Management. This API allows users to create and retrieve sub-organizations.
description: 'This is the RESTful API for Self Service Organization Management. This API allows users to create and retrieve B2B organizations.
Other than that, the API supports updating service configurations'
servers:
- url: 'https://api.asgardeo.io/o/{organization-domain}/api/server/v1/self-service'
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.
Binary file not shown.
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.
Binary file modified en/asgardeo/docs/assets/img/guides/branding/branding-preview.png
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.
Binary file modified en/asgardeo/docs/assets/img/guides/users/add-user-form.png
2 changes: 1 addition & 1 deletion en/asgardeo/docs/get-started/create-asgardeo-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ An organization in Asgardeo will be your own unique space and it will contain yo
Users can log in to applications that you register in Asgardeo. Let's create a user by following the steps below.

1. On the Asgardeo Console, go to **User Management** > **Users**.
2. Click **Add User**.
2. Click **Add User** > **Single User**.
3. Fill in the user's details.

![customer-account-create-ui]({{base_path}}/assets/img/get-started/create-user-account.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Follow the steps given below to register the sample Javascript SPA in Asgardeo.
</tr>
<tr>
<td>Allow sharing with organizations</td>
<td>Enable this to share the new application with all or any selected organizations that belong to your organization (root).</td>
<td>Enable this to share the new application with all or any selected B2B organizations that belong to your primary organization.</td>
</tr>
</table>

Expand Down
2 changes: 1 addition & 1 deletion en/asgardeo/docs/get-started/try-samples/qsg-spa-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Follow the steps given below to register the sample React SPA in Asgardeo.
</tr>
<tr>
<td>Allow sharing with organizations</td>
<td>Enable this to share the new application with all or any selected organizations that belong to your organization (root).</td>
<td>Enable this to share the new application with all or any selected B2B organizations that belong to your primary organization.</td>
</tr>
</table>

Expand Down
5 changes: 2 additions & 3 deletions en/asgardeo/docs/guides/asgardeo-logs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ You can change the timeframe of the logs by clicking the dropdown next to the se

![Logs filter by time]({{base_path}}/assets/img/guides/asgardeo-logs/logs-filter-by-time.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

::: info
By default, the console displays logs that occurred in the last 15 minutes.
:::
!!! note
By default, the console displays logs that occurred in the last 15 minutes.

Besides the given timeframes, you can select a custom time range by following the steps below.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,20 @@ The available templates are categorized as follows:

- Access Control - These templates restrict user login to the application based on specified conditions.
- Adaptive MFA - These templates prompt two-factor authentication for login attempts based on specific conditions.
- Passkey Enrollment - These templates allows users to progressively enroll with passkey authenticator.

The pre-defined templates are listed below.

| Template | Description |
|-----------|-------------|
| [User-Age-Based]({{base_path}}/guides/authentication/conditional-auth/user-age-based-template/) | This configures a login flow where users can log in only if their age is over the configured value. The user's age is calculated using the `date of birth` attribute. |
| [Group-Based (Access Control)]({{base_path}}/guides/authentication/conditional-auth/group-based-template-access-control/) | This login flow allows login only for users who belong to any of the given set of groups |
| [Session Based]({{base_path}}/uides/authentication/conditional-auth/concurrent-sessions-based-template/) | This login flow allows login only for users who have less than the configured number of concurrent sessions. |
| [Sign-In-Option-Based]({{base_path}}/guides/authentication/conditional-auth/sign-in-option-based-template/) | This login flow prompts two-factor authentication (2FA) only for users who are signing in with a given option. |
| [New-Device-Based]({{base_path}}/guides/authentication/conditional-auth/new-device-based-template/) | This login flow sends an email notification and/or prompts two-factor authentication for users who are logged in from a previously unused device. |
| [Group-Based (Adaptive MFA)]({{base_path}}/guides/authentication/conditional-auth/group-based-template/) | This login flow prompts two-factor authentication (2FA) for users who belong to any of the given set of groups. |
| [IP-Based]({{base_path}}/guides/authentication/conditional-auth/ip-based-template/) | This login flow prompts two-factor authentication for users who log in from outside the given IP range. |
| [Passkey-Progressive-Enrollment-Based]({{base_path}}/guides/authentication/conditional-auth/passkey-progressive-enrollment-based-template/) | This login flow permits users to seamlessly enroll their passkey on-the-fly, when Passkey is designated as the first authentication factor. |
| [Passkey-Progressive-Enrollment-Based]({{base_path}}/guides/authentication/conditional-auth/passkey-progressive-enrollment-based-template/) | This login flow allows users to progressively enroll with passkey authenticator. |

If required, you can also use the script editor to introduce new functions and fields to an authentication script based on your requirement. See the instructions on [writing a custom authentication script]({{base_path}}/guides/authentication/conditional-auth/write-your-first-script/).

Expand Down
7 changes: 6 additions & 1 deletion en/asgardeo/docs/guides/monitoring/asgardeo-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ Follow the steps below to create and deploy a webhook in Choreo.

8. Follow the Choreo documentation and [deploy your webhook](https://wso2.com/choreo/docs/develop-components/develop-a-webhook/#step-2-deploy){:target="_blank"}.

!!! note
If the callback URL fails to populate, it is advised to manually copy the invoke URL and paste it into the designated field. This step ensures seamless continuity in the process.

### Try it out

Once the webhook is deployed in Choreo, follow the steps below to try it out.
Expand Down Expand Up @@ -310,6 +313,7 @@ Example login success event payload:
]
}
```

#### **Login failed event**

When a user fails to log in to an application, an event with the following data is created.
Expand Down Expand Up @@ -444,7 +448,7 @@ Example user account lock event payload:

#### **User credential update event**

A user's credentials (passwords) update event with the following data is generated when a user's credentials are updated by one of the methods below.
A user's credential (password) update event with the following data is generated when a user credential is updated by one of the methods below.
- an administrator resets them through the Console.
- an administrator forces a reset.
Expand Down Expand Up @@ -494,6 +498,7 @@ A user's credentials (passwords) update event with the following data is generat
</table>
Example User credential update event payload:
Consider a scenario where an administrator resets the user credential through the Console.
``` js
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Asgardeo allows admins to assign the following attributes as alternative login i

To configure alternative login identifiers for your organization:

1. On the Asgardeo Console, go to **Organizational Settings** > **Account Login**.
1. On the Asgardeo Console, go to ***Login & Registration**.

2. Click **Configure** to open the **Alternative Login Identifiers** page.
2. Under **Login Identifier**, click on **Alternative Login Identifier**.

3. Select `Email` and/or `Mobile` as alternative login identifiers.

Expand Down
9 changes: 5 additions & 4 deletions en/asgardeo/docs/guides/users/manage-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This guide walks you through the process of managing a user account. An owner or an administrator can manage user accounts.

## Onboard a user
## Onboard users
There are three ways to onboard a user:

- The user can self-register via the My Account portal or the login page of an application if self-registration is enabled in the organization. Learn how to [configure self-registration]({{base_path}}/guides/user-accounts/configure-self-registration/).
Expand All @@ -16,7 +16,7 @@ There are three ways to onboard a user:
Let's look at how administrators can onboard users from the {{ product_name }} Console.

1. On the {{ product_name }} Console, go to **User Management** > **Users**.
2. Click **Add User** and provide the following details:
2. Click **Add User** > **Single User** and provide the following details:

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

Expand Down Expand Up @@ -54,7 +54,7 @@ In addition to adding a single user, you can onboard multiple users at once, eit
![Add multiple users]({{base_path}}//assets/img/guides/users/add-multiple-users-form.png)

!!! note
Currently, when importing multiple users, the user accounts are created in the **DEFAULT** user store.
Importing multiple users is only supported for the Asgardeo-provided **DEFAULT** user store.

#### Add multiple users manually

Expand All @@ -64,7 +64,8 @@ In addition to adding a single user, you can onboard multiple users at once, eit
4. Enter the email addresses of the users you want to invite. Press **Enter** after each email to add it to the list.
5. Under Groups, select the group(s) from the dropdown to which users will be added during the import.
6. Click **Add** to send out the invitations.
7. An email with a confirmation link will be sent to the provided email addresses, allowing the users to set their own passwords.

An email with a confirmation link will be sent to the provided email addresses, allowing the users to set their own passwords.

#### Add multiple users using a CSV file

Expand Down
2 changes: 1 addition & 1 deletion en/asgardeo/docs/guides/users/migrate-users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Migrate users to Asgardeo

Owners of organizations in Asgardeo may need to migrate users from an existing identity provider (IdP) to the Asgardeo user store. This guide explains why you may need user migration and how to get it done.
Organization owners in Asgardeo may need to migrate users from an existing identity provider (IdP) to the Asgardeo user store. This guide explains why you may need user migration and how to get it done.

## When is user migration required?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Follow the guide below to set up a remote user store in Asgardeo.
## Register a remote user store
To configure a remote user store for your organization:

1. On the Asgardeo Console, go to **User Management** > **User Stores**.
1. On the Asgardeo Console, go to **User Attributes & Stores** > **User Stores**.
2. Click **Connect userstore** to open the following:

![Register remote user store to Asgardeo]({{base_path}}/assets/img/guides/user-stores/register-user-store.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
Expand Down
8 changes: 4 additions & 4 deletions en/asgardeo/docs/tutorials/connect-asgardeo-with-ms-entra.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,11 +215,11 @@ In this step, you will configure the connection between Asgardeo and the Microso

2. Click **New Application** and select **Mobile Application**:

![register new app in Asgardeo]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/img-12.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
![register new app in Asgardeo]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/select-mobile-template.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

3. Enter the following details:

![add mobile app configurations]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/img-13.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
![add mobile app configurations]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/add-entra-sample-mobile-app-info.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

<table>
<tr>
Expand All @@ -240,7 +240,7 @@ In this step, you will configure the connection between Asgardeo and the Microso

5. Go to the **User Attributes** tab, mark the required attributes as **Mandatory**, and click **Update** to save the changes.

![add user attributes to mobile app]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/img-14.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
![add user attributes to mobile app]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/add-entra-sample-mobile-app-user-attributes.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

!!! tip
Be sure to copy the scopes displayed on the page.
Expand All @@ -256,7 +256,7 @@ In this step, you will configure the connection between Asgardeo and the Microso
!!! note
This step is required to ensure you can log in to the application. You need a business user registered in the Asgardeo organization to be able to perform user login.

![add new user to organization]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/img-15.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
![add new user to organization]({{base_path}}/assets/img/tutorials/oidc-attribute-provider-ms/add-new-user-to-organization.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

## Step 3: Create a verifiable credential for the ID token

Expand Down
2 changes: 1 addition & 1 deletion en/asgardeo/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ nav:
- Set up conditional authentication: guides/authentication/conditional-auth/configure-conditional-auth.md
- Add access control:
- Add access control: guides/authentication/conditional-auth/access-control.md
- Age-based access: guides/authentication/conditional-auth/user-age-based-template.md
- User Age-based access: guides/authentication/conditional-auth/user-age-based-template.md
- Group-based access: guides/authentication/conditional-auth/group-based-template-access-control.md
- Add adaptive MFA:
- Add adaptive MFA: guides/authentication/conditional-auth/adaptive-mfa.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Follow the steps given below to register the sample Javascript SPA in the WSO2 I
</tr>
<tr>
<td>Allow sharing with organizations</td>
<td>Enable this to share the new application with all or any selected organizations that belong to your organization (root).</td>
<td>Enable this to share the new application with all or any selected B2B organizations that belong to your primary organization.</td>
</tr>
</table>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Follow the steps given below to register the sample React SPA in the {{ product_
</tr>
<tr>
<td>Allow sharing with organizations</td>
<td>Enable this to share the new application with all or any selected organizations that belong to your organization (root).</td>
<td>Enable this to share the new application with all or any selected B2B organizations that belong to your primary organization.</td>
</tr>
</table>

Expand Down
Loading

0 comments on commit 559e91f

Please sign in to comment.