diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b4200ce56..b1ba4689da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to WSO2 Identity Server / Asgardeo Documentation +# Contributing to WSO2 Identity Server / WSO2 Identity Platform Documentation -We would really appreciate your contributions to WSO2 Identity Server / Asgardeo Docs to help make it even better than it is today! +We would really appreciate your contributions to WSO2 Identity Server / WSO2 Identity Platform Docs to help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: - [Adding Quickstart guides](#adding-quickstart-guides) diff --git a/README.md b/README.md index 0d6f12c2d2..8e2ff9e018 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This repository holds the source code and content for the following product documentation: - WSO2 Identity Server - [https://is.docs.wso2.com/](https://is.docs.wso2.com/) -- Asgardeo - [https://wso2.com/asgardeo/docs/](https://wso2.com/asgardeo/docs/) +- WSO2 Identity Platform - [https://wso2.com/asgardeo/docs/](https://wso2.com/asgardeo/docs/) ## Table of content @@ -27,7 +27,7 @@ Choose one of the following methods depending on your preference. ### With Python virtual environments -You can run the Asgardeo docs and WSO2 Identity Server docs locally using Python virtual environments as well. +You can run the WSO2 Identity Platform docs and WSO2 Identity Server docs locally using Python virtual environments as well. #### Prerequisites > @@ -58,7 +58,7 @@ You can run the Asgardeo docs and WSO2 Identity Server docs locally using Python 1. Switch to the documentation you want to run locally. - For Asgardeo: + For WSO2 Identity Platform: ```bash cd en/asgardeo @@ -90,7 +90,7 @@ You can run the Asgardeo docs and WSO2 Identity Server docs locally using Python cd en/identity-server/{version} && pip3 install -r requirements.txt ``` - - Asgardeo + - WSO2 Identity Platform ```bash cd en/asgardeo && pip3 install -r requirements.txt diff --git a/en/asgardeo/docs/apis/index.md b/en/asgardeo/docs/apis/index.md index 6ea2a82da9..966b848c87 100644 --- a/en/asgardeo/docs/apis/index.md +++ b/en/asgardeo/docs/apis/index.md @@ -1,8 +1,8 @@ # APIs - Overview -Asgardeo exposes most of the features via REST APIs. Those APIs are categorized into the following categories based on the usage. +WSO2 Identity Platform exposes most of the features via REST APIs. Those APIs are categorized into the following categories based on the usage. - - Management APIs - APIs that are consumed by an application using Asgardeo as the Identity Provider. + - Management APIs - APIs that are consumed by an application using WSO2 Identity Platform as the Identity Provider. - Organization APIs - APIs that are consumed by the B2B SaaS applications for organization-level operations. @@ -28,14 +28,14 @@ Applications, by default, do not have permission to consume API resources. There To authorize the application, -1. On the Asgardeo Console, go to **Applications**. +1. On the WSO2 Identity Platform Console, go to **Applications**. 2. Select the created application and go to its **API Authorization** tab. 3. Click **Authorize an API Resource** and provide the relevant details of the API resource. Repeat the step for the required APIs !!! tip - For Asgardeo REST APIs, find the relevant scopes from the API definition. + For WSO2 Identity Platform REST APIs, find the relevant scopes from the API definition. 4. Click **Finish** to save the changes. diff --git a/en/asgardeo/docs/apis/organization-apis/index.md b/en/asgardeo/docs/apis/organization-apis/index.md index c3313207c8..f5c2c0c29b 100644 --- a/en/asgardeo/docs/apis/organization-apis/index.md +++ b/en/asgardeo/docs/apis/organization-apis/index.md @@ -1,12 +1,12 @@ # Organization APIs -This is the REST API documentation for organizations in Asgardeo. +This is the REST API documentation for organizations in WSO2 Identity Platform. -## APIs in Asgardeo +## APIs in WSO2 Identity Platform -Asgardeo exposes a set of APIs, allowing you to manage various organization settings and application settings programmatically. This is an alternative to using the Asgardeo Console. +WSO2 Identity Platform exposes a set of APIs, allowing you to manage various organization settings and application settings programmatically. This is an alternative to using the WSO2 Identity Platform Console. -Some of these APIs are used for organization management purposes, and they have special [authentication](#authentication) requirements. The management APIs of organization in Asgardeo are as follows: +Some of these APIs are used for organization management purposes, and they have special [authentication](#authentication) requirements. The management APIs of organization in WSO2 Identity Platform are as follows: - [Organization user management (SCIM2) API]({{base_path}}/apis/organization-apis/scim2/) @@ -17,14 +17,14 @@ Some of these APIs are used for organization management purposes, and they have - [Organization level organization management API]({{base_path}}/apis/organization-apis/org-management) !!! warning - You need a paid Asgardeo subscription to use organization level organization management feature. If you don't already have one, view the available [subscription plans](https://wso2.com/asgardeo/pricing/){:target="_blank"} and contact the Asgardeo sales team. + You need a paid WSO2 Identity Platform subscription to use organization level organization management feature. If you don't already have one, view the available [subscription plans](https://wso2.com/asgardeo/pricing/){:target="_blank"} and contact the WSO2 Identity Platform sales team. - [Idle account identification API]({{base_path}}/apis/organization-apis/org-idle-account-identification) ## Authentication -You need an access token to invoke APIs in organizations of Asgardeo. You can generate the required access tokens if you are an administrator or developer with access to the Asgardeo Console. +You need an access token to invoke APIs in organizations of WSO2 Identity Platform. You can generate the required access tokens if you are an administrator or developer with access to the WSO2 Identity Platform Console. !!! note Learn how to [get access tokens for organization management APIs]({{base_path}}/apis/organization-apis/authentication/). diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/account-recovery.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/account-recovery.yaml index e3507dc049..04439b09fe 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/account-recovery.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/account-recovery.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: Recovery API description: | - This document specifies a **Organization level Recovery related RESTful API** for Asgardeo. + This document specifies a **Organization level Recovery related RESTful API** for WSO2 Identity Platform. version: 0.9.0 servers: - url: https://api.asgardeo.io/t/{root-organization-name}/o/api/identity/recovery/v0.9 diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/actions.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/actions.yaml index 80f6f9235a..a1f5bcb328 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/actions.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/actions.yaml @@ -1,10 +1,10 @@ openapi: 3.0.0 info: version: v1 - title: Asgardeo - Action Management Rest API + title: WSO2 Identity Platform - Action Management Rest API description: > The Action Management REST API provides a comprehensive interface to manage actions - within the Asgardeo. Actions enable the extension of product functionality + within the WSO2 Identity Platform. Actions enable the extension of product functionality across various workflows, such as password updates, and profile updates. This API helps developers and administrators to define and manage actions to meet specific business needs. diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/api-resources.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/api-resources.yaml index ace4944daa..13fc1a7a07 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/api-resources.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/api-resources.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: description: > - This document explains the RESTful API for API Resource Management in Asgardeo. + This document explains the RESTful API for API Resource Management in WSO2 Identity Platform. version: "v1" - title: Asgardeo - API Resource Management Rest API + title: WSO2 Identity Platform - API Resource Management Rest API security: - OAuth2: [] diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/application.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/application.yaml index 9bcf1c8ebc..08a879d1bd 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/application.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/application.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: description: > - This document explains the RESTful API for application management of organizations in Asgardeo. + This document explains the RESTful API for application management of organizations in WSO2 Identity Platform. version: "v1" - title: Asgardeo - Application Management Rest API + title: WSO2 Identity Platform - Application Management Rest API security: - OAuth2: [] paths: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/association-management-by-admin.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/association-management-by-admin.yaml index 22d24d2b30..99d6ca2d35 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/association-management-by-admin.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/association-management-by-admin.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: User Account Association API description: | - This document specifies a **User Account Association Management RESTful API** for **Asgardeo**. + This document specifies a **User Account Association Management RESTful API** for **WSO2 Identity Platform**. The APIs provide the capability for privileged users to retrieve/delete associated local/federated accounts of other users. version: v1 servers: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/authenticators.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/authenticators.yaml index 9327924f7c..02e306a8f9 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/authenticators.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/authenticators.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: version: "v1" title: 'Authenticators API' - description: 'This document specifies a **Organization level Authenticators RESTful API** for Asgardeo.' + description: 'This document specifies a **Organization level Authenticators RESTful API** for WSO2 Identity Platform.' servers: - url: 'https://api.asgardeo.io/t/{root-organization-name}/o/api/server/v1' diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/branding-management.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/branding-management.yaml index bd7fb1f6b4..4c3586c962 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/branding-management.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/branding-management.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Branding Preferences API description: | - This document specifies a RESTful API for **Managing Branding Preferences of Organizations** in Asgardeo. + This document specifies a RESTful API for **Managing Branding Preferences of Organizations** in WSO2 Identity Platform. version: v1 servers: - url: 'https://api.asgardeo.io/t/{root-organization-name}/o/api/server/v1' diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml index 3fa57c9b68..b5b2513695 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml @@ -2,9 +2,9 @@ openapi: 3.0.1 info: title: Claim Management API description: | - This document specifies an **Organization level Claim Management RESTful API** for Asgardeo. + This document specifies an **Organization level Claim Management RESTful API** for WSO2 Identity Platform. - This API allows retrieving local/external claims and claim dialects. Organizations have the default claims/claim dialtect defined in Asgardeo and custom claims used by B2B shared apps. + This API allows retrieving local/external claims and claim dialects. Organizations have the default claims/claim dialtect defined in WSO2 Identity Platform and custom claims used by B2B shared apps. version: v1 servers: - url: https://api.asgardeo.io/t/{root-organization-name}/o/api/server/v1 diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/idle-account-identification.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/idle-account-identification.yaml index db3e198d0b..1e0025ac26 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/idle-account-identification.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/idle-account-identification.yaml @@ -1,10 +1,10 @@ openapi: 3.0.0 info: description: - "This document specifies a RESTful API for identifying idle business user accounts in Asgardeo. The API provides the capability to retrieve a list of inactive users after a specified date. - \n\n To access the idle account identification API in Asgardeo, you need to first get an access token from your organization." + "This document specifies a RESTful API for identifying idle business user accounts in WSO2 Identity Platform. The API provides the capability to retrieve a list of inactive users after a specified date. + \n\n To access the idle account identification API in WSO2 Identity Platform, you need to first get an access token from your organization." version: "v1" - title: Asgardeo - Idle Account Identification Rest API + title: WSO2 Identity Platform - Idle Account Identification Rest API security: - OAuth2: [] servers: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/idp.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/idp.yaml index 8908d08ec6..43c49ecfa0 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/idp.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/idp.yaml @@ -1,10 +1,10 @@ openapi: 3.0.0 info: description: > - This document specifies the **Identity Provider Management API** for organizations in Asgardeo. The APIs provide the capability to add/update/delete/patch identity providers. + This document specifies the **Identity Provider Management API** for organizations in WSO2 Identity Platform. The APIs provide the capability to add/update/delete/patch identity providers. In addition, APIs are available to retrieve metadata about federated authenticators and outbound provisioning connectors that can be configured for any given identity provider. version: "v1" - title: Asgardeo - Identity provider management API definition + title: WSO2 Identity Platform - Identity provider management API definition security: - OAuth2: [] paths: @@ -246,7 +246,7 @@ paths: summary: | Metadata about supported federated authenticators of identity providers description: >- - This API provides the list of supported federated authenticators for an identity provider in Asgardeo.
+ This API provides the list of supported federated authenticators for an identity provider in WSO2 Identity Platform.
Scope required: `internal_org_idp_view` operationId: getMetaFederatedAuthenticators responses: @@ -295,7 +295,7 @@ paths: Metadata about a supported federated authenticator description: > This API provides the details of a single supported federated - authenticator for an identity provider in Asgardeo.
+ authenticator for an identity provider in WSO2 Identity Platform.
Scope required: `internal_org_idp_view` operationId: getMetaFederatedAuthenticator parameters: @@ -346,10 +346,10 @@ paths: tags: - Metadata summary: > - Metadata about supported outbound provisioning connectors by identity providers in Asgardeo + Metadata about supported outbound provisioning connectors by identity providers in WSO2 Identity Platform description: >- This API provides the list of supported federated authenticators for an - IdP in Asgardeo.
+ IdP in WSO2 Identity Platform.
Scope required: `internal_org_idp_view` operationId: getMetaOutboundConnectors responses: @@ -398,7 +398,7 @@ paths: Metadata about supported outbound provisioning connectors description: >- This API provides the details of a single supported outbound - provisioning connector for an IdP in Asgardeo.
+ provisioning connector for an IdP in WSO2 Identity Platform.
Scope required: `internal_org_idp_view` operationId: getMetaOutboundConnector parameters: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders-v2.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders-v2.yaml index 2546575ae7..91d45644e8 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders-v2.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders-v2.yaml @@ -1,8 +1,8 @@ openapi: 3.0.0 info: title: Notification Senders v2 API - description: This document specifies **Email, SMS and Push notification sender RESTful API** for **Asgardeo** organizations. - To access the notification sender organization APIs in Asgardeo, you need to first get an access token from your organization. + description: This document specifies **Email, SMS and Push notification sender RESTful API** for **WSO2 Identity Platform** organizations. + To access the notification sender organization APIs in WSO2 Identity Platform, you need to first get an access token from your organization. version: "v2" servers: - url: https://api.asgardeo.io/t/{root-organization-name}/o/api/server/v2 diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders.yaml index 20a6a6264b..69c02c93a0 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/notification-senders.yaml @@ -1,8 +1,8 @@ openapi: 3.0.0 info: title: Notification Senders API - description: This document specifies **Email, SMS and Push notification sender RESTful API** for **Asgardeo** organizations. - To access the notification sender organization APIs in Asgardeo, you need to first get an access token from your organization. + description: This document specifies **Email, SMS and Push notification sender RESTful API** for **WSO2 Identity Platform** organizations. + To access the notification sender organization APIs in WSO2 Identity Platform, you need to first get an access token from your organization. version: "v1" servers: - url: https://api.asgardeo.io/t/{root-organization-name}/o/api/server/v1 diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/org-application-mgt.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/org-application-mgt.yaml index ec5d835bfc..7b7f2364e3 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/org-application-mgt.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/org-application-mgt.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: description: > - This document explains the RESTful API for application management of organizations in Asgardeo. + This document explains the RESTful API for application management of organizations in WSO2 Identity Platform. version: "v1" - title: Asgardeo - Application Management Rest API + title: WSO2 Identity Platform - Application Management Rest API security: - OAuth2: [] paths: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/org-group-mgt.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/org-group-mgt.yaml index 789e75e1b3..c7fa75d2b5 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/org-group-mgt.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/org-group-mgt.yaml @@ -1,11 +1,11 @@ openapi: 3.0.0 info: version: "v1" - title: Asgardeo - SCIM 2.0 Group Management API + title: WSO2 Identity Platform - SCIM 2.0 Group Management API description: - "This is the RESTful API for SCIM 2.0 Group Management in Asgardeo organizations. + "This is the RESTful API for SCIM 2.0 Group Management in WSO2 Identity Platform organizations. This API allows creating, deleting, listing, and updating users. - \n To access the SCIM 2.0 Group Management APIs in Asgardeo, you need to first get an access token from your organization." + \n To access the SCIM 2.0 Group Management APIs in WSO2 Identity Platform, you need to first get an access token from your organization." security: - OAuth2: [] servers: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml index 7bfceca0aa..2738729794 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml @@ -1,13 +1,13 @@ openapi: 3.0.0 info: version: "v1" - title: 'Asgardeo - Organization Management API Definition' + title: 'WSO2 Identity Platform - Organization Management API Definition' description: | - 'This is the RESTful API for organization management in Asgardeo. This API allows users + 'This is the RESTful API for organization management in WSO2 Identity Platform. This API allows users to create, update, retrieve and delete organizations.

Important:
- You need a paid Asgardeo subscription to create hierarchical organizations. If you don't already have one, view the available [subscription plans](https://wso2.com/asgardeo/pricing/){:target="_blank"} and contact the Asgardeo sales team.' + You need a paid WSO2 Identity Platform subscription to create hierarchical organizations. If you don't already have one, view the available [subscription plans](https://wso2.com/asgardeo/pricing/){:target="_blank"} and contact the WSO2 Identity Platform sales team.' servers: - url: 'https://api.asgardeo.io/t/{organization-name}/o/api/server/v1' variables: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/org-offline-user-onboard.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/org-offline-user-onboard.yaml index 1a9dc39f07..c1b217d401 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/org-offline-user-onboard.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/org-offline-user-onboard.yaml @@ -4,7 +4,7 @@ info: title: Offline User Onboard Management API description: >- This document specifies an **Organization level Offline user onboard management RESTFull API** for - Asgardeo. + WSO2 Identity Platform. paths: '/offline-invite-link': diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/org-user-mgt.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/org-user-mgt.yaml index 0f668aae4d..56261e7bf5 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/org-user-mgt.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/org-user-mgt.yaml @@ -1,11 +1,11 @@ openapi: 3.0.0 info: version: "v1" - title: Asgardeo - SCIM 2.0 User Management API + title: WSO2 Identity Platform - SCIM 2.0 User Management API description: - "This is the RESTful API for SCIM 2.0 User Management in Asgardeo organizations. + "This is the RESTful API for SCIM 2.0 User Management in WSO2 Identity Platform organizations. This API allows creating, deleting, listing, and updating users. - \n To access the SCIM 2.0 User Management APIs in Asgardeo, you need to first get an access token from your organization." + \n To access the SCIM 2.0 User Management APIs in WSO2 Identity Platform, you need to first get an access token from your organization." security: - OAuth2: [] servers: @@ -524,7 +524,7 @@ components: example: Berry userName: type: string - description: By default, the username should be the email address and it will be stored in the `DEFAULT` user store. However, if username validation is changed to `Alphanumeric` in your Asgardeo organization, you need to specify an alphanumeric value (a-z, A-Z, 0-9) as the username instead of the email. + description: By default, the username should be the email address and it will be stored in the `DEFAULT` user store. However, if username validation is changed to `Alphanumeric` in your WSO2 Identity Platform organization, you need to specify an alphanumeric value (a-z, A-Z, 0-9) as the username instead of the email. example: DEFAULT/kim@gmail.com password: type: string @@ -576,7 +576,7 @@ components: example: Berry userName: type: string - description: By default, the username should be the email address and it will be stored in the `DEFAULT` user store. However, if username validation is changed to `Alphanumeric` in your Asgardeo organization, you need to specify an alphanumeric value (a-z, A-Z, 0-9) as the username instead of the email. + description: By default, the username should be the email address and it will be stored in the `DEFAULT` user store. However, if username validation is changed to `Alphanumeric` in your WSO2 Identity Platform organization, you need to specify an alphanumeric value (a-z, A-Z, 0-9) as the username instead of the email. example: DEFAULT/kim@gmail.com emails: type: array diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/org-user-store.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/org-user-store.yaml index 53230cedfe..c424e25721 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/org-user-store.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/org-user-store.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: description: > - This document specifies the **Userstore Management RESTful API** for Asgardeo organizations. + This document specifies the **Userstore Management RESTful API** for WSO2 Identity Platform organizations. version: "v1" - title: Asgardeo - UserStore Management Rest API + title: WSO2 Identity Platform - UserStore Management Rest API security: - OAuth2: [] diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/organization-discovery.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/organization-discovery.yaml index 07e32f1daf..a6a52ca00a 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/organization-discovery.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/organization-discovery.yaml @@ -3,7 +3,7 @@ info: version: "v1" title: 'Organization Discovery API' description: | - This document specifies an **Organization level Organization Discovery RESTful API** for Asgardeo. + This document specifies an **Organization level Organization Discovery RESTful API** for WSO2 Identity Platform. servers: - url: 'https://api.asgardeo.io/t/{organization-name}/o/api/server/v1' variables: diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-invitation.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-invitation.yaml index b3db294df5..0253fb73b1 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-invitation.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-invitation.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: version: "v1" - title: "Asgardeo - Parent Organization's User Invitation API" + title: "WSO2 Identity Platform - Parent Organization's User Invitation API" description: |- - This document specifies an **Parent Organization's User Invitation RESTful API** for **Asgardeo**. This API allows organization administrators to invite users in parent organization, manage the invitations and invitees to accept the invitation. + This document specifies an **Parent Organization's User Invitation RESTful API** for **WSO2 Identity Platform**. This API allows organization administrators to invite users in parent organization, manage the invitations and invitees to accept the invitation. security: - OAuth2: [] diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share-v2.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share-v2.yaml index 0e0ed97419..00b9f5ec9c 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share-v2.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share-v2.yaml @@ -3,7 +3,7 @@ info: version: 1.0.0 title: "User Sharing API (v2)" description: |- - This document defines the **User Sharing REST API (v2)** for organizations in **Asgardeo**. + This document defines the **User Sharing REST API (v2)** for organizations in **WSO2 Identity Platform**. It enables organization administrators to: - Share users across child organizations. - Configure per-organization user role assignments. diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share.yaml index 37803a7d1a..3f7ec89909 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share.yaml @@ -3,7 +3,7 @@ info: version: "v1" title: 'User Sharing API (deprecated)' description: |- - This document defines the **User Sharing REST API for organizations** in **Asgardeo**. This enables organization administrators to share users across child organizations, manage and revoke shared access, and retrieve users' shared organizations and roles. + This document defines the **User Sharing REST API for organizations** in **WSO2 Identity Platform**. This enables organization administrators to share users across child organizations, manage and revoke shared access, and retrieve users' shared organizations and roles. **Shared scopes with Organization User Sharing API v2:** The OAuth2 scopes `internal_org_user_share`, `internal_org_user_unshare`, and `internal_org_user_shared_access_view` are shared between this API (Organization User Sharing v1) and the Organization User Sharing v2 API. Authorizing either API automatically grants access to the equivalent endpoints in the other that use the same scopes. diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/role-management.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/role-management.yaml index fe8601b749..6d97a438ac 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/role-management.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/role-management.yaml @@ -1,8 +1,8 @@ openapi: 3.0.1 info: - title: Asgardeo - SCIM 2.0 Roles V2 API + title: WSO2 Identity Platform - SCIM 2.0 Roles V2 API description: | - This is the RESTful API for SCIM 2.0 Roles API in Asgardeo organizations. + This is the RESTful API for SCIM 2.0 Roles API in WSO2 Identity Platform organizations. This API allows listing roles and updating users and groups of the roles. servers: - url: https://api.asgardeo.io/t/{root-organization-name}/o/scim2/v2 diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/scim-bulk.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/scim-bulk.yaml index e7ee41952a..1b514acf40 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/scim-bulk.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/scim-bulk.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: SCIM 2.0 Bulk API description: | - This document specifies **Organization level SCIM 2.0 Bulk Resource Management RESTful API** for Asgardeo. + This document specifies **Organization level SCIM 2.0 Bulk Resource Management RESTful API** for WSO2 Identity Platform. version: "v1" servers: - url: https://api.asgardeo.io/t/{organization-name}/o/scim2 diff --git a/en/asgardeo/docs/apis/restapis/actions.yaml b/en/asgardeo/docs/apis/restapis/actions.yaml index b4eea16bb4..d5c725dbd3 100644 --- a/en/asgardeo/docs/apis/restapis/actions.yaml +++ b/en/asgardeo/docs/apis/restapis/actions.yaml @@ -1,10 +1,10 @@ openapi: 3.0.0 info: version: v1 - title: Asgardeo - Action Management Rest API + title: WSO2 Identity Platform - Action Management Rest API description: > The Action Management REST API provides a comprehensive interface to manage actions - within the Asgardeo. Actions enable the extension of product functionality + within the WSO2 Identity Platform. Actions enable the extension of product functionality across various workflows, such as access token issuance, password updates, and profile updates. This API helps developers and administrators to define and manage actions to meet specific business needs. diff --git a/en/asgardeo/docs/apis/restapis/admin-identity-verification.yaml b/en/asgardeo/docs/apis/restapis/admin-identity-verification.yaml index 30d5eab44a..e0137ed6aa 100644 --- a/en/asgardeo/docs/apis/restapis/admin-identity-verification.yaml +++ b/en/asgardeo/docs/apis/restapis/admin-identity-verification.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Identity Verification API description: |- - This is the RESTful API for admins to manage users' identity verification information stored in Asgardeo. + This is the RESTful API for admins to manage users' identity verification information stored in WSO2 Identity Platform. servers: - url: 'https://api.asgardeo.io/t/{organization-name}/api/users/v1' security: diff --git a/en/asgardeo/docs/apis/restapis/api-resources.yaml b/en/asgardeo/docs/apis/restapis/api-resources.yaml index 9a0f89f38d..d43090e760 100644 --- a/en/asgardeo/docs/apis/restapis/api-resources.yaml +++ b/en/asgardeo/docs/apis/restapis/api-resources.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: description: > - This document explains the RESTful API for API Resource Management in Asgardeo. + This document explains the RESTful API for API Resource Management in WSO2 Identity Platform. version: "v1" - title: Asgardeo - API Resource Management Rest API + title: WSO2 Identity Platform - API Resource Management Rest API security: - OAuth2: [] diff --git a/en/asgardeo/docs/apis/restapis/app-native-authentication-api.yaml b/en/asgardeo/docs/apis/restapis/app-native-authentication-api.yaml index 3eb8935101..602687b28d 100644 --- a/en/asgardeo/docs/apis/restapis/app-native-authentication-api.yaml +++ b/en/asgardeo/docs/apis/restapis/app-native-authentication-api.yaml @@ -1,12 +1,12 @@ openapi: 3.0.0 info: description: > - This document specifies an **Authentication RESTful API** for **Asgardeo** which can be used to perform a complete API-based user authentication. + This document specifies an **Authentication RESTful API** for **WSO2 Identity Platform** which can be used to perform a complete API-based user authentication. > This API is part of the **App-Native Authentication** capability that can authenticate users within the context of the application without external redirects. Refer to the feature documentation for more information. version: v1 - title: Asgardeo - Application-native Authentication Rest API + title: WSO2 Identity Platform - Application-native Authentication Rest API contact: name: WSO2 url: 'https://wso2.com/products/identity-server/' diff --git a/en/asgardeo/docs/apis/restapis/application-management.yaml b/en/asgardeo/docs/apis/restapis/application-management.yaml index 53382364d0..7f7844a452 100644 --- a/en/asgardeo/docs/apis/restapis/application-management.yaml +++ b/en/asgardeo/docs/apis/restapis/application-management.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: description: > - This document explains the RESTful API for application management in Asgardeo. + This document explains the RESTful API for application management in WSO2 Identity Platform. version: "v1" - title: Asgardeo - Application Management Rest API + title: WSO2 Identity Platform - Application Management Rest API security: - OAuth2: [] paths: @@ -3672,7 +3672,7 @@ components: - password items: type: string - description: "The This will determine how the application communicates with the token service. Asgardeo supports following grant types: + description: "The This will determine how the application communicates with the token service. WSO2 Identity Platform supports following grant types: