Skip to content

Latest commit

 

History

History
121 lines (73 loc) · 3.5 KB

OrganizationManagementApi.md

File metadata and controls

121 lines (73 loc) · 3.5 KB

OrganizationManagementApi

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

Method HTTP request Description
createOrganization POST /organizations Creates an organization.
deleteOrganization DELETE /organizations/{organization_id} Delete an organization
getOrganization GET /organizations/{organization_id} Get an organization
updateOrganization PATCH /organizations/{organization_id} Update an organization

createOrganization

CreateOrganizationResponse createOrganization(CreateOrganizationRequest)

Creates an organization.

Organization is the top level entity. All resources (like user, actions, policies) are created and managed under an organization. This is a privileged api and only internal applications has access to create an Organization.

Parameters

Name Type Description Notes
CreateOrganizationRequest CreateOrganizationRequest Payload to create organization [optional]

Return type

CreateOrganizationResponse

Authorization

apiKeyAuth

HTTP request headers

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

deleteOrganization

BaseSuccessResponse deleteOrganization(organization_id)

Delete an organization

Delete an organization. This is a privileged api and only internal application will have access to delete organization.

Parameters

Name Type Description Notes
organization_id String [default to null]

Return type

BaseSuccessResponse

Authorization

apiKeyAuth

HTTP request headers

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

getOrganization

Organization getOrganization(organization_id)

Get an organization

Get an organization and the metadata for the given organization.

Parameters

Name Type Description Notes
organization_id String [default to null]

Return type

Organization

Authorization

bearerAuth

HTTP request headers

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

updateOrganization

Organization updateOrganization(organization_id, UpdateOrganizationRequest)

Update an organization

Update an organization

Parameters

Name Type Description Notes
organization_id String [default to null]
UpdateOrganizationRequest UpdateOrganizationRequest Payload to update organization

Return type

Organization

Authorization

bearerAuth

HTTP request headers

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