Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
>
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions en/asgardeo/docs/apis/index.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions en/asgardeo/docs/apis/organization-apis/index.md
Original file line number Diff line number Diff line change
@@ -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/)

Expand All @@ -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/).
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions en/asgardeo/docs/apis/organization-apis/restapis/actions.yaml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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: []
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
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: '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'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
14 changes: 7 additions & 7 deletions en/asgardeo/docs/apis/organization-apis/restapis/idp.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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. <br>
This API provides the list of supported federated authenticators for an identity provider in WSO2 Identity Platform. <br>
<b>Scope required:</b> `internal_org_idp_view`
operationId: getMetaFederatedAuthenticators
responses:
Expand Down Expand Up @@ -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. <br>
authenticator for an identity provider in WSO2 Identity Platform. <br>
<b>Scope required:</b> `internal_org_idp_view`
operationId: getMetaFederatedAuthenticator
parameters:
Expand Down Expand Up @@ -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. <br>
IdP in WSO2 Identity Platform. <br>
<b>Scope required:</b> `internal_org_idp_view`
operationId: getMetaOutboundConnectors
responses:
Expand Down Expand Up @@ -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. <br>
provisioning connector for an IdP in WSO2 Identity Platform. <br>
<b>Scope required:</b> `internal_org_idp_view`
operationId: getMetaOutboundConnector
parameters:
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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. <br><br>

<b>Important</b>:<br>
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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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':
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading