add scope for apis

Author: Thumimku

en/asgardeo/docs/apis/restapis/oauth-dcr.yaml

@@ -15,7 +15,9 @@ paths:
       - OAuth2 DCR
       summary: |
         Get application by name
-      description: "This API is used to get/retrieve an OAuth2 application by `client_name`. \n\n <b>Scope required:</b> `internal_dcr_view`."
+      description: |
+        "This API is used to get/retrieve an OAuth2 application by `client_name`. \n\n <b>Scope required:</b> `internal_dcr_view`."
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplicationByName
       parameters:
       - name: client_name
@@ -59,6 +61,7 @@ paths:
         \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_dcr_create`."
+        <b>Scope(Permission) required:</b> `internal_dcr_create`
       operationId: registerApplication
       requestBody:
         description: Application information to register.
@@ -135,7 +138,9 @@ paths:
       - OAuth2 DCR
       summary: |
         Get application by ID  
-      description: "This API is used to retrieve an OAuth2 application by `client_id`. \n\n <b>Scope required:</b> `internal_dcr_view`."
+      description: |
+        "This API is used to retrieve an OAuth2 application by `client_id`. \n\n <b>Scope required:</b> `internal_dcr_view`."
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplication
       parameters:
       - name: client_id
@@ -175,7 +180,9 @@ paths:
       - OAuth2 DCR
       summary: |
         Update an OAuth2 app
-      description: "This API is used to update an OAuth2 application.\n\n <b>Scope required:</b> `internal_dcr_update`."
+      description: |
+        "This API is used to update an OAuth2 application.\n\n <b>Scope required:</b> `internal_dcr_update`."
+        <b>Scope(Permission) required:</b> `internal_dcr_update`
       operationId: updateApplication
       parameters:
       - name: client_id
@@ -244,7 +251,9 @@ paths:
       - OAuth2 DCR
       summary: |
         Delete an OAuth2 app
-      description: "This API is used to delete an OAuth2 application by `client_id`.\n\n <b>Scope required:</b> `internal_dcr_delete`."
+      description: |
+        "This API is used to delete an OAuth2 application by `client_id`.\n\n <b>Scope required:</b> `internal_dcr_delete`."
+        <b>Scope(Permission) required:</b> `internal_dcr_delete`
       operationId: deleteApplication
       parameters:
       - name: client_id

en/identity-server/7.0.0/docs/apis/restapis/oauth-dcr.yaml

@@ -21,6 +21,7 @@ paths:
         Get OAuth2 application information
       description: |
         This API is used to get/retrieve an OAuth2 application by client_name.
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplicationByName
       parameters:
       - name: client_name
@@ -76,6 +77,7 @@ paths:
         \ If you are using any other grant type, \nsuch as password, you don't need\
         \ to send the redirect_uri field in the request. Check the sample request\
         \ given below.\n"
+        <b>Scope(Permission) required:</b> `internal_dcr_create`
       operationId: registerApplication
       requestBody:
         description: Application information to register.
@@ -168,6 +170,7 @@ paths:
         Get OAuth2 application information
       description: |
         This API is used to get/retrieve an OAuth2 application by client_id.
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplication
       parameters:
       - name: client_id
@@ -219,6 +222,7 @@ paths:
         Updates an OAuth2 application
       description: |
         This API is used to update an OAuth2 application.
+        <b>Scope(Permission) required:</b> `internal_dcr_update`
       operationId: updateApplication
       parameters:
       - name: client_id
@@ -303,6 +307,7 @@ paths:
         Delete OAuth2 application
       description: |
         This API is used to delete an OAuth2 application by client_id.
+        <b>Scope(Permission) required:</b> `internal_dcr_delete`
       operationId: deleteApplication
       parameters:
       - name: client_id

en/identity-server/7.0.0/docs/apis/restapis/oauth2-scope-endpoint.yaml

@@ -19,6 +19,7 @@ paths:
         Return all available scopes
       description: |
         This API is used to get all the available scopes.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_view`
       operationId: getScopes
       parameters:
       - name: startIndex
@@ -85,6 +86,7 @@ paths:
         Register a scope
       description: |
         This API is used to create a scope.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_create`
       operationId: registerScope
       requestBody:
         description: Define a scope with bindings to register it
@@ -161,6 +163,7 @@ paths:
         Return a scope by name
       description: |
         This API is used to retrieve details of a scope by a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_view`
       operationId: getScope
       parameters:
       - name: name
@@ -211,6 +214,7 @@ paths:
         Update a scope
       description: |
         This API is used to update a scope by a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_update`
       operationId: updateScope
       parameters:
       - name: name
@@ -286,6 +290,7 @@ paths:
         Delete a scope
       description: |
         This API is used to delete a scope by a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_delete`
       operationId: deleteScope
       parameters:
       - name: name
@@ -337,6 +342,7 @@ paths:
         Check scope existence using scope name
       description: |
         This API is used to check a scope's existence using a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_view`
       operationId: isScopeExists
       parameters:
       - name: name

en/identity-server/7.0.0/docs/apis/restapis/oidc-scope-management.yaml

@@ -25,7 +25,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Retrieve the list of scopes
       operationId: getScopes
-      description: This REST API can be used to get details of the available scopes.
+      description: |
+        This REST API can be used to get details of the available scopes.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_view`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -59,6 +61,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Add a new OIDC scope
       operationId: addScope
+      description: |
+        This REST API can be used to create OIDC scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_create`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -102,7 +107,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Get a scope
       operationId: getScope
-      description: This REST API can be used to get the scope.
+      description: |
+        This REST API can be used to get the scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_view`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -140,6 +147,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Update an OIDC scope
       operationId: updateScope
+      description: |
+        This REST API can be used to update OIDC scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_update`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -190,6 +200,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Delete an OIDC scope
       operationId: deleteScope
+      description: |
+        This REST API can be used to delete OIDC scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_delete`
       security:
         - BasicAuth: []
         - OAuth2: []

en/identity-server/7.1.0/docs/apis/restapis/oauth-dcr.yaml

@@ -21,6 +21,7 @@ paths:
         Get OAuth2 application information
       description: |
         This API is used to get/retrieve an OAuth2 application by client_name.
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplicationByName
       parameters:
       - name: client_name
@@ -76,6 +77,7 @@ paths:
         \ If you are using any other grant type, \nsuch as password, you don't need\
         \ to send the redirect_uri field in the request. Check the sample request\
         \ given below.\n"
+        <b>Scope(Permission) required:</b> `internal_dcr_create`
       operationId: registerApplication
       requestBody:
         description: Application information to register.
@@ -168,6 +170,7 @@ paths:
         Get OAuth2 application information
       description: |
         This API is used to get/retrieve an OAuth2 application by client_id.
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplication
       parameters:
       - name: client_id
@@ -219,6 +222,7 @@ paths:
         Updates an OAuth2 application
       description: |
         This API is used to update an OAuth2 application.
+        <b>Scope(Permission) required:</b> `internal_dcr_update`
       operationId: updateApplication
       parameters:
       - name: client_id
@@ -303,6 +307,7 @@ paths:
         Delete OAuth2 application
       description: |
         This API is used to delete an OAuth2 application by client_id.
+        <b>Scope(Permission) required:</b> `internal_dcr_delete`
       operationId: deleteApplication
       parameters:
       - name: client_id

en/identity-server/7.1.0/docs/apis/restapis/oauth2-scope-endpoint.yaml

@@ -19,6 +19,7 @@ paths:
         Return all available scopes
       description: |
         This API is used to get all the available scopes.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_view`
       operationId: getScopes
       parameters:
       - name: startIndex
@@ -85,6 +86,7 @@ paths:
         Register a scope
       description: |
         This API is used to create a scope.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_create`
       operationId: registerScope
       requestBody:
         description: Define a scope with bindings to register it
@@ -161,6 +163,7 @@ paths:
         Return a scope by name
       description: |
         This API is used to retrieve details of a scope by a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_view`
       operationId: getScope
       parameters:
       - name: name
@@ -211,6 +214,7 @@ paths:
         Update a scope
       description: |
         This API is used to update a scope by a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_update`
       operationId: updateScope
       parameters:
       - name: name
@@ -286,6 +290,7 @@ paths:
         Delete a scope
       description: |
         This API is used to delete a scope by a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_delete`
       operationId: deleteScope
       parameters:
       - name: name
@@ -337,6 +342,7 @@ paths:
         Check scope existence using scope name
       description: |
         This API is used to check a scope's existence using a given scope name.
+        <b>Scope(Permission) required:</b> `internal_oauth_scope_view`
       operationId: isScopeExists
       parameters:
       - name: name

en/identity-server/7.1.0/docs/apis/restapis/oidc-scope-management.yaml

@@ -25,7 +25,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Retrieve the list of scopes
       operationId: getScopes
-      description: This REST API can be used to get details of the available scopes.
+      description: |
+        This REST API can be used to get details of the available scopes.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_view`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -59,6 +61,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Add a new OIDC scope
       operationId: addScope
+      description: |
+        This REST API can be used to create OIDC scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_create`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -102,7 +107,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Get a scope
       operationId: getScope
-      description: This REST API can be used to get the scope.
+      description: |
+        This REST API can be used to get the scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_view`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -140,6 +147,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Update an OIDC scope
       operationId: updateScope
+      description: |
+        This REST API can be used to update OIDC scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_update`
       security:
         - BasicAuth: []
         - OAuth2: []
@@ -190,6 +200,9 @@ paths:
         - OIDC Scope Endpoint
       summary: Delete an OIDC scope
       operationId: deleteScope
+      description: |
+        This REST API can be used to delete OIDC scope.
+        <b>Scope(Permission) required:</b> `internal_oidc_scope_mgt_delete`
       security:
         - BasicAuth: []
         - OAuth2: []

en/identity-server/next/docs/apis/restapis/oauth-dcr.yaml

@@ -21,6 +21,7 @@ paths:
         Get OAuth2 application information
       description: |
         This API is used to get/retrieve an OAuth2 application by client_name.
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplicationByName
       parameters:
       - name: client_name
@@ -76,6 +77,7 @@ paths:
         \ If you are using any other grant type, \nsuch as password, you don't need\
         \ to send the redirect_uri field in the request. Check the sample request\
         \ given below.\n"
+        <b>Scope(Permission) required:</b> `internal_dcr_create`
       operationId: registerApplication
       requestBody:
         description: Application information to register.
@@ -168,6 +170,7 @@ paths:
         Get OAuth2 application information
       description: |
         This API is used to get/retrieve an OAuth2 application by client_id.
+        <b>Scope(Permission) required:</b> `internal_dcr_view`
       operationId: getApplication
       parameters:
       - name: client_id
@@ -219,6 +222,7 @@ paths:
         Updates an OAuth2 application
       description: |
         This API is used to update an OAuth2 application.
+        <b>Scope(Permission) required:</b> `internal_dcr_update`
       operationId: updateApplication
       parameters:
       - name: client_id
@@ -303,6 +307,7 @@ paths:
         Delete OAuth2 application
       description: |
         This API is used to delete an OAuth2 application by client_id.
+        <b>Scope(Permission) required:</b> `internal_dcr_delete`
       operationId: deleteApplication
       parameters:
       - name: client_id