Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the action management APIs with new action retrieval by action id API. #4737

Merged
merged 3 commits into from
Sep 6, 2024
Merged

Update the action management APIs with new action retrieval by action id API. #4737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec079ce
Update asgardeo actions api doc to add get action by id
ashanthamara Sep 5, 2024
d256b2f
Update is-next actions api doc to add get action by id
ashanthamara Sep 5, 2024
738d8ec
Merge remote-tracking branch 'upstream/master' into actions
ashanthamara Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions en/asgardeo/docs/apis/restapis/actions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -148,13 +154,81 @@ 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: |
curl --location 'https://api.asgardeo.io/t/{organization-name}/api/server/v1/actions/{actionType}' \
-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
<b>Scope (Permission) required:</b> ``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
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down
104 changes: 104 additions & 0 deletions en/identity-server/next/docs/apis/restapis/actions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -153,13 +159,81 @@ 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: |
curl --location 'https://localhost:9443/api/server/v1/actions/{actionType}' \
-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
<b>Scope (Permission) required:</b> ``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
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down Expand Up @@ -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: |
Expand Down