User Identification¶
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 user_identification replaces an existing object in the storage backend for metadata.namespace.
Tools¶
| Tool | Description |
|---|---|
f5xc-api-tenantandidentity-user-identification-create | Create User Identification. |
f5xc-api-tenantandidentity-user-identification-get | GET User Identification. |
f5xc-api-tenantandidentity-user-identification-list | List User Identification. |
f5xc-api-tenantandidentity-user-identification-update | Replace User Identification. |
f5xc-api-tenantandidentity-user-identification-delete | DELETE User Identification. |
Parameters¶
Path Parameters¶
| Parameter | Description | Example |
|---|---|---|
metadata.namespace | Namespace | - |
name | Name | - |
namespace | Namespace | - |
metadata.name | Name | - |
Query Parameters¶
| Parameter | Description | Example |
|---|---|---|
response_format | The format in which the configuration object is to be fetched. This could be for example | - |
label_filter | A LabelSelectorType expression that every item in list response will satisfy. | - |
report_fields | The report_fields parameter | - |
report_status_fields | The report_status_fields parameter | - |
Side Effects¶
Operations on this resource may have the following effects:
Creates:
- user-identification
Modifies:
- user-identification
Deletes:
- user-identification
- contained_resources
Example Usage¶
Ask Claude to help you work with User Identification resources:
Create User Identification¶
"Create a user-identification named 'example' in the 'production' namespace"
List User Identifications¶
"List all user-identifications in the 'production' namespace"
Get User Identification Details¶
"Get details of the user-identification named 'example' in namespace 'production'"
CURL Examples¶
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/user_identifications" \
-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_identifications/<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_identifications" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @user_identification.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/user_identifications/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"