Class OrgGroupsApi

Move a batch of organizations from one organization group to another. This is an atomic operation. Each request must include between 1 and 100 organizations. Each organization must be identified by a unique org_uuid and org_site pair, and must be in the same site as the requesting organization.

Create a new organization group.

Add a batch of organizations to an existing organization group. This operation is not supported for organization groups with group_type set to config_management. This is an atomic operation: either all organizations are added or none are. Each request must include between 1 and 100 organizations. Each organization must be identified by a unique org_uuid and org_site pair, and must be in the same site as the requesting organization. The requesting organization must own the organization group.

Create a new policy for an organization group.

Create a new policy override for an organization within an org group.

Delete an organization group by its ID.

Remove an organization from an organization group by deleting its membership. This operation is not supported for organization groups with group_type set to config_management. The organization group that the membership belongs to must be specified using filter[org_group_id], and the requesting organization must own that organization group. Returns 404 if the membership does not exist, was already removed, or does not belong to the organization group.

Delete a batch of memberships from an organization group. This operation is not supported for organization groups with group_type set to config_management. The memberships to delete are provided as membership resource identifiers, and the organization group they belong to must be specified using filter[org_group_id]. Each request must include between 1 and 100 unique membership IDs, and the requesting organization must own the organization group. The request does not fail if a membership ID refers to a membership that has already been deleted, does not exist, or does not belong to the organization group.

Delete an organization group policy by its ID.

Delete an organization group policy override by its ID.

Get a specific organization group by its ID.

Get a specific organization group membership by its ID.

Get a specific organization group policy by its ID.

Get a specific organization group policy override by its ID.

List organization group memberships. Filter by org group ID or org UUID. At least one of filter[org_group_id] or filter[org_uuid] must be provided. When filtering by org UUID, returns a single-item list with the membership for that org.

List policies for an organization group. Requires a filter on org group ID.

List all org configs that are eligible to be used as organization group policies.

List policy overrides for an organization group. Requires a filter on org group ID. Optionally filter by policy ID.

List suggested organization group policies. Requires a filter on org group ID.

List all organization groups that the requesting organization has access to.

Update the name of an existing organization group.

Move an organization to a different org group by updating its membership.

Update an existing organization group policy.

Update an existing organization group policy override.