Merge branch 'master' into agent-docs-001

Author: shashimalcse

en/asgardeo/docs/apis/organization-apis/org-role-mgt-v3.md

@@ -0,0 +1,5 @@
+---
+template: templates/redoc.html
+---
+
+<redoc spec-url="{{base_path}}/apis/organization-apis/restapis/role-management-v3.yaml" theme='{{redoc_theme}}'></redoc>

en/asgardeo/docs/apis/organization-apis/restapis/association-management-by-admin.yaml

@@ -312,6 +312,85 @@ paths:
             'https://api.asgardeo.io/t/{organization-name}/o/api/users/v1/user-id/federated-associations/federated-association-id' \
             -H 'accept: */*' \
             -H 'Authorization: Bearer <token>'
+  /federated-associations/bulk:
+    post:
+      tags:
+      - admin
+      summary: Create and Delete users associations in bulk
+      description: |
+        This API is used to create and delete users association in bulk. <br>
+        Maximum number of supported operations in a single request is 1000 by default.
+        It can be configured using a server level configuration.
+            <b>Scope required:</b>
+                * internal_user_fed_association_bulk
+      parameters:
+        - name: body
+          in: body
+          required: false
+          schema:
+            $ref: '#/definitions/BulkFederatedAssociationRequest'
+      responses:
+        200:
+          description: Success
+          schema:
+            $ref: '#/definitions/BulkFederatedAssociationResponse'
+        400:
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/Error'
+        401:
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/Error'
+        403:
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/Error'
+        500:
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/Error'
+      x-codeSamples:
+        - lang: Curl
+          source: |
+            curl -X 'POST' \
+              'https://api.asgardeo.io/t/{organization-name}/o/api/users/v1/federated-associations/bulk' \
+              -H 'accept: */*' \
+              -H 'Authorization: Bearer {bearer-token}' \
+              -d '{
+                "failOnErrors": 0,
+                "operations": [
+                  {
+                    "method": "POST",
+                    "bulkId": "qewvaewv",
+                    "path": "/1ca49238-3ab0-474b-9d42-8067780a503c/federated-associations",
+                    "data": {
+                      "idp": "Google",
+                      "federatedUserId": "sam@gmail,com"
+                    }
+                  },
+                  {
+                    "method": "POST",
+                    "bulkId": "fgnruyt",
+                    "path": "/7589bffc-b315-4dbd-83a5-86f5b8aa4776/federated-associations",
+                    "data": {
+                      "idp": "Google",
+                      "federatedUserId": "mike@gmail,com"
+                    }
+                  },
+                  {
+                    "method": "DELETE",
+                    "bulkId": "useffger",
+                    "path": "/0a2d94e2-3b98-49ea-89d6-e8dd9e0ff89b/federated-associations"
+                  },
+                  {
+                    "method": "DELETE",
+                    "bulkId": "eefvrtgnrtn",
+                    "path": "/197fc0fa-c2b0-48e6-92a6-a551afc3d125/federated-associations/0dcc3f5a-3bee-4f36-a91f-8ee60dbae875"
+                  }
+                ]
+              }'
+              
 components:
   schemas:
     Error:
@@ -415,6 +494,91 @@ components:
           type: string
           example: [email protected]
           description: User identifier in the federated IdP
+    BulkFederatedAssociationRequest:
+      type: object
+      properties:
+        failOnErrors:
+          type: integer
+          example: 1
+          description: |
+            This represents whether the API should stop processing the operations if any of them fail. The subsequent
+            operations after the the fail count is reached will not be processed.
+            If set to 0 or not set, the API will continue processing the operations even if some of them fail.
+        operations:
+          type: array
+          items:
+            $ref: '#/definitions/BulkFederatedAssociationOperation'
+
+    BulkFederatedAssociationOperation:
+      type: object
+      required:
+        - method
+        - bulkId
+        - path
+      properties:
+        method:
+          type: string
+          enum:
+            - POST
+            - DELETE
+          example: POST
+          description: |
+            HTTP method to be used for the operation. Supported methods are POST and, DELETE. These values
+            If the method is not specified, the operation will be treated as a bad request.
+        bulkId:
+          type: string
+          example: "ytrewq"
+        path:
+          type: string
+          example: "/b1781d25-bde5-460a-a58a-8fe8dbfd8487/federated-associations"
+          description: |
+            The path to the resource to be operated on. The path should be relative to the base path of the API.
+            Full path for a federated association operation would be
+            `/t/{tenant-domain}/api/users/v1/{user-id}/federated-associations/{association-id}`.
+        data:
+          $ref: '#/definitions/UserFederatedAssociationData'
+
+    UserFederatedAssociationData:
+      type: object
+      properties:
+        idp:
+          type: string
+          example: "exampleIdP"
+          description: Name of the IdP
+        federatedUserId:
+          type: string
+          example: "[email protected]"
+          description: User identifier in the federated IdP
+
+    BulkFederatedAssociationResponse:
+      type: object
+      properties:
+        Operations:
+          type: array
+          items:
+            $ref: '#/definitions/BulkAssociationOperationResponse'
+
+    BulkAssociationOperationResponse:
+      type: object
+      properties:
+        bulkId:
+          type: string
+          example: "qwerty"
+        status:
+          type: object
+          properties:
+            statusCode:
+              type: integer
+              example: "400"
+            errorCode:
+              type: string
+              example: "UAA-10012"
+            errorMessage:
+              type: string
+              example: "Error while adding federated user association: 1890c6c0-d1a0-4eb4-8075-320756d75946"
+            errorDescription:
+              type: string
+              example: "The federated association is already associated to a local user"
   securitySchemes:
     OAuth2:
       type: oauth2

en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml

@@ -780,6 +780,7 @@ components:
         - name
         - orgHandle
         - status
+        - version
         - ref
       properties:
         id:
@@ -795,6 +796,9 @@ components:
           type: string
           enum: [ ACTIVE, DISABLED ]
           example: ACTIVE
+        version:
+          type: string
+          example: 'v1.0.0'
         hasChildren:
           type: boolean
           example: false
@@ -812,6 +816,7 @@ components:
         - name
         - orgHandle
         - status
+        - version
         - created
         - lastModified
         - type
@@ -832,6 +837,9 @@ components:
           type: string
           enum: [ACTIVE, DISABLED]
           example: ACTIVE
+        version:
+          type: string
+          example: 'v1.0.0'
         created:
           type: string
           example: '2021-10-25T12:31:53.406Z'
@@ -859,6 +867,7 @@ components:
         - name
         - orgHandle
         - status
+        - version
         - created
         - lastModified
         - type
@@ -879,6 +888,9 @@ components:
           type: string
           enum: [ACTIVE, DISABLED]
           example: ACTIVE
+        version:
+          type: string
+          example: 'v1.0.0'
         created:
           type: string
           example: '2021-10-25T12:31:53.406Z'
@@ -1019,6 +1031,7 @@ components:
         - name
         - orgHandle
         - status
+        - version
         - created
         - lastModified
         - type
@@ -1039,6 +1052,9 @@ components:
           type: string
           enum: [ACTIVE, DISABLED]
           example: ACTIVE
+        version:
+          type: string
+          example: 'v1.0.0'
         created:
           type: string
           example: '2021-10-25T12:31:53.406Z'