User Group¶

High Risk Operation

This resource includes operations that may cause significant changes. Review carefully before executing.

Confirmation Required

Some operations on this resource require explicit confirmation before execution.

Replace allows updating of the different user group fields like the display name, description, user associations and RBAC accesses. The name of the user group cannot be edited and the sync_id can be edited only when SCIM is enabled for the tenant. If any of the editable fields are nil / empty in the request, it will be considered as the removal of the field value.

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`	Replace 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	`-`

Query Parameters¶

Parameter	Description	Example
`attempt_remove_references`	The attempt_remove_references parameter	`-`

Side Effects¶

Operations on this resource may have the following effects:

Creates:

user-group

Modifies:

user-group

Deletes:

user-group
contained_resources

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/config/namespaces/${NAMESPACE}/user_groups" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/user_groups/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/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/config/namespaces/${NAMESPACE}/user_groups/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"