From ec079ceef314f4a8a6ca6ccd536cd93cf6146d9e Mon Sep 17 00:00:00 2001 From: Ashan Thamara Palihakkara <75057725+ashanthamara@users.noreply.github.com> Date: Fri, 6 Sep 2024 02:08:54 +0530 Subject: [PATCH 1/2] Update asgardeo actions api doc to add get action by id --- en/asgardeo/docs/apis/restapis/actions.yaml | 104 ++++++++++++++++++++ 1 file changed, 104 insertions(+) diff --git a/en/asgardeo/docs/apis/restapis/actions.yaml b/en/asgardeo/docs/apis/restapis/actions.yaml index 76dc7d02d0..0bf97f5c92 100644 --- a/en/asgardeo/docs/apis/restapis/actions.yaml +++ b/en/asgardeo/docs/apis/restapis/actions.yaml @@ -88,6 +88,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -148,6 +154,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -155,6 +167,68 @@ paths: -H 'Authorization: Bearer {bearer_token}' /actions/{actionType}/{actionId}: + get: + tags: + - Actions Endpoint + operationId: getActionByActionId + summary: Retrieve Action by ID + description: "This API provides the capability to retrieve the action by action Id. \n\n + Scope (Permission) required: ``internal_action_mgt_view``\n\n" + parameters: + - name: actionType + in: path + description: Name of the Action Type. + required: true + schema: + enum: + - preIssueAccessToken + - name: actionId + in: path + description: Unique identifier of the action. + required: true + schema: + type: string + responses: + '200': + description: Action is found for the given action type and id. + content: + application/json: + schema: + $ref: '#/components/schemas/ActionResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location 'https://api.asgardeo.io/t/{organization-name}/api/server/v1/actions/{actionType}/{actionId}' \ + -H 'Authorization: Bearer {bearer_token}' + patch: tags: - Actions Endpoint @@ -212,6 +286,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -282,6 +362,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -339,6 +425,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -396,6 +488,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -470,6 +568,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl(Bearer) source: | From d256b2f2cece4178fa5d4760378eb4fe778905e9 Mon Sep 17 00:00:00 2001 From: Ashan Thamara Palihakkara <75057725+ashanthamara@users.noreply.github.com> Date: Fri, 6 Sep 2024 02:18:42 +0530 Subject: [PATCH 2/2] Update is-next actions api doc to add get action by id --- .../next/docs/apis/restapis/actions.yaml | 104 ++++++++++++++++++ 1 file changed, 104 insertions(+) diff --git a/en/identity-server/next/docs/apis/restapis/actions.yaml b/en/identity-server/next/docs/apis/restapis/actions.yaml index 6ce9f6f03c..f03b99d6fa 100644 --- a/en/identity-server/next/docs/apis/restapis/actions.yaml +++ b/en/identity-server/next/docs/apis/restapis/actions.yaml @@ -93,6 +93,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -153,6 +159,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -160,6 +172,68 @@ paths: -H 'Authorization: Basic YWRtaW46YWRtaW4=' /actions/{actionType}/{actionId}: + get: + tags: + - Actions Endpoint + operationId: getActionByActionId + summary: Retrieve Action by ID + description: "This API provides the capability to retrieve the action by action Id. \n\n + Scope (Permission) required: ``internal_action_mgt_view``\n\n" + parameters: + - name: actionType + in: path + description: Name of the Action Type. + required: true + schema: + enum: + - preIssueAccessToken + - name: actionId + in: path + description: Unique identifier of the action. + required: true + schema: + type: string + responses: + '200': + description: Action is found for the given action type and id. + content: + application/json: + schema: + $ref: '#/components/schemas/ActionResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location 'https://localhost:9443/api/server/v1/actions/{actionType}/{actionId}' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' + patch: tags: - Actions Endpoint @@ -217,6 +291,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -287,6 +367,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -344,6 +430,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -401,6 +493,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl source: | @@ -475,6 +573,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' x-codeSamples: - lang: Curl(Bearer) source: |