Skip to content

Commit

Permalink
Merge pull request #4620 from himeshsiriwardana/application-disable-f…
Browse files Browse the repository at this point in the history
…eature

Added docs for the disable feature for applications
  • Loading branch information
himeshsiriwardana authored Jun 11, 2024
2 parents 227f475 + 3d99c16 commit 059292d
Show file tree
Hide file tree
Showing 19 changed files with 125 additions and 63 deletions.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

{% set my_account_link = "<code>https://myaccount.asgardeo.io/t/{organization_name}</code>

For example, if your organization name is bifrost, the link to your My Account portal is,
For example, if your organization name is bifrost, the link to your My Account portal is <code>https://myaccount.asgardeo.io/t/bifrost</code>" %}

<code>https://myaccount.asgardeo.io/t/bifrost</code>" %}

{% include "../../../../includes/guides/user-self-service/customer-self-service-portal.md" %}
{% include "../../../../includes/guides/user-self-service/configure-self-service-portal.md" %}
4 changes: 2 additions & 2 deletions en/asgardeo/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ nav:
- Manage remote user stores: guides/users/user-stores/update-user-stores.md
- Account management:
- Account management: guides/user-accounts/index.md
- Configure self-service portal: guides/user-accounts/configure-self-service-portal.md
- Configure the self-service portal: guides/user-accounts/configure-self-service-portal.md
- Configure password recovery: guides/user-accounts/password-recovery.md
- Configure self-registration: guides/user-accounts/configure-self-registration.md
- Manage account security:
Expand All @@ -265,7 +265,7 @@ nav:
- User self-service:
- User self-service: guides/user-self-service/index.md
- Self-service portal:
- User self-service portal: guides/user-self-service/customer-self-service-portal.md
- Configure the self-service portal: guides/user-self-service/configure-self-service-portal.md
- Update profile information: guides/user-self-service/update-profile-info.md
- Change password: guides/user-self-service/change-password.md
- Manage linked social accounts: guides/user-self-service/manage-linked-accounts.md
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ For example, if using the default settings, the link to your My Account portal i
<code>https://localhost:9443/myaccount</code>" %}


{% include "../../../../../includes/guides/user-self-service/customer-self-service-portal.md" %}
{% include "../../../../../includes/guides/user-self-service/configure-self-service-portal.md" %}
4 changes: 2 additions & 2 deletions en/identity-server/7.0.0/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ plugins:
'guides/identity-lifecycles/enable-email-account-verification-for-an-updated-email-address.md': 'guides/users/attributes/manage-attributes.md'
'guides/identity-lifecycles/enable-verification-for-updated-mobile-number.md': 'guides/users/attributes/manage-attributes.md'

'guides/my-account/my-account.md': 'guides/user-self-service/customer-self-service-portal.md'
'guides/my-account/my-account.md': 'guides/user-self-service/configure-self-service-portal.md'
'guides/my-account/manage-own-profile.md': 'guides/user-self-service/update-profile-info.md'
'guides/my-account/export-my-user-profile.md': 'guides/user-self-service/export-profile-information.md'
'guides/my-account/link-own-accounts.md': 'guides/user-self-service/manage-linked-accounts.md'
Expand Down Expand Up @@ -514,7 +514,7 @@ nav:
- User self-service:
- User self-service: guides/user-self-service/index.md
- Self-service portal:
- User self-service portal: guides/user-self-service/customer-self-service-portal.md
- Configure the self-service portal: guides/user-self-service/configure-self-service-portal.md
- Update profile information: guides/user-self-service/update-profile-info.md
- Change password: guides/user-self-service/change-password.md
- Manage linked social accounts: guides/user-self-service/manage-linked-accounts.md
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ For example, if using the default settings, the link to your My Account portal i
<code>https://localhost:9443/myaccount</code>" %}


{% include "../../../../../includes/guides/user-self-service/customer-self-service-portal.md" %}
{% include "../../../../../includes/guides/user-self-service/configure-self-service-portal.md" %}
5 changes: 3 additions & 2 deletions en/identity-server/next/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@ plugins:
'guides/identity-lifecycles/enable-email-account-verification-for-an-updated-email-address.md': 'guides/users/attributes/manage-attributes.md'
'guides/identity-lifecycles/enable-verification-for-updated-mobile-number.md': 'guides/users/attributes/manage-attributes.md'

'guides/my-account/my-account.md': 'guides/user-self-service/customer-self-service-portal.md'
'guides/my-account/my-account.md': 'guides/user-self-service/configure-self-service-portal.md'
'guides/user-self-service/customer-self-service-portal.md': 'guides/user-self-service/configure-self-service-portal.md'
'guides/my-account/manage-own-profile.md': 'guides/user-self-service/update-profile-info.md'
'guides/my-account/export-my-user-profile.md': 'guides/user-self-service/export-profile-information.md'
'guides/my-account/link-own-accounts.md': 'guides/user-self-service/manage-linked-accounts.md'
Expand Down Expand Up @@ -512,7 +513,7 @@ nav:
- User self-service:
- User self-service: guides/user-self-service/index.md
- Self-service portal:
- User self-service portal: guides/user-self-service/customer-self-service-portal.md
- configure the self-service portal: guides/user-self-service/configure-self-service-portal.md
- Update profile information: guides/user-self-service/update-profile-info.md
- Change password: guides/user-self-service/change-password.md
- Manage linked social accounts: guides/user-self-service/manage-linked-accounts.md
Expand Down
65 changes: 44 additions & 21 deletions en/includes/guides/applications/index.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,72 @@
# Applications

Regardless of the application type or the development technology, you can connect your application with {{ product_name }} and control the way users log in to your app.
Registering your application is the first step towards unlocking the full spectrum of features offered by {{product_name}}.

Currently, {{ product_name }} supports integrating {{ no_of_supported_app_types }} application types. When you select an application type, {{ product_name }} provides all the recommended configs in place by default which you can change as needed later.
## Register an application

## Single-page applications
{{ product_name }} supports integrating {{ no_of_supported_app_types }} application types. Once registered, {{product_name}} sets the default configurations for your application which can easily be customized according to your requirements.

Single-page applications(SPAs) are apps that run on the browser and do not require a page reload with a change
in content.
### Single-page applications

The main advantage of a single-page application is its speed. Since content is dynamically updated as the user interacts with it, the user does not need to wait for page reloads. Users can experience a seamless flow with high responsiveness from the application.

JavaScript frameworks and libraries, such as React, Angular, Vue.js, are some popular technologies adopted to build SPAs.
Single-page applications (SPAs) run on the browser and dynamically update the content as the user interacts with it. As the user does not need to wait page reloads, users have a seamless experience with high responsiveness. JavaScript frameworks and libraries such as React, Angular and Vue.js are some popular technologies adopted to build SPAs.

- [Register a single-page application]({{base_path}}/guides/applications/register-single-page-app/)

## Web applications
### Web applications

Web applications(web apps) are the most common type of applications in use. They are usually hosted on a web server
and accessed by the browser. Web applications need authentication as they offer functionality dependent on the logged-in user.
Web applications (web apps) are the most common type of applications in use. They are usually hosted on a web server and accessed by a browser. Web applications require authentication as they offer functionality specific to logged-in users.

- [Register a web application with OIDC]({{base_path}}/guides/applications/register-oidc-web-app/)
- [Register a web application with SAML]({{base_path}}/guides/applications/register-saml-web-app/)
- [Register a web application with SAML]({{base_path}}/guides/applications/register-saml-web-app/)

## Mobile applications
### Mobile applications

Mobile applications are apps that run on mobile devices. Android and iOS are some of the popular technologies adopted to build Mobile Applications.
Mobile applications are apps that run on mobile devices. Android and iOS are some of the popular technologies adopted to build mobile applications.

- [Register a mobile application]({{base_path}}/guides/applications/register-mobile-app/)

## Standard-based applications
### Standard-based applications

Standard-based applications allow users to configure the application protocol settings (OIDC or SAML) from scratch.
Standard-based applications allow you to configure the application protocol settings (OIDC or SAML) from scratch.

- [Register a standard-based application]({{base_path}}/guides/applications/register-standard-based-app)

{% if product_name == "WSO2 Identity Server" %}
## Machine-to-Machine (M2M) applications
### Machine-to-Machine (M2M) applications

Machine-to-Machine applications, often referred to as M2M applications, are a category of applications designed for automated communication and interaction between devices or services without direct human intervention.
Unlike user-centric applications, M2M applications cater to non-interactive scenarios, including command-line tools, daemons, IoT (Internet of Things) devices, or services running on the backend.
Machine-to-Machine (M2M) applications, are designed for automated communication and interaction between devices or services without direct human intervention. Unlike user-centric applications, M2M applications cater to non-interactive scenarios, including command-line tools, daemons, IoT (Internet of Things) devices, or services running on the backend.

- [Register a machine-to-machine application]({{base_path}}/guides/applications/register-machine-to-machine-app/)
{% endif %}

## Self-Service (My Account) portal
## Enable/Disable an application

If your application is undergoing maintenance, or should be made unavailable for users to log in for other reasons, you can disable the application.

!!! note
Disabling prevents any new logins to the application, revokes active access tokens and consents provided for the application. Upon re-enabling the application, users must reprovide any consents that they had previously granted.

To disable an application,

1. On the {{product_name}} Console, go to **Applications**.

2. Select the application you wish to disable and go to its **General** tab.

3. Scroll down to the **Danger Zone**.

4. Under **Disable application**, switch the toggle on to disable the application or off to enable it.

![Disable an application]({{base_path}}/assets/img/guides/applications/disable-application.png)


## Delete an application

To delete an application,

1. On the {{product_name}} Console, go to **Applications**.

2. Select the application you wish to delete and go to its **General** tab.

3. Scroll down to the **Danger Zone**.

Application users can access the My Account portal for self-service needs. Learn more about the [Self-Service portal]({{base_path}}/guides/user-self-service/).
4. Click Delete under **Delete application** and confirm your action.
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ If you wish to register your application manually using the Console, follow the

5. Click **Register** to complete the registration.

6. [Enable the application]({{base_path}}/guides/applications/#enabledisable-an-application) when it is ready for users to log in.


### Use Dynamic Client Registration (DCR)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ To register the app:

4. Click **Register** to complete the registration.

5. [Enable the application]({{base_path}}/guides/applications/#enabledisable-an-application) when it is ready for use.


## Authorize the API resources for the app

You can authorize your M2M applications to access APIs and their scopes(permissions) from **API Authorization** tab of the application, as shown below.
Expand Down
4 changes: 3 additions & 1 deletion en/includes/guides/applications/register-mobile-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To register the app:

5. Click **Register** to complete the registration.

!!! note
??? details "Sharing with selected organizations"
If you have enabled **Allow sharing with organizations** while registering the application, you will see a popup window with the following options.

![Share the application with organizations]({{base_path}}/assets/img/guides/applications/share-application.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
Expand All @@ -59,6 +59,8 @@ To register the app:
</tr>
</table>

6. [Enable the application]({{base_path}}/guides/applications/#enabledisable-an-application) when it is ready for use.

## Get the client ID

When you register your mobile application, a client ID is generated. Your mobile application will identify itself to {{ product_name }} with this client ID.
Expand Down
4 changes: 3 additions & 1 deletion en/includes/guides/applications/register-oidc-web-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To register the app:

4. Click **Register** to complete the registration.

!!! note
??? details "Sharing with selected organizations"
If you have enabled **Allow sharing with organizations** while registering the application, you will see a popup window with the following options.

![Share the application with organizations]({{base_path}}/assets/img/guides/applications/share-application.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
Expand All @@ -66,6 +66,8 @@ To register the app:
</tr>
</table>

5. [Enable the application]({{base_path}}/guides/applications/#enabledisable-an-application) when it is ready for use.

## Get the client ID and secret

When you register your web application, a client ID and client secret are generated. Your web application will identify itself to {{ product_name }} with these credentials.
Expand Down
6 changes: 4 additions & 2 deletions en/includes/guides/applications/register-saml-web-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ To register the app:
</tr>
</table>

6. [Optional] Enable **Allow sharing with organizations** to share the new application with all or any selected organizations that belong to your organization (root).
6. [Optional] Enable **Allow sharing with organizations** to share the new application with all or any selected organizations that belong to your organization.

7. Click **Register** to complete the registration.

!!! note
??? details "Sharing with selected organizations"
If you have enabled **Allow sharing with organizations** while registering the application, you will see a popup window with the following options.

![Share the application with organizations]({{base_path}}/assets/img/guides/applications/share-application.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
Expand All @@ -65,6 +65,8 @@ To register the app:
</tr>
</table>

8. [Enable the application]({{base_path}}/guides/applications/#enabledisable-an-application) when it is ready for use.

### Add SAML configs manually

If you selected **Manual** in the previous step, you can manually specify the SAML configurations as follows:
Expand Down
4 changes: 3 additions & 1 deletion en/includes/guides/applications/register-single-page-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To register the app:

4. Click **Register** to complete the registration.

!!! note
??? details "Sharing with selected organizations"
If you have enabled **Allow sharing with organizations** while registering the application, you will see a popup window with the following options.

![Share the application with organizations]({{base_path}}/assets/img/guides/applications/share-application.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
Expand All @@ -61,6 +61,8 @@ To register the app:
</tr>
</table>

5. [Enable the application]({{base_path}}/guides/applications/#enabledisable-an-application) when it is ready for use.

## Get the client ID

When you register your single-page application, a client ID is generated. Your application will identify itself to {{ product_name }} with this client ID.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Configure the self-service portal

Users and administrators in your organization can manage their accounts and information by accessing the **My Account portal**, a self-service portal offered by {{product_name}}.

## Access the My Account portal

Users can access the My Account portal using the following link - {{my_account_link}}

Listed below are self-service features that are available for the user in the **My Account portal**.

- [Update profile information]({{base_path}}/guides/user-self-service/update-profile-info/)
- [Change password]({{base_path}}/guides/user-self-service/change-password/)
- [View and revoke consents given to applications]({{base_path}}/guides/user-self-service/manage-consents/)
- [Enroll TOTP]({{base_path}}/guides/user-self-service/enable-totp/)
- [Manage backup codes]({{base_path}}/guides/user-self-service/manage-backup-codes/)
- [Manage linked social accounts]({{base_path}}/guides/user-self-service/manage-linked-accounts/)
- [Export profile information]({{base_path}}/guides/user-self-service/export-profile-information/)
- [View and revoke login sessions]({{base_path}}/guides/user-self-service/manage-login-sessions/)
- [Manage password recovery]({{base_path}}/guides/user-self-service/user-password-recovery/)
- [Discover and maintain applications]({{base_path}}/guides/user-self-service/discover-applications/)
- [Register passkeys]({{base_path}}/guides/user-self-service/register-passkey/)

{% if product_name == "Asgardeo" %}
## Enable/Disable the My Account portal

Follow the steps given below to manage access to the My Account portal for users in your organization.

1. On the {{product_name}} Console, go to **Applications** and locate the My Account application at the top.

2. Click the settings icon to enter the **My Account** configuration page.

3. In the **Danger Zone**, under **Disable application**, switch the toggle on to disable the My Account portal or off to enable it for users.

![Disable my account application]({{base_path}}/assets/img/guides/users/disable-my-account-application.png)
{% endif %}

## Configure the My Account portal login flow

Just like any other appliaction registered in {{product_name}}, you can customize the login flow of the My Account portal along with multi-factor and adaptive authentication.

To do so,

1. On the {{product_name}} Console, go to **Applications** and locate the My Account application at the top.

2. Click the settings icon to enter the **My Account** configuration page.

3. Go to the **Login Flow** tab and customize the login flow.

!!! note
Explore the authentication options offered by {{product_name}} in the [Authentication]({{base_path}}/guides/authentication/) section.

4. Click **Update** to save the changes.
Loading

0 comments on commit 059292d

Please sign in to comment.