Organization
Manage AquilaX Organization via APIs
Last updated
Was this helpful?
Manage AquilaX Organization via APIs
Last updated
Was this helpful?
This API endpoint retrieves the details of a specific organization. By providing the organization ID, users can fetch the details of the organization. The endpoint returns a JSON object containing the organization details. If the organization is not found, the endpoint raises an exception with an appropriate error message.
/api/v1/organization/{org_id}
No body
This API endpoint allows users to update the details of an existing organization. By providing the organization ID and the updated organization details, users can modify the organization information. The endpoint returns a success message upon successful completion of the operation. In case of an error, the endpoint raises an exception with an appropriate error message.
/api/v1/organization/{org_id}
No body
This API endpoint allows users to delete an existing organization. By providing the organization ID, users can delete the organization. The endpoint returns a success message upon successful deletion of the organization. In case of an error, the endpoint raises an exception with an appropriate error message.
/api/v1/organization/{org_id}
No body
This API endpoint allows users to manage their membership within an organization. Depending on the action parameter, users can either update a member's role or leave the organization.
Action options:
/api/v1/organization/{org_id}/membership
Action to perform: 'update_role' or 'leave_org'
^(Owner|Security Manager|Security Engineer|Developer|Viewer)$No body
This API endpoint retrieves a list of organizations associated with the user. By providing the user ID, users can fetch all the organizations associated with the user. The endpoint returns a JSON object containing the list of organizations along with their details. If no organizations are found, the endpoint returns an empty list.
/api/v1/organization
No body
This API endpoint allows users to create a new organization. By providing the organization details, users can create a new organization. The endpoint returns the organization ID upon successful creation of the organization. In case of an error, the endpoint raises an exception with an appropriate error message.
/api/v1/organization
No body