Skip to content

User Identification

Replace user_identification replaces an existing object in the storage backend for metadata.namespace.

ToolDescription
f5xc-api-tenantandidentity-user-identification-createCreate User Identification.
f5xc-api-tenantandidentity-user-identification-getGET User Identification.
f5xc-api-tenantandidentity-user-identification-listList User Identification.
f5xc-api-tenantandidentity-user-identification-updateReplace User Identification.
f5xc-api-tenantandidentity-user-identification-deleteDELETE User Identification.
ParameterDescriptionExample
metadata.namespaceNamespace-
nameName-
namespaceNamespace-
metadata.nameName-
ParameterDescriptionExample
response_formatThe format in which the configuration object is to be fetched. This could be for example-
label_filterA LabelSelectorType expression that every item in list response will satisfy.-
report_fieldsThe report_fields parameter-
report_status_fieldsThe report_status_fields parameter-

This resource includes mutually exclusive configuration options:

OptionDescriptionRecommended
spec.rules[].client_asn-
spec.rules[].client_city-
spec.rules[].client_country-
spec.rules[].client_ip-
spec.rules[].client_region-
spec.rules[].cookie_name-
spec.rules[].http_header_name-
spec.rules[].ip_and_http_header_name-
spec.rules[].ip_and_ja4_tls_fingerprint-
spec.rules[].ip_and_tls_fingerprint-
spec.rules[].ja4_tls_fingerprint-
spec.rules[].jwt_claim_name-
spec.rules[].none-
spec.rules[].query_param_key-
spec.rules[].tls_fingerprint-

Ask Claude to help you work with User Identification resources:

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

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

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

Terminal window
# 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}"