# Organizations Organizations, their members and quotas. Generated from Plakar Control Plane v0.18. See [OpenAPI v1](https://www.plakar.io/docs/control-plane/references/openapi/v1/index.md) for the base URL, authentication and error format. ## List the organizations of the calling user `GET /api/v1/account/organizations` Authentication: badge Parameters: - `type` (query, string): Only organizations of this type. - `full` (query, boolean): Return the whole organization tree. Responses: - `200` OK - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Create an organization `POST /api/v1/account/organizations` Authentication: badge Request body (application/json): `OrganizationCreateRequest` Responses: - `200` OK: `OrganizationResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Get an organization `GET /api/v1/account/organizations/{id}` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. Responses: - `200` OK: `OrganizationResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Delete an organization `DELETE /api/v1/account/organizations/{id}` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. Responses: - `200` OK: `OrganizationDeleteResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## List what the caller may do, class by class `GET /api/v1/account/organizations/{id}/capabilities` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. Responses: - `200` OK: `CapabilitiesResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## List the child organizations `GET /api/v1/account/organizations/{id}/children` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. Responses: - `200` OK - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## List the members `GET /api/v1/account/organizations/{id}/members` Authentication: badge Parameters: - `offset` (query, integer): Number of items to skip. - `limit` (query, integer): Maximum number of items to return. - `search` (query, string): Free-text search on members. - `is_service` (query, boolean): Only service accounts, or only people. - `id` (path, string, required): Organization ID, at or below the caller's. Responses: - `200` OK: `OrganizationMemberResponsePage` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Add a member `POST /api/v1/account/organizations/{id}/members` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. Request body (application/json): `AddOrganizationMemberRequest` Responses: - `200` OK: `AddOrganizationMemberResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Change the role of a member `PUT /api/v1/account/organizations/{id}/members/{user_id}` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. - `user_id` (path, string, required) Request body (application/json): `UpdateOrganizationMemberRoleRequest` Responses: - `200` OK: `UpdateOrganizationMemberRoleResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Remove a member `DELETE /api/v1/account/organizations/{id}/members/{user_id}` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. - `user_id` (path, string, required) Responses: - `200` OK: `RemoveOrganizationMemberResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Reset the second factors of a member `DELETE /api/v1/account/organizations/{id}/members/{user_id}/2fa` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. - `user_id` (path, string, required) Responses: - `204` No Content - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Get the organization quota `GET /api/v1/account/organizations/{id}/quota` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. Responses: - `200` OK: `OrganizationQuotaResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default` ## Set the organization quota `PUT /api/v1/account/organizations/{id}/quota` Authentication: badge Parameters: - `id` (path, string, required): Organization ID, at or below the caller's. Request body (application/json): `UpdateOrganizationQuotaRequest` Responses: - `200` OK: `OrganizationQuotaResponse` - `400` Bad Request _(validation or deserialization error)_: `HTTPError` - `401` Missing, invalid or expired credentials - `403` The caller may not do this: `HTTPError` - `500` Internal Server Error _(panics)_: `HTTPError` - `default`