Service StatusFeature RequestLogin

Groups

Manage Groups per given Organization via APIs

Add Group

This API endpoint allows users to create a new group within an organization. By providing the organization ID and a group object containing the group details, users can add a new group to the organization. The endpoint returns a success message along with the group ID upon successful creation of the group. In case of an error, the endpoint raises an exception with an routerropriate error message.

post

/api/v1/organization/{org_id}/group

Authorizations
Path parameters
org_idOrg Idrequired
Body
nameNamerequired
descriptionDescription
security_policySecurity Policy
Responses
curl -L \
  --request POST \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group' \
  --header 'X-AX-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","security_policy":{"ANY_ADDITIONAL_PROPERTY":"anything"}}'
No body

Successful Response

Get Groups

This API endpoint retrieves a list of groups associated with a specific organization. By providing the organization ID, users can fetch all the groups within the organization. The endpoint returns a JSON object containing the list of groups along with their details. If no groups are found, the endpoint returns an empty list.

get

/api/v1/organization/{org_id}/group

Authorizations
Path parameters
org_idOrg Idrequired
Responses
curl -L \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group' \
  --header 'X-AX-KEY: YOUR_API_KEY'
No body

Successful Response

Update Group

This API endpoint allows users to update the details of an existing group within an organization. By providing the group ID, organization ID and a group object containing the updated group details, users can modify the group 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 routerropriate error message.

put

/api/v1/organization/{org_id}/group/{group_id}

Authorizations
Path parameters
group_idGroup Idrequired
org_idOrg Idrequired
Query parameters
atglanceAtglance
Body
nameNamerequired
descriptionDescription
security_policySecurity Policy
Responses
curl -L \
  --request PUT \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}' \
  --header 'X-AX-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","security_policy":{"ANY_ADDITIONAL_PROPERTY":"anything"}}'
No body

Successful Response

Get Group

This API endpoint retrieves the details of a specific group within an organization. By providing the organization ID and group ID, users can fetch the group details. The endpoint returns a JSON object containing the group information. If the group is not found, the endpoint returns an error message.

get

/api/v1/organization/{org_id}/group/{group_id}

Authorizations
Path parameters
group_idGroup Idrequired
org_idOrg Idrequired
Responses
curl -L \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}' \
  --header 'X-AX-KEY: YOUR_API_KEY'
No body

Successful Response

Delete Group

This API endpoint allows users to delete an existing group within an organization. By providing the group ID and organization ID, users can remove the group from the organization. The endpoint returns a success message upon successful deletion of the group. In case of an error, the endpoint raises an exception with an routerropriate error message.

delete

/api/v1/organization/{org_id}/group/{group_id}

Authorizations
Path parameters
group_idGroup Idrequired
org_idOrg Idrequired
Responses
curl -L \
  --request DELETE \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}' \
  --header 'X-AX-KEY: YOUR_API_KEY'
No body

Successful Response

PreviousOrganizationNextProjects

Last updated

Was this helpful?