Skip to content

Latest commit

 

History

History
156 lines (97 loc) · 4.7 KB

ResourceManagementApi.md

File metadata and controls

156 lines (97 loc) · 4.7 KB

ResourceManagementApi

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

Method HTTP request Description
createResource POST /organizations/{organization_id}/resources Create a resource name in an organization.
deleteResource DELETE /organizations/{organization_id}/resources/{resource_name} Delete a resource
getResource GET /organizations/{organization_id}/resources/{resource_name} Get the resource details
listResources GET /organizations/{organization_id}/resources List Resources
updateResource PATCH /organizations/{organization_id}/resources/{resource_name} Update a resource

createResource

Resource createResource(organization_id, CreateResourceRequest)

Create a resource name in an organization.

Creates a resource name. Access policies can be associated with the instances of these resources. ex - \\\"Wallet\\\" is a resource name in the organization org - \\\"Org#1\\\" and \\\"wallet#1\\\" is the instance of the resource \\\"Wallet\\\". Policies on which user to access the wallet#1 can be created by the user having privilege to access the resource.

Parameters

Name Type Description Notes
organization_id String [default to null]
CreateResourceRequest CreateResourceRequest Payload to create resource

Return type

Resource

Authorization

bearerAuth

HTTP request headers

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

deleteResource

BaseSuccessResponse deleteResource(organization_id, resource_name)

Delete a resource

Delete a resource

Parameters

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

Return type

BaseSuccessResponse

Authorization

bearerAuth

HTTP request headers

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

getResource

Resource getResource(organization_id, resource_name)

Get the resource details

Gets the resource details associated with the organization

Parameters

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

Return type

Resource

Authorization

bearerAuth

HTTP request headers

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

listResources

ResourcePaginatedResponse listResources(organization_id, nextToken, pageSize, sortOrder)

List Resources

List all the resource names in an organization.

Parameters

Name Type Description Notes
organization_id 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

ResourcePaginatedResponse

Authorization

bearerAuth

HTTP request headers

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

updateResource

Resource updateResource(organization_id, resource_name, UpdateResourceRequest)

Update a resource

Update resource name of the organization

Parameters

Name Type Description Notes
organization_id String [default to null]
resource_name String [default to null]
UpdateResourceRequest UpdateResourceRequest Payload to update resource

Return type

Resource

Authorization

bearerAuth

HTTP request headers

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