Skip to content

Commit f8c4159

Browse files
authored
Merge pull request #5654 from BimsaraBodaragama/commitership/docs-is
[Improvements] docs-is
2 parents 3fade32 + 25b6e55 commit f8c4159

File tree

8 files changed

+52
-52
lines changed

8 files changed

+52
-52
lines changed

en/asgardeo/docs/apis/organization-apis/restapis/organization-user-share.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: "v1"
44
title: 'User Sharing API Definition'
55
description: |-
6-
This document specifies the **User Sharing RESTful API of Organizations** for **Asgardeo**. This API enables organization administrators to share user access across child organizations, manage shared access, revoke access, and retrieve shared organizations and roles.
6+
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.
77
88
security:
99
- OAuth2: []
@@ -328,7 +328,7 @@ paths:
328328
get:
329329
tags:
330330
- User Accessible Organizations
331-
summary: Get organizations a user has access to
331+
summary: Get the list of organizations accessible by the user
332332
description: |
333333
This API retrieves the list of organizations where the specified user has shared access.
334334
@@ -339,12 +339,12 @@ paths:
339339
required: true
340340
schema:
341341
type: string
342-
description: The ID of the user whose accessible organizations are being retrieved.
342+
description: The ID of the user.
343343
- in: query
344344
name: after
345345
schema:
346346
type: string
347-
description: The cursor pointing to the item after which the next page of results should be returned.
347+
description: The cursor indicating the item after which the next page of results will begin.
348348
- in: query
349349
name: before
350350
schema:
@@ -420,7 +420,7 @@ paths:
420420
name: after
421421
schema:
422422
type: string
423-
description: The cursor pointing to the item after which the next page of results should be returned.
423+
description: The cursor indicating the item after which the next page of results will begin.
424424
- in: query
425425
name: before
426426
schema:

en/asgardeo/docs/apis/restapis/organization-user-share.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: "v1"
44
title: 'User Sharing API Definition'
55
description: |-
6-
This document specifies the **User Sharing RESTful API** for **Asgardeo**. This API enables organization administrators to share user access across child organizations, manage shared access, revoke access, and retrieve shared organizations and roles.
6+
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.
77
88
security:
99
- OAuth2: []
@@ -329,7 +329,7 @@ paths:
329329
get:
330330
tags:
331331
- User Accessible Organizations
332-
summary: Get organizations a user has access to
332+
summary: Get the list of organizations accessible by the user
333333
description: |
334334
This API retrieves the list of organizations where the specified user has shared access.
335335
@@ -340,12 +340,12 @@ paths:
340340
required: true
341341
schema:
342342
type: string
343-
description: The ID of the user whose accessible organizations are being retrieved.
343+
description: The ID of the user.
344344
- in: query
345345
name: after
346346
schema:
347347
type: string
348-
description: The cursor pointing to the item after which the next page of results should be returned.
348+
description: The cursor indicating the item after which the next page of results will begin.
349349
- in: query
350350
name: before
351351
schema:
@@ -421,7 +421,7 @@ paths:
421421
name: after
422422
schema:
423423
type: string
424-
description: The cursor pointing to the item after which the next page of results should be returned.
424+
description: The cursor indicating the item after which the next page of results will begin.
425425
- in: query
426426
name: before
427427
schema:

en/identity-server/7.1.0/docs/apis/organization-apis/restapis/organization-user-share.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: "v1"
44
title: 'User Sharing API Definition'
55
description: |-
6-
This document specifies the **User Sharing RESTful API of Organizations** for **WSO2 Identity Server**. This API enables organization administrators to share user access across child organizations, manage shared access, revoke access, and retrieve shared organizations and roles.
6+
This document defines the **User Sharing REST API for organizations** in **WSO2 Identity Server**. This enables organization administrators to share users across child organizations, manage and revoke shared access, and retrieve users' shared organizations and roles.
77
88
security:
99
- OAuth2: []
@@ -329,7 +329,7 @@ paths:
329329
get:
330330
tags:
331331
- User Accessible Organizations
332-
summary: Get organizations a user has access to
332+
summary: Get the list of organizations accessible by the user
333333
description: |
334334
This API retrieves the list of organizations where the specified user has shared access.
335335
@@ -340,12 +340,12 @@ paths:
340340
required: true
341341
schema:
342342
type: string
343-
description: The ID of the user whose accessible organizations are being retrieved.
343+
description: The ID of the user.
344344
- in: query
345345
name: after
346346
schema:
347347
type: string
348-
description: The cursor pointing to the item after which the next page of results should be returned.
348+
description: The cursor indicating the item after which the next page of results will begin.
349349
- in: query
350350
name: before
351351
schema:
@@ -421,7 +421,7 @@ paths:
421421
name: after
422422
schema:
423423
type: string
424-
description: The cursor pointing to the item after which the next page of results should be returned.
424+
description: The cursor indicating the item after which the next page of results will begin.
425425
- in: query
426426
name: before
427427
schema:

en/identity-server/7.1.0/docs/apis/restapis/organization-user-share.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: "v1"
44
title: 'User Sharing API Definition'
55
description: |-
6-
This document specifies the **User Sharing RESTful API** for **WSO2 Identity Server**. This API enables organization administrators to share user access across child organizations, manage shared access, revoke access, and retrieve shared organizations and roles.
6+
This document defines the **User Sharing REST API for organizations** in **WSO2 Identity Server**. This enables organization administrators to share users across child organizations, manage and revoke shared access, and retrieve users' shared organizations and roles.
77
88
security:
99
- OAuth2: []
@@ -75,7 +75,7 @@ paths:
7575
x-codeSamples:
7676
- lang: Curl
7777
source: |
78-
curl --location 'https://localhost:9443/api/server/v1/users/share' \
78+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/share' \
7979
-H 'Accept: application/json' \
8080
-H 'Content-Type: application/json' \
8181
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -166,7 +166,7 @@ paths:
166166
x-codeSamples:
167167
- lang: Curl
168168
source: |
169-
curl --location 'https://localhost:9443/api/server/v1/users/share-with-all' \
169+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/share-with-all' \
170170
-H 'Accept: application/json' \
171171
-H 'Content-Type: application/json' \
172172
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -250,7 +250,7 @@ paths:
250250
x-codeSamples:
251251
- lang: Curl
252252
source: |
253-
curl --location 'https://localhost:9443/api/server/v1/users/unshare' \
253+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/unshare' \
254254
-H 'Accept: application/json' \
255255
-H 'Content-Type: application/json' \
256256
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -312,7 +312,7 @@ paths:
312312
x-codeSamples:
313313
- lang: Curl
314314
source: |
315-
curl --location 'https://localhost:9443/api/server/v1/users/unshare-with-all' \
315+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/unshare-with-all' \
316316
-H 'Accept: application/json' \
317317
-H 'Content-Type: application/json' \
318318
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -330,7 +330,7 @@ paths:
330330
get:
331331
tags:
332332
- User Accessible Organizations
333-
summary: Get organizations a user has access to
333+
summary: Get the list of organizations accessible by the user
334334
description: |
335335
This API retrieves the list of organizations where the specified user has shared access.
336336
@@ -341,12 +341,12 @@ paths:
341341
required: true
342342
schema:
343343
type: string
344-
description: The ID of the user whose accessible organizations are being retrieved.
344+
description: The ID of the user.
345345
- in: query
346346
name: after
347347
schema:
348348
type: string
349-
description: The cursor pointing to the item after which the next page of results should be returned.
349+
description: The cursor indicating the item after which the next page of results will begin.
350350
- in: query
351351
name: before
352352
schema:
@@ -422,7 +422,7 @@ paths:
422422
name: after
423423
schema:
424424
type: string
425-
description: The cursor pointing to the item after which the next page of results should be returned.
425+
description: The cursor indicating the item after which the next page of results will begin.
426426
- in: query
427427
name: before
428428
schema:

en/identity-server/7.2.0/docs/apis/organization-apis/restapis/organization-user-share.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: "v1"
44
title: 'User Sharing API Definition'
55
description: |-
6-
This document specifies the **User Sharing RESTful API of Organizations** for **WSO2 Identity Server**. This API enables organization administrators to share user access across child organizations, manage shared access, revoke access, and retrieve shared organizations and roles.
6+
This document defines the **User Sharing REST API for organizations** in **WSO2 Identity Server**. This enables organization administrators to share users across child organizations, manage and revoke shared access, and retrieve users' shared organizations and roles.
77
88
security:
99
- OAuth2: []
@@ -329,7 +329,7 @@ paths:
329329
get:
330330
tags:
331331
- User Accessible Organizations
332-
summary: Get organizations a user has access to
332+
summary: Get the list of organizations accessible by the user
333333
description: |
334334
This API retrieves the list of organizations where the specified user has shared access.
335335
@@ -340,12 +340,12 @@ paths:
340340
required: true
341341
schema:
342342
type: string
343-
description: The ID of the user whose accessible organizations are being retrieved.
343+
description: The ID of the user.
344344
- in: query
345345
name: after
346346
schema:
347347
type: string
348-
description: The cursor pointing to the item after which the next page of results should be returned.
348+
description: The cursor indicating the item after which the next page of results will begin.
349349
- in: query
350350
name: before
351351
schema:
@@ -421,7 +421,7 @@ paths:
421421
name: after
422422
schema:
423423
type: string
424-
description: The cursor pointing to the item after which the next page of results should be returned.
424+
description: The cursor indicating the item after which the next page of results will begin.
425425
- in: query
426426
name: before
427427
schema:

en/identity-server/7.2.0/docs/apis/restapis/organization-user-share.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: "v1"
44
title: 'User Sharing API Definition'
55
description: |-
6-
This document specifies the **User Sharing RESTful API** for **WSO2 Identity Server**. This API enables organization administrators to share user access across child organizations, manage shared access, revoke access, and retrieve shared organizations and roles.
6+
This document defines the **User Sharing REST API for organizations** in **WSO2 Identity Server**. This enables organization administrators to share users across child organizations, manage and revoke shared access, and retrieve users' shared organizations and roles.
77
88
security:
99
- OAuth2: []
@@ -75,7 +75,7 @@ paths:
7575
x-codeSamples:
7676
- lang: Curl
7777
source: |
78-
curl --location 'https://localhost:9443/api/server/v1/users/share' \
78+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/share' \
7979
-H 'Accept: application/json' \
8080
-H 'Content-Type: application/json' \
8181
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -166,7 +166,7 @@ paths:
166166
x-codeSamples:
167167
- lang: Curl
168168
source: |
169-
curl --location 'https://localhost:9443/api/server/v1/users/share-with-all' \
169+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/share-with-all' \
170170
-H 'Accept: application/json' \
171171
-H 'Content-Type: application/json' \
172172
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -250,7 +250,7 @@ paths:
250250
x-codeSamples:
251251
- lang: Curl
252252
source: |
253-
curl --location 'https://localhost:9443/api/server/v1/users/unshare' \
253+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/unshare' \
254254
-H 'Accept: application/json' \
255255
-H 'Content-Type: application/json' \
256256
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -312,7 +312,7 @@ paths:
312312
x-codeSamples:
313313
- lang: Curl
314314
source: |
315-
curl --location 'https://localhost:9443/api/server/v1/users/unshare-with-all' \
315+
curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/users/unshare-with-all' \
316316
-H 'Accept: application/json' \
317317
-H 'Content-Type: application/json' \
318318
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -330,7 +330,7 @@ paths:
330330
get:
331331
tags:
332332
- User Accessible Organizations
333-
summary: Get organizations a user has access to
333+
summary: Get the list of organizations accessible by the user
334334
description: |
335335
This API retrieves the list of organizations where the specified user has shared access.
336336
@@ -341,12 +341,12 @@ paths:
341341
required: true
342342
schema:
343343
type: string
344-
description: The ID of the user whose accessible organizations are being retrieved.
344+
description: The ID of the user.
345345
- in: query
346346
name: after
347347
schema:
348348
type: string
349-
description: The cursor pointing to the item after which the next page of results should be returned.
349+
description: The cursor indicating the item after which the next page of results will begin.
350350
- in: query
351351
name: before
352352
schema:
@@ -422,7 +422,7 @@ paths:
422422
name: after
423423
schema:
424424
type: string
425-
description: The cursor pointing to the item after which the next page of results should be returned.
425+
description: The cursor indicating the item after which the next page of results will begin.
426426
- in: query
427427
name: before
428428
schema:

en/identity-server/next/docs/apis/organization-apis/restapis/organization-user-share.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: "v1"
44
title: 'User Sharing API Definition'
55
description: |-
6-
This document specifies the **User Sharing RESTful API of Organizations** for **WSO2 Identity Server**. This API enables organization administrators to share user access across child organizations, manage shared access, revoke access, and retrieve shared organizations and roles.
6+
This document defines the **User Sharing REST API for organizations** in **WSO2 Identity Server**. This enables organization administrators to share users across child organizations, manage and revoke shared access, and retrieve users' shared organizations and roles.
77
88
security:
99
- OAuth2: []
@@ -329,7 +329,7 @@ paths:
329329
get:
330330
tags:
331331
- User Accessible Organizations
332-
summary: Get organizations a user has access to
332+
summary: Get the list of organizations accessible by the user
333333
description: |
334334
This API retrieves the list of organizations where the specified user has shared access.
335335
@@ -340,12 +340,12 @@ paths:
340340
required: true
341341
schema:
342342
type: string
343-
description: The ID of the user whose accessible organizations are being retrieved.
343+
description: The ID of the user.
344344
- in: query
345345
name: after
346346
schema:
347347
type: string
348-
description: The cursor pointing to the item after which the next page of results should be returned.
348+
description: The cursor indicating the item after which the next page of results will begin.
349349
- in: query
350350
name: before
351351
schema:
@@ -421,7 +421,7 @@ paths:
421421
name: after
422422
schema:
423423
type: string
424-
description: The cursor pointing to the item after which the next page of results should be returned.
424+
description: The cursor indicating the item after which the next page of results will begin.
425425
- in: query
426426
name: before
427427
schema:

0 commit comments

Comments
 (0)