User Group

User Group provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.

Tools

Tool	Description
f5xc-api-tenantandidentity-user-group-create	Create User Group.
f5xc-api-tenantandidentity-user-group-get	Fetch all the details for a group provided the group ID.
f5xc-api-tenantandidentity-user-group-list	Get all User Groups for the tenant.
f5xc-api-tenantandidentity-user-group-update	Update the User Group fields / accesses / associations.
f5xc-api-tenantandidentity-user-group-delete	Delete a group provided the group ID.

Parameters

Path Parameters

Parameter	Description	Example
name	Name of the user group name of the specific group.	example-resource

Query Parameters

Parameter	Description	Example
attempt_remove_references	The attempt_remove_references parameter…	-

Example Usage

Ask Claude to help you work with User Group resources:

Create User Group

“Create a user-group named ‘example’ in the ‘production’ namespace”

List User Groups

“List all user-groups in the ‘production’ namespace”

Get User Group Details

“Get details of the user-group named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/web/custom/namespaces/system/user_groups" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/web/custom/namespaces/system/user_groups/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/web/custom/namespaces/system/user_groups" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @user_group.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/web/custom/namespaces/system/user_groups/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"