Authentication
Authentication provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-tenantandidentity-authentication-create | Create Authentication. |
f5xc-api-tenantandidentity-authentication-get | Get Authentication. |
f5xc-api-tenantandidentity-authentication-list | List Authentication. |
f5xc-api-tenantandidentity-authentication-update | Update Authentication. |
f5xc-api-tenantandidentity-authentication-delete | Delete Authentication. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”| Parameter | Description | Example |
|---|---|---|
namespace | Namespace This defines the workspace within which each the configuration object is to be created. | system |
name | Name The name of the configuration object to be fetched. | example-resource |
Query Parameters
Section titled “Query Parameters”| Parameter | Description | Example |
|---|---|---|
response_format | The format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object… | GET_RSP_FORMAT_DEFAULT |
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… | - |
Configuration Choices
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
auth_type_choice
Section titled “auth_type_choice”| Option | Description | Recommended |
|---|---|---|
spec.oidc_auth | Oidc auth |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Authentication resources:
Create Authentication
Section titled “Create Authentication”“Create a authentication named ‘example’ in the ‘production’ namespace”
List Authentications
Section titled “List Authentications”“List all authentications in the ‘production’ namespace”
Get Authentication Details
Section titled “Get Authentication Details”“Get details of the authentication named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/authentications" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/authentications/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/authentications" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @authentication.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/authentications/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"