Skip to content

Latest commit

 

History

History
161 lines (102 loc) · 4.53 KB

ResourceActionManagementApi.md

File metadata and controls

161 lines (102 loc) · 4.53 KB

ResourceActionManagementApi

All URIs are relative to https://sandbox-iam.us.hypto.com/v1

Method HTTP request Description
createAction POST /organizations/{organization_id}/resources/{resource_name}/actions Create an action
deleteAction DELETE /organizations/{organization_id}/resources/{resource_name}/actions/{action_name} Delete an action
getAction GET /organizations/{organization_id}/resources/{resource_name}/actions/{action_name} Get an action
listActions GET /organizations/{organization_id}/resources/{resource_name}/actions List actions
updateAction PATCH /organizations/{organization_id}/resources/{resource_name}/actions/{action_name} Update an action

createAction

Action createAction(organization_id, resource_name, CreateActionRequest)

Create an action

Create an action

Parameters

Name Type Description Notes
organization_id String [default to null]
resource_name String [default to null]
CreateActionRequest CreateActionRequest Payload to create action

Return type

Action

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteAction

BaseSuccessResponse deleteAction(organization_id, resource_name, action_name)

Delete an action

Delete an action

Parameters

Name Type Description Notes
organization_id String [default to null]
resource_name String [default to null]
action_name String [default to null]

Return type

BaseSuccessResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAction

Action getAction(organization_id, resource_name, action_name)

Get an action

Get an action

Parameters

Name Type Description Notes
organization_id String [default to null]
resource_name String [default to null]
action_name String [default to null]

Return type

Action

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listActions

ActionPaginatedResponse listActions(organization_id, resource_name, nextToken, pageSize, sortOrder)

List actions

List actions

Parameters

Name Type Description Notes
organization_id String [default to null]
resource_name String [default to null]
nextToken String [optional] [default to null]
pageSize String [optional] [default to null]
sortOrder String [optional] [default to null] [enum: asc, desc]

Return type

ActionPaginatedResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateAction

Action updateAction(organization_id, resource_name, action_name, UpdateActionRequest)

Update an action

Update an action

Parameters

Name Type Description Notes
organization_id String [default to null]
resource_name String [default to null]
action_name String [default to null]
UpdateActionRequest UpdateActionRequest Payload to update action

Return type

Action

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json