Group
Group provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-tenantandidentity-group-create | Create group with users. |
f5xc-api-tenantandidentity-group-get | List group based on ID. |
f5xc-api-tenantandidentity-group-list | List group based on filters. |
f5xc-api-tenantandidentity-group-update | Update group based on ID. |
f5xc-api-tenantandidentity-group-delete | Delete group based on ID. |
f5xc-api-tenantandidentity-group-patch | PATCH group based on ID. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”| Parameter | Description | Example |
|---|---|---|
id | ID x-required… | - |
Query Parameters
Section titled “Query Parameters”| Parameter | Description | Example |
|---|---|---|
excludedAttributes | Members”]” A multi-valued list of strings indicating the names of resource attributes… | - |
count | The number of entries after filter. | - |
filter | Filter to be used for filtering objects. | - |
page | Start offset. | - |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Group resources:
Create Group
Section titled “Create Group”“Create a Group named ‘example’ in the ‘production’ namespace”
List Groups
Section titled “List Groups”“List all Groups in the ‘production’ namespace”
Get Group Details
Section titled “Get Group Details”“Get details of the Group named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/scim/namespaces/system/v2/Groups" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/scim/namespaces/system/v2/Groups/${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/scim/namespaces/system/v2/Groups" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @Group.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/scim/namespaces/system/v2/Groups/${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"