{ "openapi": "3.0.3", "info": { "title": "Tenant And Identity", "description": "Profile images and display customizations for personalized dashboard experiences. Federated authentication toggles controlling SSO behavior across organizational boundaries. Session lifecycle tracking with real-time visibility into active connections and timeout policies. Support ticket workflows including attachment handling and closure procedures for managed client escalations. Initial access provisioning sequences for new user onboarding.", "version": "8.0.2", "contact": { "name": "F5 Distributed Cloud", "url": "https://docs.cloud.f5.com" }, "license": { "name": "Proprietary", "url": "https://www.f5.com/company/policies/eula" }, "x-f5xc-description-long": "Profile images and display customizations for personalized dashboard experiences. Federated authentication toggles controlling SSO behavior across organizational boundaries. Session lifecycle tracking with real-time visibility into active connections and timeout policies. Support ticket workflows including attachment handling and closure procedures for managed client escalations. Initial access provisioning sequences for new user onboarding.", "x-f5xc-summary": "Account view configurations and admin alert channels. One-time password resets, provisioning flows, and active connection monitoring.", "x-f5xc-cli-domain": "tenant_and_identity", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/user-mgmt", "description": "F5 XC Documentation - Tenant and Identity" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/", "x-f5xc-best-practices": { "common_errors": [ { "code": 400, "message": "Invalid request body", "resolution": "Validate JSON structure and required fields before submission", "prevention": "Use schema validation from OpenAPI spec" }, { "code": 401, "message": "Authentication failed", "resolution": "Verify API token is valid and not expired", "prevention": "Use environment variables for token management" }, { "code": 403, "message": "Permission denied", "resolution": "Check user role and namespace permissions", "prevention": "Verify RBAC policies before operations" }, { "code": 404, "message": "Resource not found", "resolution": "Verify resource name and namespace exist", "prevention": "List resources before attempting operations" }, { "code": 409, "message": "Resource already exists", "resolution": "Use unique name or delete existing resource", "prevention": "Check existence before creation" }, { "code": 429, "message": "Rate limit exceeded", "resolution": "Implement exponential backoff and retry logic", "prevention": "Batch operations and add delays between requests" } ], "security_notes": [ "Always use HTTPS for all API communications", "Store API tokens securely, never in source code", "Rotate API tokens regularly following security policies" ], "performance_tips": [ "Use pagination for large result sets", "Batch related operations when possible", "Cache read-only responses appropriately" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "servers": [ { "url": "https://{tenant}.{console_url}/api/v1/{domain_prefix}/{environment}/{region}/namespaces/{namespace}", "description": "F5 Distributed Cloud Console", "variables": { "tenant": { "default": "example-corp", "description": "F5 Distributed Cloud tenant identifier (e.g., example-corp, example-partners)" }, "console_url": { "default": "console.ves.volterra.io", "description": "Console URL base (e.g., console.ves.volterra.io for production, staging.volterra.us for staging)", "enum": [ "console.ves.volterra.io", "staging.volterra.us" ] }, "environment": { "default": "production", "description": "Environment designation (production, staging, development)", "enum": [ "production", "staging", "development" ] }, "domain_prefix": { "default": "api", "description": "Domain naming prefix for consistent naming conventions" }, "region": { "default": "us-east-1", "description": "Geographic region for API deployment (e.g., us-east-1, eu-west-1)" }, "namespace": { "default": "default", "description": "Kubernetes-style namespace for environment separation (e.g., 'default', 'production', 'staging')" } } } ], "security": [ { "ApiToken": [] } ], "tags": [ { "name": "cloud-data" }, { "name": "cname" }, { "name": "config" }, { "name": "countries" }, { "name": "login" }, { "name": "ml" }, { "name": "saas" }, { "name": "scim" }, { "name": "send_password_email" }, { "name": "signup" }, { "name": "tenant" }, { "name": "validate_contact" }, { "name": "waf" }, { "name": "web" } ], "paths": { "/api/web/namespaces/system/allowed_tenants/support-tenant/access": { "get": { "summary": "GET Support Tenant Access.", "description": "GET current access details for the support tenant.", "operationId": "ves.io.schema.tenant_management.allowed_tenant.CustomAPI.GetSupportTenantAccess", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_tenantGetSupportTenantAccessResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.allowed_tenant.CustomAPI.GetSupportTenantAccess", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Update Support Tenant Access.", "description": "This RPC can be used to manage user access for all flavors of support tenants currently\nsupported by the platform. Use read-only, read-write with specific namespaces or\nadmin can specify custom groups to control access by the support tenant user.\nName is well-known identifier for a specific support related tenant.", "operationId": "ves.io.schema.tenant_management.allowed_tenant.CustomAPI.UpdateSupportTenantAccess", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_tenantUpdateSupportTenantAccessResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_tenantUpdateSupportTenantAccessReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.allowed_tenant.CustomAPI.UpdateSupportTenantAccess", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Acces resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "acces" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "acces" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Allowed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.allowed_tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/allowed_tenants": { "post": { "summary": "Create Allowed Tenant.", "description": "Creates a allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "operationId": "ves.io.schema.tenant_management.allowed_tenant.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementallowed_tenantCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementallowed_tenantCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.allowed_tenant.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Allowed-tenant resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "allowed-tenant" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "allowed-tenant" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Allowed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.allowed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/allowed_tenants/{metadata.name}": { "put": { "summary": "Replace Allowed Tenant.", "description": "Replaces attributes of a allowed_tenant instance including its metadata like labels, description etc.", "operationId": "ves.io.schema.tenant_management.allowed_tenant.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_tenantReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_tenantReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.allowed_tenant.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "allowed-tenant" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "allowed-tenant" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Allowed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.allowed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/allowed_tenants": { "get": { "summary": "List Allowed Tenant.", "description": "List the set of allowed_tenant in a namespace.", "operationId": "ves.io.schema.tenant_management.allowed_tenant.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementallowed_tenantListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of allowed_tenant.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.allowed_tenant.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Allowed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.allowed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/allowed_tenants/{name}": { "get": { "summary": "GET Allowed Tenant.", "description": "GET allowed_tenant reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.tenant_management.allowed_tenant.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementallowed_tenantGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.allowed_tenant.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Allowed Tenant.", "description": "DELETE the specified allowed_tenant.", "operationId": "ves.io.schema.tenant_management.allowed_tenant.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_tenantDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.allowed_tenant.API.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "allowed-tenant", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "allowed-tenant", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Allowed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.allowed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/authentications": { "post": { "summary": "Create Authentication.", "operationId": "ves.io.schema.authentication.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authentication.API.Create", "tags": [ "config" ], "description": "Create authentications.", "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Authentication resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "authentication" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "authentication" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authentication.", "x-ves-proto-service": "ves.io.schema.authentication.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/authentications/{metadata.name}": { "put": { "summary": "Replace Authentication.", "operationId": "ves.io.schema.authentication.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authentication.API.Replace", "tags": [ "config" ], "description": "Replace authentications.", "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "authentication" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "authentication" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authentication.", "x-ves-proto-service": "ves.io.schema.authentication.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/authentications": { "get": { "summary": "List Authentication.", "description": "List the set of authentication in a namespace.", "operationId": "ves.io.schema.authentication.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of authentication.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authentication.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 160.66, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 160.66, "p95_ms": 321.32, "p99_ms": 481.98, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Authentication.", "x-ves-proto-service": "ves.io.schema.authentication.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/authentications/{name}": { "get": { "summary": "GET Authentication.", "operationId": "ves.io.schema.authentication.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authentication.API.Get", "tags": [ "config" ], "description": "GET authentications.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Authentication.", "description": "DELETE the specified authentication.", "operationId": "ves.io.schema.authentication.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authentication.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "authentication", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "authentication", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authentication.", "x-ves-proto-service": "ves.io.schema.authentication.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/authorization_servers": { "post": { "summary": "Create Authorization Server.", "description": "Create authorization_server creates a new object in the storage backend for metadata.namespace.", "operationId": "ves.io.schema.authorization_server.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authorization_server.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Authorization-server resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "authorization-server" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "authorization-server" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authorization Server.", "x-ves-proto-service": "ves.io.schema.authorization_server.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/authorization_servers/{metadata.name}": { "put": { "summary": "Replace Authorization Server.", "description": "Replace authorization_server replaces an existing object in the storage backend for metadata.namespace.", "operationId": "ves.io.schema.authorization_server.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authorization_server.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "authorization-server" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "authorization-server" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authorization Server.", "x-ves-proto-service": "ves.io.schema.authorization_server.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/authorization_servers": { "get": { "summary": "List Authorization Server.", "description": "List the set of authorization_server in a namespace.", "operationId": "ves.io.schema.authorization_server.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of authorization_server.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authorization_server.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authorization Server.", "x-ves-proto-service": "ves.io.schema.authorization_server.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/authorization_servers/{name}": { "get": { "summary": "GET Authorization Server.", "description": "GET authorization_server reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.authorization_server.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authorization_server.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Authorization Server.", "description": "DELETE the specified authorization_server.", "operationId": "ves.io.schema.authorization_server.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authorization_server.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "authorization-server", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "authorization-server", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authorization Server.", "x-ves-proto-service": "ves.io.schema.authorization_server.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/waf/namespaces/{namespace}/authorization_servers/{name}/update": { "post": { "summary": "Update Authorization Server.", "description": "Update the JWKS on all LBs in which this Authorization Server is configured.", "operationId": "ves.io.schema.authorization_server.CustomAPI.UpdateAuthorizationServer", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverUpdateAuthorizationServerResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "okta" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_serverUpdateAuthorizationServerRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.authorization_server.CustomAPI.UpdateAuthorizationServer", "tags": [ "waf" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Update resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "update" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Authorization Server.", "x-ves-proto-service": "ves.io.schema.authorization_server.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/child_tenants": { "get": { "summary": "List of Child Tenants.", "description": "GET list of child tenants user has access to based on assigned membership.\nThis is an optimized list generated based on the requesting user's current group assignments\nthat will allow access to child tenant.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomAPI.ListChildTenants", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenantListChildTenantsResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Filter child tenant list using name of child tenant.", "in": "query", "required": false, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "ctm", "description": "Name of the Child Tenant Manager.\nIf this field set, child tenant list will be filtered by given CTM.", "in": "query", "required": false, "x-displayname": "CTM", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "page_start", "description": "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.", "in": "query", "required": false, "x-displayname": "PageStart", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-26c25c406c98" }, { "name": "page_limit", "description": "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.", "in": "query", "required": false, "x-displayname": "PageLimit", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "100" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomAPI.ListChildTenants", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/child_tenants/migrate": { "post": { "summary": "Migrate Child Tenants.", "description": "Migrate ACTIVE child tenants from existing CTM(s) to a specified new CTM.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomAPI.MigrateChildTenants", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenantMigrateChildTenantsResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenantMigrateChildTenantsReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomAPI.MigrateChildTenants", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Migrate resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "migrate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "migrate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports": { "get": { "summary": "List all support tickets created in child tenant.", "description": "Return list of all support tickets for a child tenant.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.ListChildTenantSupportTickets", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementListSupportTicketResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.ListChildTenantSupportTickets", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create customer support ticket in child tenant.", "description": "Creates a new customer support ticket in our customer support provider system.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemacustomer_supportCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemacustomer_supportCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Customer-support resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "customer-support" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "customer-support" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}": { "get": { "summary": "GET customer support ticket in child tenant.", "description": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementGetByTpIdResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.tp_id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/close": { "post": { "summary": "Close a customer support ticket in child tenant.", "description": "Closes selected customer support ticket (if not already closed). You can always attempt to reopen if needed to be.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Close", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportCloseResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSupportTicketRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Close", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Close resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "close" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "close" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/comment": { "post": { "summary": "Add comment to a customer support ticket in child tenant.", "description": "Adds additional comment to a specified customer support ticket. The comment may include an attachment.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Comment", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportCommentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenant_managementCommentRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Comment", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Comment resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "comment" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "comment" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/comment/{comment_id}/attachment/{attachment_id}": { "get": { "summary": "GET attachment.", "description": "GET a specific attachment included in the comment from a customer support ticket.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.GetAttachment", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "00431349" }, { "name": "comment_id", "description": "Comment_id\nThe ID of the comment containing the attachment.", "in": "path", "required": true, "x-displayname": "Comment ID.", "schema": { "type": "string" }, "x-f5xc-example": "02s3S000000vvYSQAY" }, { "name": "attachment_id", "description": "Attachment_id\nThe ID of the attachment included in the comment from a customer support ticket.", "in": "path", "required": true, "x-displayname": "Attachment ID.", "schema": { "type": "string" }, "x-f5xc-example": "068do000004gReEAAU" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.GetAttachment", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.attachment_id", "path.comment_id", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.attachment_id", "path.comment_id", "path.tp_id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/escalate": { "post": { "summary": "Escalate a ticket in child tenant.", "description": "Escalates a selected ticket. Only certain customers (depending on their contract) are allowed to escalate tickets.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Escalate", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportEscalationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSupportTicketRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Escalate", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Escalate resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "escalate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "escalate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/priority": { "post": { "summary": "Change priority of a ticket in child tenant.", "description": "Changes priority of a selected ticket. Not possible if ticket's already closed.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Priority", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportPriorityResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenant_managementPriorityRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Priority", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Priority resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "priority" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "priority" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/reopen": { "post": { "summary": "Reopen a closed customer support ticket in child tenant.", "description": "Reopens a selected closed customer support ticket.", "operationId": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Reopen", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportReopenResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSupportTicketRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Reopen", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Reopen resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "reopen" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "reopen" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/child_tenants": { "post": { "summary": "Child Tenant.", "description": "Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.", "operationId": "ves.io.schema.tenant_management.child_tenant.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenantCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenantCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Child-tenant resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "child-tenant" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "child-tenant" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/child_tenants/{metadata.name}": { "put": { "summary": "Replace Child Tenant.", "description": "Replaces attributes of a child_tenant configuration.", "operationId": "ves.io.schema.tenant_management.child_tenant.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenantReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenantReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "child-tenant" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "child-tenant" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/child_tenants": { "get": { "summary": "List Child Tenant.", "description": "List the set of child_tenant in a namespace.", "operationId": "ves.io.schema.tenant_management.child_tenant.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenantListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of child_tenant.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/child_tenants/{name}": { "get": { "summary": "GET Child Tenant.", "description": "GET child_tenant reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.tenant_management.child_tenant.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenantGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Child Tenant.", "description": "DELETE the specified child_tenant.", "operationId": "ves.io.schema.tenant_management.child_tenant.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenantDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant.API.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "child-tenant", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "child-tenant", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants": { "get": { "summary": "List child tenants for a given child tenant manager.", "description": "GET list of child tenants managed by a child tenant manager.", "operationId": "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI.ListChildTenants", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenant_managerListChildTenantsByCTMResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\n\nx-required\nName of the Child Tenant Manager.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI.ListChildTenants", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant Manager.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants/migrate": { "post": { "summary": "Migrate CTM child tenants.", "description": "Migrate ACTIVE child tenants from existing CTM to a specified new CTM.", "operationId": "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI.MigrateCTMChildTenants", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenant_managerMigrateCTMChildTenantsResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\n\nx-required\nName of the child tenant manager.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenant_managerMigrateCTMChildTenantsReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI.MigrateCTMChildTenants", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Migrate resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "migrate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "migrate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant Manager.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/child_tenant_managers": { "post": { "summary": "Child Tenant Manager.", "description": "Creates a child_tenant_manager config instance. Name of the object is the name of the child tenant manager to be created.", "operationId": "ves.io.schema.tenant_management.child_tenant_manager.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant_manager.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Child-tenant-manager resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "child-tenant-manager" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "child-tenant-manager" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant Manager.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant_manager.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/child_tenant_managers/{metadata.name}": { "put": { "summary": "Replace Child Tenant Manager.", "description": "Replaces attributes of a child_tenant_manager configuration.", "operationId": "ves.io.schema.tenant_management.child_tenant_manager.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenant_managerReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenant_managerReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant_manager.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "child-tenant-manager" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "child-tenant-manager" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant Manager.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant_manager.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/child_tenant_managers": { "get": { "summary": "List Child Tenant Manager.", "description": "List the set of child_tenant_manager in a namespace.", "operationId": "ves.io.schema.tenant_management.child_tenant_manager.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of child_tenant_manager.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant_manager.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant Manager.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant_manager.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/child_tenant_managers/{name}": { "get": { "summary": "GET Child Tenant Manager.", "description": "GET child_tenant_manager reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.tenant_management.child_tenant_manager.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant_manager.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Child Tenant Manager.", "description": "DELETE the specified child_tenant_manager.", "operationId": "ves.io.schema.tenant_management.child_tenant_manager.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/child_tenant_managerDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.child_tenant_manager.API.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "child-tenant-manager", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "child-tenant-manager", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Child Tenant Manager.", "x-ves-proto-service": "ves.io.schema.tenant_management.child_tenant_manager.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/cloud-data/namespaces/system/cloud_user_accounts/{cloud_user_account_name}/onboarded_networks": { "get": { "summary": "GET Onboarded Cloud Networks.", "description": "API to GET onboarded cloud networks for given cloud user account.", "operationId": "ves.io.schema.cloud_user_account.CustomAPI.GetOnboardedCloudNetworks", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_user_accountGetOnboardedCloudNetworksResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "cloud_user_account_name", "description": "Cloud User Account Name\n\nx-required\nCloud User Account name.", "in": "path", "required": true, "x-displayname": "Cloud User Account Name.", "schema": { "type": "string" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_user_account.CustomAPI.GetOnboardedCloudNetworks", "tags": [ "cloud-data" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "path.cloud_user_account_name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.cloud_user_account_name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud User Account.", "x-ves-proto-service": "ves.io.schema.cloud_user_account.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/cloud-data/namespaces/system/cloud_user_accounts/{cloud_user_account_name}/validate": { "get": { "summary": "Validates Cloud User Account.", "description": "API to validate cloud user account.", "operationId": "ves.io.schema.cloud_user_account.CustomAPI.ValidateCloudUserAccount", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_user_accountValidateCloudUserAccountResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "cloud_user_account_name", "description": "Cloud User Account Name\n\nx-required\nCloud User Account Name.", "in": "path", "required": true, "x-displayname": "Cloud User Account Name.", "schema": { "type": "string" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_user_account.CustomAPI.ValidateCloudUserAccount", "tags": [ "cloud-data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.cloud_user_account_name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.cloud_user_account_name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud User Account.", "x-ves-proto-service": "ves.io.schema.cloud_user_account.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/contacts": { "post": { "summary": "Create Contact.", "description": "Creates a new customer's contact detail record with us, including address and phone number.", "operationId": "ves.io.schema.contact.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contactCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contactCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.contact.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Contact resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "contact" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "contact" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Contact", "x-ves-proto-service": "ves.io.schema.contact.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/contacts/{metadata.name}": { "put": { "summary": "Replace Contact.", "description": "Updates existing customer's contact details, including address and phone number.", "operationId": "ves.io.schema.contact.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contactReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contactReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.contact.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "contact" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "contact" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Contact", "x-ves-proto-service": "ves.io.schema.contact.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/contacts": { "get": { "summary": "List Contact.", "description": "List the set of contact in a namespace.", "operationId": "ves.io.schema.contact.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contactListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of contact.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.contact.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Contact", "x-ves-proto-service": "ves.io.schema.contact.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/contacts/{name}": { "get": { "summary": "GET Contact.", "description": "Retrieves existing customer's contact details, including address and phone number.", "operationId": "ves.io.schema.contact.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contactGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.contact.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Contact.", "description": "DELETE the specified contact.", "operationId": "ves.io.schema.contact.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contactDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.contact.API.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "contact", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "contact", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Contact", "x-ves-proto-service": "ves.io.schema.contact.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports": { "get": { "summary": "List tickets of managed tenant.", "description": "Returns list of customer support tickets of managed tenant.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementListSupportTicketResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create customer support ticket in managed tenant.", "description": "Creates a new customer support ticket in our customer support provider system.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemacustomer_supportCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemacustomer_supportCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Customer-support resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "customer-support" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "customer-support" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}": { "get": { "summary": "GET customer support ticket in managed tenant.", "description": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementGetByTpIdResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.tp_id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/close": { "post": { "summary": "Close a customer support ticket in managed tenant.", "description": "Closes selected customer support ticket (if not already closed). You can always attempt to reopen if needed to be.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Close", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportCloseResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSupportTicketRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Close", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Close resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "close" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "close" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/comment": { "post": { "summary": "Add comment to a customer support ticket in managed tenant.", "description": "Adds additional comment to a specified customer support ticket. The comment may include an attachment.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Comment", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportCommentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenant_managementCommentRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Comment", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Comment resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "comment" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "comment" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/comment/{comment_id}/attachment/{attachment_id}": { "get": { "summary": "GET attachment.", "description": "GET a specific attachment included in the comment from a customer support ticket.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.GetAttachment", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "00431349" }, { "name": "comment_id", "description": "Comment_id\nThe ID of the comment containing the attachment.", "in": "path", "required": true, "x-displayname": "Comment ID.", "schema": { "type": "string" }, "x-f5xc-example": "02s3S000000vvYSQAY" }, { "name": "attachment_id", "description": "Attachment_id\nThe ID of the attachment included in the comment from a customer support ticket.", "in": "path", "required": true, "x-displayname": "Attachment ID.", "schema": { "type": "string" }, "x-f5xc-example": "068do000004gReEAAU" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.GetAttachment", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.attachment_id", "path.comment_id", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.attachment_id", "path.comment_id", "path.tp_id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/escalate": { "post": { "summary": "Escalate a ticket in managed tenant.", "description": "Escalates a selected ticket. Only certain customers (depending on their contract) are allowed to escalate tickets.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Escalate", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportEscalationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSupportTicketRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Escalate", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Escalate resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "escalate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "escalate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/priority": { "post": { "summary": "Priority of a ticket in managed tenant.", "description": "Priority of a selected ticket. Not possible if ticket's already closed.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Priority", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportPriorityResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenant_managementPriorityRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Priority", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Priority resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "priority" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "priority" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/reopen": { "post": { "summary": "Reopen a closed customer support ticket in managed tenant.", "description": "Reopens a selected closed customer support ticket.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Reopen", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_supportReopenResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tp_id", "description": "Third party ID\nID assigned to this ticket by our support provider.", "in": "path", "required": true, "x-displayname": "Third Party ID.", "schema": { "type": "string" }, "x-f5xc-example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSupportTicketRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Reopen", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Reopen resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "reopen" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.tp_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "reopen" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_tenants_by_user": { "get": { "summary": "GET List of Managed Tenant By User.", "description": "GET list of managed tenants that user have access to based on assigned membership.\nThis is an optimized list generated based on the requesting user's current group assignments\nthat will allow access to managed tenant.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomAPI.GetManagedTenantListByUser", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managed_tenantGetManagedTenantListResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "search_keyword", "description": "Search Keyword for filtering the Managed Tenant List.", "in": "query", "required": false, "x-displayname": "SearchKeyword.", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "page_start", "description": "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.", "in": "query", "required": false, "x-displayname": "PageStart", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-26c25c406c98" }, { "name": "page_limit", "description": "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.", "in": "query", "required": false, "x-displayname": "PageLimit", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "100" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomAPI.GetManagedTenantListByUser", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/managed_tenants_list": { "get": { "summary": "GET List of Managed Tenant.", "description": "GET full list of managed tenants access details.\nThis response will contain full list of managed tenant based on the configuration\nand is not filtered by requesting user's group membership that enable access.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomAPI.GetManagedTenantList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managed_tenantGetManagedTenantListResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "search_keyword", "description": "Search Keyword for filtering the Managed Tenant List.", "in": "query", "required": false, "x-displayname": "SearchKeyword.", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "page_start", "description": "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.", "in": "query", "required": false, "x-displayname": "PageStart", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-26c25c406c98" }, { "name": "page_limit", "description": "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.", "in": "query", "required": false, "x-displayname": "PageLimit", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "100" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomAPI.GetManagedTenantList", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/support-tenant/managed_tenants": { "get": { "summary": "List of Managed Tenant By User For Support Operations.", "description": "GET list of managed tenants that user have access to based on assigned membership.\nThis is an optimized list generated based on the requesting user's current group assignments\nthat will allow access to managed tenant.", "operationId": "ves.io.schema.tenant_management.managed_tenant.CustomAPI.ListSupportTenantMT", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managed_tenantListSupportTenantMTResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "search_keyword", "description": "Search Keyword for filtering the Managed Tenant List.", "in": "query", "required": false, "x-displayname": "SearchKeyword.", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "page_start", "description": "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.", "in": "query", "required": false, "x-displayname": "PageStart", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-26c25c406c98" }, { "name": "page_limit", "description": "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.", "in": "query", "required": false, "x-displayname": "PageLimit", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "100" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.CustomAPI.ListSupportTenantMT", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/managed_tenants": { "post": { "summary": "Create Managed Tenant.", "description": "Creates a managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "operationId": "ves.io.schema.tenant_management.managed_tenant.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementmanaged_tenantCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementmanaged_tenantCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Managed-tenant resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "managed-tenant" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "managed-tenant" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/managed_tenants/{metadata.name}": { "put": { "summary": "Replace Managed Tenant.", "description": "Replaces attributes of a managed_tenant configuration.\nUpdate of existing tenant_choice selection is not supported but user may update existing group assignments.", "operationId": "ves.io.schema.tenant_management.managed_tenant.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managed_tenantReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managed_tenantReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "managed-tenant" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "managed-tenant" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/managed_tenants": { "get": { "summary": "List Managed Tenant.", "description": "List the set of managed_tenant in a namespace.", "operationId": "ves.io.schema.tenant_management.managed_tenant.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementmanaged_tenantListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of managed_tenant.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/managed_tenants/{name}": { "get": { "summary": "GET Managed Tenant.", "description": "GET managed_tenant reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.tenant_management.managed_tenant.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementmanaged_tenantGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Managed Tenant.", "description": "DELETE the specified managed_tenant.", "operationId": "ves.io.schema.tenant_management.managed_tenant.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managed_tenantDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.managed_tenant.API.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "managed-tenant", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "managed-tenant", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Managed Tenant.", "x-ves-proto-service": "ves.io.schema.tenant_management.managed_tenant.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces": { "get": { "summary": "List Namespace.", "description": "List the set of namespace in a namespace.", "operationId": "ves.io.schema.namespace.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace to scope the listing of namespace.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Logical resource grouping and multi-tenancy boundary", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create Namespace.", "description": "Creates a new namespace. Name of the object is name of the name space.", "operationId": "ves.io.schema.namespace.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Logical resource grouping and multi-tenancy boundary", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Namespace resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "namespace" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "namespace" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/system/all_application_inventory": { "post": { "summary": "All Application Objects Inventory.", "description": "AllApplicationInventory returns inventory of configured application related objects for all namespaces.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceApplicationInventoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceAllApplicationInventoryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventory", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "All-application-inventory resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "all-application-inventory" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "all-application-inventory" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/all_application_inventory_waf_filters": { "post": { "summary": "All Application Objects Inventory with WAF Filters.", "description": "AllApplicationInventoryWaf returns inventory of configured application related objects for all namespaces with WAF Filters.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventoryWaf", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceAllApplicationInventoryWafFilterResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceAllApplicationInventoryWafFilterRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventoryWaf", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "All-application-inventory-waf-filter resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "all-application-inventory-waf-filter" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "all-application-inventory-waf-filter" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/ml/data/namespaces/system/api_endpoints/all_ns_stats": { "post": { "summary": "GET API Endpoints Stats for All Namespaces.", "description": "GET API endpoints stats for all Namespaces. This API is specific to system namespace.", "operationId": "ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStatsAllNamespaces", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceApiEndpointsStatsNSRsp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceApiEndpointsStatsAllNSReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStatsAllNamespaces", "tags": [ "ml" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "All-ns-stat resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "all-ns-stat" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "all-ns-stat" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceMLCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/evaluate-api-access": { "post": { "summary": "Evaluate API Access.", "description": "EvaluateAPIAccess can evaluate multiple lists of API URL, method under a namespace for a given user of a tenant.", "operationId": "ves.io.schema.namespace.CustomAPI.EvaluateAPIAccess", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceEvaluateAPIAccessResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceEvaluateAPIAccessReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.CustomAPI.EvaluateAPIAccess", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Evaluate-api-acces resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "evaluate-api-acces" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "evaluate-api-acces" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/evaluate-batch-api-access": { "post": { "summary": "Evaluate Batch API Access.", "description": "EvaluateBatchAPIAccess can evaluate multiple lists of API URL, method under a batch of namespaces for a given user of a tenant.", "operationId": "ves.io.schema.namespace.CustomAPI.EvaluateBatchAPIAccess", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceEvaluateBatchAPIAccessResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceEvaluateBatchAPIAccessReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.CustomAPI.EvaluateBatchAPIAccess", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Evaluate-batch-api-acces resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "evaluate-batch-api-acces" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "high" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "evaluate-batch-api-acces" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/lookup-user-roles": { "post": { "summary": "Lookup User Roles.", "description": "LookupUserRoles returns roles for the the given user, namespace.", "operationId": "ves.io.schema.namespace.CustomAPI.LookupUserRoles", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceLookupUserRolesResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceLookupUserRolesReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.CustomAPI.LookupUserRoles", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Lookup-user-role resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "lookup-user-role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "lookup-user-role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/networking_inventory": { "post": { "summary": "Networking Objects Inventory.", "description": "NetworkingInventory returns inventory of configured networking related objects for the tenant.\nInventory of system-wide objects (global networks, sites, site mesh groups, etc) is returned.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.NetworkingInventory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceNetworkingInventoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceNetworkingInventoryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.NetworkingInventory", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Networking-inventory resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "networking-inventory" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "networking-inventory" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/cloud-data/namespaces/system/suggest-values": { "post": { "summary": "Suggest Values.", "description": "Returns suggested values for the specified field in the given Create/Replace/Custom request.", "operationId": "ves.io.schema.namespace.NamespaceCloudDataCustomAPI.SuggestValues", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemanamespaceSuggestValuesResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSuggestValuesReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCloudDataCustomAPI.SuggestValues", "tags": [ "cloud-data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Suggest-value resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "suggest-value" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "suggest-value" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCloudDataCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/update_allow_advertise_on_public": { "post": { "summary": "Update allow advertise on public.", "description": "UpdateAllowAdvertiseOnPublic can update a config to allow advertise on public.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.UpdateAllowAdvertiseOnPublic", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceUpdateAllowAdvertiseOnPublicResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceUpdateAllowAdvertiseOnPublicReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.UpdateAllowAdvertiseOnPublic", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Update-allow-advertise-on-public resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-allow-advertise-on-public" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "update-allow-advertise-on-public" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/validate_rules": { "post": { "summary": "Validate Rules.", "description": "ValidateRules returns whether the value is valid or not for the specified validator rules.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.ValidateRules", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceValidateRulesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceValidateRulesReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.ValidateRules", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Validate-rule resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "validate-rule" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "validate-rule" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.name}": { "put": { "summary": "Replace Namespace.", "description": "Replaces attributes of a namespace including its metadata like labels, description etc.", "operationId": "ves.io.schema.namespace.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "namespace" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "namespace" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/active_alert_policies": { "get": { "summary": "GET Active Alert Policies.", "description": "GetActiveAlertPolicies returns the list of active alert policies for the namespace.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.GetActiveAlertPolicies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceGetActiveAlertPoliciesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.GetActiveAlertPolicies", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 161.56, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 161.56, "p95_ms": 323.12, "p99_ms": 484.68, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "post": { "summary": "Set Active Alert Policies.", "description": "SetActiveAlertPolicies sets the active alert policies for the namespace\nAn empty list in the request will clear the active alert policies for the namespace.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.SetActiveAlertPolicies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetActiveAlertPoliciesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetActiveAlertPoliciesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.SetActiveAlertPolicies", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Active-alert-policie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "active-alert-policie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "active-alert-policie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/active_network_policies": { "get": { "summary": "GET Active Network Policies.", "description": "GetActiveNetworkPolicies return the list of active network policies for the namespace.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.GetActiveNetworkPolicies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceGetActiveNetworkPoliciesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.GetActiveNetworkPolicies", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Set Active Network Policies.", "description": "SetActiveNetworkPolicies sets the active network policies for the namespace\nAn empty list in the request will clear the active network policies for the namespace.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.SetActiveNetworkPolicies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetActiveNetworkPoliciesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetActiveNetworkPoliciesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.SetActiveNetworkPolicies", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Active-network-policie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "active-network-policie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "active-network-policie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/active_service_policies": { "get": { "summary": "GET Active Service Policies.", "description": "GetActiveServicePolicies return the list of active service policies for the namespace.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.GetActiveServicePolicies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceGetActiveServicePoliciesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.GetActiveServicePolicies", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Set Active Service Policies.", "description": "SetActiveServicePolicies sets the active service policies for the namespace\nAn empty list in the request will clear the active service policies for the namespace.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.SetActiveServicePolicies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetActiveServicePoliciesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetActiveServicePoliciesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.SetActiveServicePolicies", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Active-service-policie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "active-service-policie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "active-service-policie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/ml/data/namespaces/{namespace}/api_endpoints/stats": { "post": { "summary": "GET API Endpoints Stats for Namespace.", "description": "GET API endpoints stats for the given Namespace.", "operationId": "ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStats", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceApiEndpointsStatsNSRsp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace of the App type for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "shared" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceApiEndpointsStatsNSReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStats", "tags": [ "ml" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Stat resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "stat" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "stat" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceMLCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/application_inventory": { "post": { "summary": "Application Objects Inventory.", "description": "ApplicationInventory returns inventory of configured application related objects for the tenant.\nInventory of namespaced objects (HTTP LBs, TCP LBs, etc) in a particular namespace is returned.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.ApplicationInventory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceApplicationInventoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceApplicationInventoryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.ApplicationInventory", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Application-inventory resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "application-inventory" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "application-inventory" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/dynamic-data": { "post": { "summary": "Dynamic Data.", "description": "DynamicData returns data that should be populated in a table.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.DynamicData", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceDynamicDataResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nNamespace in which the data is scoped.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceDynamicDataReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.DynamicData", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dynamic-data resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dynamic-data" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "dynamic-data" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/fast_acls_for_internet_vips": { "get": { "summary": "GET FastACLs For Internet VIPs.", "description": "GetFastACLsForInternetVIPs Returns the list of Active FastACLs for Internet VIPs.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.GetFastACLsForInternetVIPs", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceGetFastACLsForInternetVIPsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.GetFastACLsForInternetVIPs", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 154.74, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 154.74, "p95_ms": 309.48, "p99_ms": 464.22, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "post": { "summary": "Set FastACLs For Internet VIPs.", "description": "SetFastACLsForInternetVIPs activates the passed list of FastACLs for Internet VIPs.\nAn empty list in the request will clear FastACLs for Internet VIPs.", "operationId": "ves.io.schema.namespace.NamespaceCustomAPI.SetFastACLsForInternetVIPs", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetFastACLsForInternetVIPsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSetFastACLsForInternetVIPsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.NamespaceCustomAPI.SetFastACLsForInternetVIPs", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Fast-acls-for-internet-vip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "fast-acls-for-internet-vip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "fast-acls-for-internet-vip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.NamespaceCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{namespace}/suggest-values": { "post": { "summary": "Suggest Values.", "description": "SuggestValues returns suggested values for the specified field in the given Create/Replace/Custom request.", "operationId": "ves.io.schema.namespace.CustomAPI.SuggestValues", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemanamespaceSuggestValuesResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the suggestions are scoped.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "foobar" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceSuggestValuesReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.CustomAPI.SuggestValues", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Suggest-value resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "suggest-value" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "suggest-value" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{name}": { "get": { "summary": "GET Namespace.", "description": "This is the read representation of the namespace object.", "operationId": "ves.io.schema.namespace.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "namespace", "description": "The namespace in which the configuration object is present.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{name}/cascade_delete": { "post": { "summary": "Cascade DELETE.", "description": "CascadeDelete will DELETE the namespace and all configuration objects like virtual_hosts etc.\nUnder it. Use this only if the entire namespace and its contents are to be wiped out.", "operationId": "ves.io.schema.namespace.CustomAPI.CascadeDelete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceCascadeDeleteResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\nThe name of the namespace.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespaceCascadeDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace.CustomAPI.CascadeDelete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Cascade-delete resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cascade-delete" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "cascade-delete" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace", "x-ves-proto-service": "ves.io.schema.namespace.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{namespace}/namespace_roles": { "get": { "summary": "List Namespace Role.", "description": "List the set of namespace_role in a namespace.", "operationId": "ves.io.schema.namespace_role.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespace_roleListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of namespace_role.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace_role.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace Role.", "x-ves-proto-service": "ves.io.schema.namespace_role.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/namespace_roles/{name}": { "get": { "summary": "GET Namespace Role.", "description": "Allows listing a role of a user in a namespace.", "operationId": "ves.io.schema.namespace_role.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/namespace_roleGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.namespace_role.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Namespace Role.", "x-ves-proto-service": "ves.io.schema.namespace_role.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/rbac_policys": { "get": { "summary": "List RBAC Policy.", "description": "List the set of rbac_policy in a namespace.", "operationId": "ves.io.schema.rbac_policy.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rbac_policyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of rbac_policy.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.rbac_policy.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "RBAC Policy.", "x-ves-proto-service": "ves.io.schema.rbac_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/rbac_policys/{name}": { "get": { "summary": "GET RBAC Policy.", "description": "GET rbac_policy reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.rbac_policy.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rbac_policyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.rbac_policy.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "RBAC Policy.", "x-ves-proto-service": "ves.io.schema.rbac_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/roles": { "get": { "summary": "Custom List Roles.", "description": "List the Role objects with all API groups which the role can access to.", "operationId": "ves.io.schema.role.CustomAPI.CustomList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleCustomListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the roles to be retrieved.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.CustomAPI.CustomList", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Custom Create Role.", "description": "Create a role object and the rbac_policy object which the role associated with.", "operationId": "ves.io.schema.role.CustomAPI.CustomCreate", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleObject" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleCustomCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.CustomAPI.CustomCreate", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Role resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Role", "x-ves-proto-service": "ves.io.schema.role.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/roles/{name}": { "get": { "summary": "Custom GET Role.", "description": "GET the Role objects with all API groups which the role can access to.", "operationId": "ves.io.schema.role.CustomAPI.CustomGet", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleCustomGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the role to be retrieved.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the role.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.CustomAPI.CustomGet", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Custom Replace Role.", "description": "Update the role object with new API groups.", "operationId": "ves.io.schema.role.CustomAPI.CustomReplace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleObject" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the role.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleCustomReplaceRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.role.CustomAPI.CustomReplace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Role", "x-ves-proto-service": "ves.io.schema.role.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/roles": { "post": { "summary": "Create Role.", "description": "Creates a role.", "operationId": "ves.io.schema.role.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Role resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Role", "x-ves-proto-service": "ves.io.schema.role.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/roles/{metadata.name}": { "put": { "summary": "Replace Role.", "description": "Amends a role.", "operationId": "ves.io.schema.role.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Role", "x-ves-proto-service": "ves.io.schema.role.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/roles": { "get": { "summary": "List Role", "description": "List the set of role in a namespace.", "operationId": "ves.io.schema.role.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of role.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Role", "x-ves-proto-service": "ves.io.schema.role.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/roles/{name}": { "get": { "summary": "GET Role", "description": "Reads a role.", "operationId": "ves.io.schema.role.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Role.", "description": "DELETE the specified role.", "operationId": "ves.io.schema.role.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/roleDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.role.API.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "role", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "role", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Role", "x-ves-proto-service": "ves.io.schema.role.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/oidc_provider/{name}": { "get": { "summary": "GET", "description": "GET implements OIDC provider query by name.\nReturns OIDC provider object. Query will look into current tenants `system` namespace for OIDC provider by name.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.Get_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaoidc_providerGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of OIDC provider object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "SSO/OIDC Provider.", "x-ves-proto-service": "ves.io.schema.oidc_provider.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/oidc_provider/{name}/delete": { "post": { "summary": "DELETE", "description": "DELETE deletes OIDC provider by name. This would also disable SCIM integration for the tenant, if at all, it was enabled.\nReturns OIDC provider object that gets deleted. Query will look into current tenants `system` namespace for OIDC provider by name.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.Delete_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerDeleteResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of OIDC provider object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaoidc_providerDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Delete resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "delete" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "delete" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "SSO/OIDC Provider.", "x-ves-proto-service": "ves.io.schema.oidc_provider.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/oidc_providers": { "get": { "summary": "List", "description": "List implements OIDC provider query.\nReturns list of OIDC provider of all types. Query will look into current tenants `system` namespace.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaoidc_providerListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create", "description": "Create creates an OIDC provider in F5XC Identity.\nCurrently we support creating provider for brokering Google identity provider and\nany generic OIDC provider that support OpenID Connect protocol V1.0.\nTo configure type Google (provider_type 1), user is not required to provide well-known URL\ndetails as its already pre-configured. Parameters such as client ID, client secret and additional\noptional parameters as specified in the create schema needs to be provided.\nTo configure default type (provider_type 0), user needs to provide well-known URLs and additional\nfields as required part of create schema.\nCheck create response section for the details on action that needs to be taken POST\nsending a successful create request.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaoidc_providerCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaoidc_providerCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Oidc-provider resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "oidc-provider" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "oidc-provider" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "SSO/OIDC Provider.", "x-ves-proto-service": "ves.io.schema.oidc_provider.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}": { "get": { "summary": "GET", "description": "GET implements OIDC provider query by name.\nReturns OIDC provider object. Query will look into current tenants `system` namespace for OIDC provider by name.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.Get_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaoidc_providerGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of OIDC provider object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Replace", "description": "Replace updates OIDC provider parameters for a given provider instance.\nSince we never store client secret, any time this operation is performed,\nuser will need to input the original/new client secret along with other existing\nfields as delta operations is not supported.\n\n`NOTE`: Operations performed via API client is encouraged to issue a detail GET on the current\noidc_provider resource to retrieve all configured fields and this can be used in constructing payload\nfor the update operation. Params which are not sent as part of replace operation will GET removed/unset\nif those params were configured prior to this operation. So its important that replace operation payload\nneeds to have complete fields with their values as required in your final configuration.\nFor example: admin needs to update client secret of an existing SSO configuration - first issue detail GET on the\ncurrent oidc_provider resource, use all of the fields in `spec.gc_spec` from response and construct the replace\nrequest spec. Now update only client_secret field with the new value as required and send request.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.Replace_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of the oidc_provider object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "google" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Oidc-provider resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "oidc-provider" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "oidc-provider" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Replace", "description": "Replace updates OIDC provider parameters for a given provider instance.\nSince we never store client secret, any time this operation is performed,\nuser will need to input the original/new client secret along with other existing\nfields as delta operations is not supported.\n\n`NOTE`: Operations performed via API client is encouraged to issue a detail GET on the current\noidc_provider resource to retrieve all configured fields and this can be used in constructing payload\nfor the update operation. Params which are not sent as part of replace operation will GET removed/unset\nif those params were configured prior to this operation. So its important that replace operation payload\nneeds to have complete fields with their values as required in your final configuration.\nFor example: admin needs to update client secret of an existing SSO configuration - first issue detail GET on the\ncurrent oidc_provider resource, use all of the fields in `spec.gc_spec` from response and construct the replace\nrequest spec. Now update only client_secret field with the new value as required and send request.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.Replace_put", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of the oidc_provider object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "google" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "oidc-provider" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "oidc-provider" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "SSO/OIDC Provider.", "x-ves-proto-service": "ves.io.schema.oidc_provider.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/delete": { "post": { "summary": "DELETE", "description": "DELETE deletes OIDC provider by name. This would also disable SCIM integration for the tenant, if at all, it was enabled.\nReturns OIDC provider object that gets deleted. Query will look into current tenants `system` namespace for OIDC provider by name.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.Delete_post_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerDeleteResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of OIDC provider object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaoidc_providerDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Delete resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "delete" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "delete" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "SSO/OIDC Provider.", "x-ves-proto-service": "ves.io.schema.oidc_provider.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers": { "get": { "summary": "GET OIDC mappers.", "description": "GET OIDC mappers gets OIDC mappers from underlying IDM provider.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.GetOIDCMappers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerOIDCMappers" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace contains namespace of OIDC provider. Namespace should be system.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "OIDC provider name\nName contains name/alias of underlying OIDC provider.", "in": "path", "required": true, "x-displayname": "OIDC provider name.", "schema": { "type": "string" }, "x-f5xc-example": "[oidc, google, azure-oidc]" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.GetOIDCMappers", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Update OIDC mappers.", "description": "Update OIDC mappers updates OIDC mappers in underlying IDM provider.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.UpdateOIDCMappers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace contains namespace of OIDC provider. Namespace should be system.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "OIDC provider name\nName contains name/alias of underlying OIDC provider.", "in": "path", "required": true, "x-displayname": "OIDC provider name.", "schema": { "type": "string" }, "x-f5xc-example": "[oidc, google, azure-oidc]" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerUpdateOIDCMappersRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.UpdateOIDCMappers", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Mapper resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "mapper" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "mapper" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "SSO/OIDC Provider.", "x-ves-proto-service": "ves.io.schema.oidc_provider.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/scim": { "put": { "summary": "Update OIDC provider SCIM Integration.", "description": "Enables / Disables the SCIM integration for the OIDC provider.", "operationId": "ves.io.schema.oidc_provider.CustomAPI.UpdateScimIntegration", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerUpdateScimIntegrationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSupports only system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of OIDC provider object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oidc_providerUpdateScimIntegrationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.oidc_provider.CustomAPI.UpdateScimIntegration", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "scim" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "scim" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "SSO/OIDC Provider.", "x-ves-proto-service": "ves.io.schema.oidc_provider.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/countries/{country_code}/states/{prefix}": { "get": { "summary": "List states.", "description": "Returns a list of known states of a country. List will be empty if country has no states.", "operationId": "ves.io.schema.signup.CustomAPI.ListStates_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupListStatesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "country_code", "description": "Country code\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`", "in": "path", "required": true, "x-displayname": "Country code.", "schema": { "type": "string" }, "x-f5xc-example": "US" }, { "name": "prefix", "description": "Prefix\nfirst two or more characters of the state you look for (can be upper or lower case)", "in": "path", "required": true, "x-displayname": "Prefix", "schema": { "type": "string" }, "x-f5xc-example": "AL for Alabama" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ListStates", "tags": [ "countries" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.country_code", "path.prefix" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.country_code", "path.prefix" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/countries/{country_code}/states/{state_code}/cities/{prefix}": { "get": { "summary": "List cities.", "description": "Returns a list of known cities of a country/state.", "operationId": "ves.io.schema.signup.CustomAPI.ListCities_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupListCitiesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "country_code", "description": "Country code\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`", "in": "path", "required": true, "x-displayname": "Country code.", "schema": { "type": "string" }, "x-f5xc-example": "US" }, { "name": "state_code", "description": "State code\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column `code`, excluding the leading country code.", "in": "path", "required": true, "x-displayname": "State", "schema": { "type": "string" }, "x-f5xc-example": "TN" }, { "name": "prefix", "description": "Prefix\nfirst two or more characters of the city you look for (can be upper or lower case)", "in": "path", "required": true, "x-displayname": "Prefix", "schema": { "type": "string" }, "x-f5xc-example": "DE" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ListCities", "tags": [ "countries" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.country_code", "path.prefix", "path.state_code" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.country_code", "path.prefix", "path.state_code" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/countries/{prefix}": { "get": { "summary": "List countries.", "description": "Returns a list of supported countries along with with additional information such as address validation rules.", "operationId": "ves.io.schema.signup.CustomAPI.ListCountries_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupListCountriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "prefix", "description": "Prefix\nfirst two or more characters of the country you look for (can be upper or lower case)", "in": "path", "required": true, "x-displayname": "Prefix", "schema": { "type": "string" }, "x-f5xc-example": "US for USA" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ListCountries", "tags": [ "countries" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.prefix" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.prefix" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/login/validate_registration": { "post": { "summary": "Validate Registration.", "description": "ValidateRegistration validates if the signup registration request is valid when a new customer attempts to signup.", "operationId": "ves.io.schema.signup.CustomAPI.ValidateRegistration", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupValidateRegistrationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupValidateRegistrationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ValidateRegistration", "tags": [ "login" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Validate-registration resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "validate-registration" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "validate-registration" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/send_password_email": { "post": { "summary": "Send Password Email.", "description": "SendPasswordEmail enables resetting the password at the time of on-boarding new customer.", "operationId": "ves.io.schema.signup.CustomAPI.SendPasswordEmail", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupSendPasswordEmailResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupSendPasswordEmailRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.SendPasswordEmail", "tags": [ "send_password_email" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Send-password-email resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "send-password-email" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "send-password-email" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/signup/{name}": { "get": { "summary": "Read Signup.", "description": "GET allows users to query signup and its status. Use this to query for a status of a submitted signup object.", "operationId": "ves.io.schema.signup.CustomAPI.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Signup name\nName of the signup we want to retrieve . The name is returned after a signup object submission.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "signup-1234-5678-9012-3456" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.Get", "tags": [ "signup" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/validate_contact": { "post": { "summary": "Validate contact.", "description": "It validates that:\n* the provided country and zip code are not empty\n* the provided country is in the configured list of countries\n* a provided zip code matches a regexp for a given country.", "operationId": "ves.io.schema.signup.CustomAPI.ValidateContact", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupValidateContactResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupValidateContactRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ValidateContact", "tags": [ "validate_contact" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Validate-contact resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "validate-contact" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "validate-contact" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/countries/{country_code}/states/{prefix}": { "get": { "summary": "List states.", "description": "Returns a list of known states of a country. List will be empty if country has no states.", "operationId": "ves.io.schema.signup.CustomAPI.ListStates_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupListStatesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "country_code", "description": "Country code\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`", "in": "path", "required": true, "x-displayname": "Country code.", "schema": { "type": "string" }, "x-f5xc-example": "US" }, { "name": "prefix", "description": "Prefix\nfirst two or more characters of the state you look for (can be upper or lower case)", "in": "path", "required": true, "x-displayname": "Prefix", "schema": { "type": "string" }, "x-f5xc-example": "AL for Alabama" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ListStates", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.country_code", "path.prefix" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.country_code", "path.prefix" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/countries/{country_code}/states/{state_code}/cities/{prefix}": { "get": { "summary": "List cities.", "description": "Returns a list of known cities of a country/state.", "operationId": "ves.io.schema.signup.CustomAPI.ListCities_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupListCitiesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "country_code", "description": "Country code\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`", "in": "path", "required": true, "x-displayname": "Country code.", "schema": { "type": "string" }, "x-f5xc-example": "US" }, { "name": "state_code", "description": "State code\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column `code`, excluding the leading country code.", "in": "path", "required": true, "x-displayname": "State", "schema": { "type": "string" }, "x-f5xc-example": "TN" }, { "name": "prefix", "description": "Prefix\nfirst two or more characters of the city you look for (can be upper or lower case)", "in": "path", "required": true, "x-displayname": "Prefix", "schema": { "type": "string" }, "x-f5xc-example": "DE" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ListCities", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.country_code", "path.prefix", "path.state_code" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.country_code", "path.prefix", "path.state_code" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/countries/{prefix}": { "get": { "summary": "List countries.", "description": "Returns a list of supported countries along with with additional information such as address validation rules.", "operationId": "ves.io.schema.signup.CustomAPI.ListCountries_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signupListCountriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "prefix", "description": "Prefix\nfirst two or more characters of the country you look for (can be upper or lower case)", "in": "path", "required": true, "x-displayname": "Prefix", "schema": { "type": "string" }, "x-f5xc-example": "US for USA" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.signup.CustomAPI.ListCountries", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.prefix" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.prefix" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Signup", "x-ves-proto-service": "ves.io.schema.signup.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/Groups": { "get": { "summary": "List group based on filters.", "description": "List groups based on the given filter.", "operationId": "ves.io.schema.scim.CustomPublicAPI.ListGroups", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimListGroupResources" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "filter", "description": "Filter to be used for filtering objects.", "in": "query", "required": false, "x-displayname": "Filter", "schema": { "type": "string" }, "x-f5xc-example": "externalId" }, { "name": "count", "description": "The number of entries after filter.", "in": "query", "required": false, "x-displayname": "Count", "schema": { "type": "string", "format": "uint64" }, "x-f5xc-example": "8" }, { "name": "page", "description": "Start offset.", "in": "query", "required": false, "x-displayname": "Page", "schema": { "type": "string", "format": "uint64" }, "x-f5xc-example": "1" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.ListGroups", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create group with users.", "description": "Create group with given users.", "operationId": "ves.io.schema.scim.CustomPublicAPI.CreateGroup", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimGroup" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimCreateGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.CreateGroup", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Group resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "Group" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "Group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/Groups/{id}": { "get": { "summary": "List group based on ID.", "description": "List group based on the given ID.", "operationId": "ves.io.schema.scim.CustomPublicAPI.GetGroupById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimGroup" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nID with which the request will find entry.", "in": "path", "required": true, "x-displayname": "Email", "schema": { "type": "string" }, "x-f5xc-example": "dana@example.com" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.GetGroupById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE group based on ID.", "description": "DELETE group based on the given ID.", "operationId": "ves.io.schema.scim.CustomPublicAPI.DeleteGroupById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nID with which the request will find entry.", "in": "path", "required": true, "x-displayname": "Email", "schema": { "type": "string" }, "x-f5xc-example": "dana@example.com" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.DeleteGroupById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "Group", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "Group", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Replace group based on ID.", "description": "Replace group based on the given ID.", "operationId": "ves.io.schema.scim.CustomPublicAPI.ReplaceGroupById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimGroup" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nunique ID for the group.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimGroup" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.ReplaceGroupById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "Group" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "Group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "patch": { "summary": "PATCH group based on ID.", "description": "PATCH group based on the given ID.", "operationId": "ves.io.schema.scim.CustomPublicAPI.PatchGroupById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimGroup" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nunique ID for the group.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimPatchGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.PatchGroupById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource modification operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "Group" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "Group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/ResourceTypes": { "get": { "summary": "GET supported resources type.", "operationId": "ves.io.schema.scim.CustomPublicAPI.ListResourceTypes", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimResourceTypesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.ListResourceTypes", "tags": [ "scim" ], "description": "ListResourceTypes ResourceTypes.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/ResourceTypes/{id}": { "get": { "summary": "GET supported resources type.", "operationId": "ves.io.schema.scim.CustomPublicAPI.GetResourceTypesById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimResource" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nID with which the request will find entry.", "in": "path", "required": true, "x-displayname": "Email", "schema": { "type": "string" }, "x-f5xc-example": "dana@example.com" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.GetResourceTypesById", "tags": [ "scim" ], "description": "GetResourceTypesById ResourceTypes.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/Schemas": { "get": { "summary": "Schemas", "operationId": "ves.io.schema.scim.CustomPublicAPI.ListSchemas", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.ListSchemas", "tags": [ "scim" ], "description": "ListSchemas Schemas.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/Schemas/{id}": { "get": { "summary": "Schemas By ID.", "operationId": "ves.io.schema.scim.CustomPublicAPI.GetSchemaById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nID with which the request will find entry.", "in": "path", "required": true, "x-displayname": "Email", "schema": { "type": "string" }, "x-f5xc-example": "dana@example.com" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.GetSchemaById", "tags": [ "scim" ], "description": "GetSchemaById Schemas.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/ServiceProviderConfig": { "get": { "summary": "List service provider configs.", "operationId": "ves.io.schema.scim.CustomPublicAPI.ListServiceProviderConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimServiceProviderConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.ListServiceProviderConfig", "tags": [ "scim" ], "description": "ListServiceProviderConfig ServiceProviderConfig.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/Users": { "get": { "summary": "GET all users.", "description": "GET all users.", "operationId": "ves.io.schema.scim.CustomPublicAPI.ListUsers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimListUserResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "filter", "description": "Filter to be used for filtering objects.", "in": "query", "required": false, "x-displayname": "Filter", "schema": { "type": "string" }, "x-f5xc-example": "externalId" }, { "name": "count", "description": "The number of entries after filter.", "in": "query", "required": false, "x-displayname": "Count", "schema": { "type": "string", "format": "uint64" }, "x-f5xc-example": "8" }, { "name": "page", "description": "Start offset.", "in": "query", "required": false, "x-displayname": "Page", "schema": { "type": "string", "format": "uint64" }, "x-f5xc-example": "1" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.ListUsers", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create User with Role Assignment.", "description": "Create creates a user and namespace roles binding for this user.", "operationId": "ves.io.schema.scim.CustomPublicAPI.CreateUser", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimUser" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimCreateUserRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.CreateUser", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "User resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "User" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "User" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/scim/namespaces/system/v2/Users/{id}": { "get": { "summary": "GET User with ID.", "description": "GET user by means of ID.", "operationId": "ves.io.schema.scim.CustomPublicAPI.GetUserById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimUser" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nID with which the request will find entry.", "in": "path", "required": true, "x-displayname": "Email", "schema": { "type": "string" }, "x-f5xc-example": "dana@example.com" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.GetUserById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE user by ID.", "description": "DELETE user by ID.", "operationId": "ves.io.schema.scim.CustomPublicAPI.DeleteUserById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nID with which the request will find entry.", "in": "path", "required": true, "x-displayname": "Email", "schema": { "type": "string" }, "x-f5xc-example": "dana@example.com" }, { "name": "excludedAttributes", "description": "Members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.", "in": "query", "required": false, "x-displayname": "ExcludedAttributes.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "[" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.DeleteUserById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "User", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "User", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Update User and Role Assignments.", "description": "Replace updates user and namespace roles for this user.", "operationId": "ves.io.schema.scim.CustomPublicAPI.ReplaceUserById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimUser" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\n\nx-required\nID for user object.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "123-456-789012" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimUser" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.ReplaceUserById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "User" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "User" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "patch": { "summary": "PATCH User.", "description": "PATCH patches the fields for this user.", "operationId": "ves.io.schema.scim.CustomPublicAPI.PatchUserById", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimUser" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\n\nx-example: \"\"ID\": \"1234-5678-901234\"\"\nx-required\nID of the user object that needs patching.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scimPatchUserRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.scim.CustomPublicAPI.PatchUserById", "tags": [ "scim" ], "x-f5xc-operation-metadata": { "purpose": "Resource modification operation", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "User" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "User" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "System for Cross-domain Identity Management (SCIM)", "x-ves-proto-service": "ves.io.schema.scim.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/cname/lookup": { "get": { "summary": "Lookup cname.", "description": "Checks if a cname is available.", "operationId": "ves.io.schema.tenant.CustomAPI.LookupCname_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "cname", "description": "Cname to look-uo.", "in": "query", "required": false, "x-displayname": "Cname", "schema": { "type": "string" }, "x-f5xc-example": "domain1" }, { "name": "namespace", "description": "Namespace to query.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.LookupCname", "tags": [ "cname" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/no_auth/tenant/idm/settings/password_policy": { "get": { "summary": "GetPasswordPolicy.", "description": "GetPasswordPolicy returns password policy for tenant.", "operationId": "ves.io.schema.tenant.CustomAPI.GetPasswordPolicy", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantPasswordPolicyPublicAccess" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "realm_id", "description": "User's email.", "in": "query", "required": false, "x-displayname": "Email", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-dfd2e37f3c73" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetPasswordPolicy", "tags": [ "tenant" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/domain_owner/assign": { "post": { "summary": "Assign domain owner.", "description": "Assign domain owner tries to assign domain owner to user in the request. It checks that requester is domain owner as well.\nIt implies such steps:\n1) mark user as domain owner\n2) if user is SSO\n- mark user as F5 Distributed Cloud managed\n- send update password email\n3) set admin roles in system, shared, * namespaces\nNOTE: previous roles (which was explicitly assigned to this user) will be deleted.", "operationId": "ves.io.schema.tenant.CustomAPI.AssignDomainOwner", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantAssignDomainOwnerRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.AssignDomainOwner", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Assign resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "assign" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "assign" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/domain_owner/unassign": { "post": { "summary": "Unassign domain owner.", "description": "Unassign domain owner tries to remove domain owner privilege from user in the request.\nIt checks that requester is domain owner.\nIt implies such steps:\n1) remove domain owner boolean flag\n2) if tenant has SSO enabled:\n- mark user as SSO\n- DELETE password credential\n- DELETE OTP credential (if exists)\nNOTE: previously granted roles (including admin roles) will be retained.", "operationId": "ves.io.schema.tenant.CustomAPI.UnassignDomainOwner", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantUnassignDomainOwnerRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.UnassignDomainOwner", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unassign resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unassign" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unassign" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/idm/events/last_login": { "get": { "summary": "GetLastLoginMap.", "description": "GetLastLoginMap returns last login timestamp for each user within a tenant.", "operationId": "ves.io.schema.tenant.CustomAPI.GetLastLoginMap", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantLastLoginMap" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetLastLoginMap", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/idm/events/login": { "get": { "summary": "GetLoginEvents.", "description": "GetLoginEvents returns login events for specified in config period of time. It consider all users within current tenant.\nLogin events are extracted directly from IDM.", "operationId": "ves.io.schema.tenant.CustomAPI.GetLoginEvents", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantLoginEventsMap" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "first", "description": "Start offset.", "in": "query", "required": false, "x-displayname": "First", "schema": { "type": "integer", "format": "int64" }, "x-f5xc-example": "100" }, { "name": "max", "description": "Records per page.", "in": "query", "required": false, "x-displayname": "Max", "schema": { "type": "integer", "format": "int64" }, "x-f5xc-example": "25" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetLoginEvents", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/idm/events/login_in_time": { "post": { "summary": "GetLoginEventsInTimeFrame.", "description": "GetLoginEventsInTimeFrame returns login events for specified period of time. It consider all users specified by context tenant.", "operationId": "ves.io.schema.tenant.CustomAPI.GetLoginEventsInTimeFrame", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantLoginEventsMap" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantGetLoginEventsInTimeFrameRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetLoginEventsInTimeFrame", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Login-in-time resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "login-in-time" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "login-in-time" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/idm/settings": { "get": { "summary": "GetIDMSettings.", "description": "GetIDMSettings returns IDM settings for tenant. IDM settings contains info like password policy,\nbrute-force detection policy, etc...", "operationId": "ves.io.schema.tenant.CustomAPI.GetIDMSettings", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewstenant_configurationGlobalSpecType" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetIDMSettings", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "UpdateIDMSettings.", "description": "UpdateIDMSettings allows to adjust IDM settings for tenant, like password policy, brute-force detection policy, etc...", "operationId": "ves.io.schema.tenant.CustomAPI.UpdateIDMSettings", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewstenant_configurationGlobalSpecType" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.UpdateIDMSettings", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "setting" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "setting" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/idm/users/inactive": { "get": { "summary": "ListInactiveUsers.", "description": "Returns list of users for which no login events was found for last 90 days of time.\nIt consider all users within current tenant.", "operationId": "ves.io.schema.tenant.CustomAPI.ListInactiveUsers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantUserList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.ListInactiveUsers", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/lookup": { "get": { "summary": "Lookup cname.", "description": "Checks if a cname is available.", "operationId": "ves.io.schema.tenant.CustomAPI.LookupCname_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "cname", "description": "Cname to look-uo.", "in": "query", "required": false, "x-displayname": "Cname", "schema": { "type": "string" }, "x-f5xc-example": "domain1" }, { "name": "namespace", "description": "Namespace to query.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.LookupCname", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/request-delete": { "post": { "summary": "DELETE Tenant.", "description": "Request to mark Tenant for deletion queue, after approve it will completely removed from the system.", "operationId": "ves.io.schema.tenant.CustomAPI.DeleteTenant", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantDeleteTenantRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.DeleteTenant", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Request-delete resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "request-delete" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "request-delete" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/settings": { "get": { "summary": "Tenant Settings.", "description": "Receive current tenant settings.", "operationId": "ves.io.schema.tenant.CustomAPI.GetTenantSettings", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantTenantSettingsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetTenantSettings", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Tenant Settings.", "description": "Tenant settings.", "operationId": "ves.io.schema.tenant.CustomAPI.UpdateTenantSettings", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantUpdateTenantSettingsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantUpdateTenantSettingsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.UpdateTenantSettings", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "setting" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "setting" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/settings/otp/disable": { "put": { "summary": "Disable tenant level OTP.", "description": "Disable tenant level OTP disables OTP on tenant-level. After it's disabled it's up to user whether to enable OTP.", "operationId": "ves.io.schema.tenant.CustomAPI.DisableTenantLevelOTP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.DisableTenantLevelOTP", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "disable" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "disable" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/settings/otp/enable": { "put": { "summary": "Enable tenant level OTP.", "description": "Enable tenant level OTP enables OTP on tenant-level. It enforces each user within a tenant to enable OTP.", "operationId": "ves.io.schema.tenant.CustomAPI.EnableTenantLevelOTP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.EnableTenantLevelOTP", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "enable" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "enable" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/settings/tenant/favicon": { "get": { "summary": "Tenant favicon.", "description": "Receive current tenant favicon.", "operationId": "ves.io.schema.tenant.CustomAPI.GetFavIcon_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetFavIcon", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/settings/tenant/image": { "get": { "summary": "Tenant profile image.", "description": "Receive current tenant profile image.", "operationId": "ves.io.schema.tenant.CustomAPI.GetImage_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetImage", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE tenant profile image.", "description": "DELETE profile image for the tenant entity.", "operationId": "ves.io.schema.tenant.CustomAPI.DeleteImage", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.DeleteImage", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "image", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "image", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Update tenant profile image.", "description": "Uploads new profile image for the tenant entity.", "operationId": "ves.io.schema.tenant.CustomAPI.UpdateImage", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schematenantEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantUpdateImageRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.UpdateImage", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "image" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "image" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/settings/tenant/logo": { "get": { "summary": "Tenant logo.", "description": "Receive current tenant logo.", "operationId": "ves.io.schema.tenant.CustomAPI.GetLogo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetLogo", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/support-info": { "get": { "summary": "Support Info.", "description": "Receive support information for tenant.", "operationId": "ves.io.schema.tenant.CustomAPI.GetSupportInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantSupportInfo" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetSupportInfo", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant/tenant-escalation-doc": { "get": { "summary": "Tenant escalation document.", "description": "Receive current tenant escalation document.", "operationId": "ves.io.schema.tenant.CustomAPI.GetTenantEscalationDoc", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetTenantEscalationDoc", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/saas/namespaces/system/v2/tenant/deactivate": { "put": { "summary": "DeactivateTenant.", "description": "This API mark tenant for deletion queue, after approve it will completely removed from the system. This API proxies the request to eywa’s tenant disable API.", "operationId": "ves.io.schema.tenant.CustomAPIEywaprime.DeactivateTenant", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantDeactivateTenantResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantDeactivateTenantRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPIEywaprime.DeactivateTenant", "tags": [ "saas" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "deactivate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "deactivate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPIEywaprime", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/static/namespaces/system/tenant/settings/tenant/favicon": { "get": { "summary": "Tenant favicon.", "description": "Receive current tenant favicon.", "operationId": "ves.io.schema.tenant.CustomAPI.GetFavIcon_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetFavIcon", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/static/namespaces/system/tenant/settings/tenant/image": { "get": { "summary": "Tenant profile image.", "description": "Receive current tenant profile image.", "operationId": "ves.io.schema.tenant.CustomAPI.GetImage_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.CustomAPI.GetImage", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/tenants/{tenant}/summary": { "get": { "summary": "Summary", "description": "This API returns tenant summary.", "operationId": "ves.io.schema.tenant.TenantSummaryCustomAPI.Summary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenantSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "tenant", "description": "Tenant ID\n\nTenant ID.", "in": "path", "required": true, "x-displayname": "Tenant ID", "schema": { "type": "string" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant.TenantSummaryCustomAPI.Summary", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.tenant" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.tenant" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant", "x-ves-proto-service": "ves.io.schema.tenant.TenantSummaryCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/tenant_configurations": { "post": { "summary": "Create tenant configuration.", "description": "Shape of the tenant configuration specification.", "operationId": "ves.io.schema.views.tenant_configuration.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_configurationCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_configurationCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.views.tenant_configuration.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Tenant-configuration resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "tenant-configuration" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "tenant-configuration" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Configuration.", "x-ves-proto-service": "ves.io.schema.views.tenant_configuration.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/tenant_configurations/{metadata.name}": { "put": { "summary": "Replace tenant configuration.", "description": "Shape of the tenant configuration specification.", "operationId": "ves.io.schema.views.tenant_configuration.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_configurationReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_configurationReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.views.tenant_configuration.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "tenant-configuration" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "tenant-configuration" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Configuration.", "x-ves-proto-service": "ves.io.schema.views.tenant_configuration.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/tenant_configurations": { "get": { "summary": "List Tenant Configuration.", "description": "List the set of tenant_configuration in a namespace.", "operationId": "ves.io.schema.views.tenant_configuration.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_configurationListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of tenant_configuration.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.views.tenant_configuration.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Configuration.", "x-ves-proto-service": "ves.io.schema.views.tenant_configuration.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/tenant_configurations/{name}": { "get": { "summary": "GET tenant configuration.", "description": "Shape of the tenant configuration specification.", "operationId": "ves.io.schema.views.tenant_configuration.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_configurationGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.views.tenant_configuration.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Tenant Configuration.", "description": "DELETE the specified tenant_configuration.", "operationId": "ves.io.schema.views.tenant_configuration.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_configurationDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.views.tenant_configuration.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "tenant-configuration", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "tenant-configuration", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Configuration.", "x-ves-proto-service": "ves.io.schema.views.tenant_configuration.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/system/tenant_management/delegated_access/subscribe": { "post": { "summary": "Subscribe Delegated Access Addon Service.", "description": "Subscribe Delegated Access addon service feature. A support request will be created and feature will be enabled upon approval.", "operationId": "ves.io.schema.tenant_management.CustomAPI.DelegatedAccessSubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSubscribeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementSubscribeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.CustomAPI.DelegatedAccessSubscribe", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Management.", "x-ves-proto-service": "ves.io.schema.tenant_management.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/tenant_management/delegated_access/unsubscribe": { "post": { "summary": "Unsubscribe Delegated Access Addon Service.", "description": "Unsubscribe Delegated Access addon service feature. A support request will be created and request will be processed upon approval.", "operationId": "ves.io.schema.tenant_management.CustomAPI.DelegatedAccessUnsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementUnsubscribeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_managementUnsubscribeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.CustomAPI.DelegatedAccessUnsubscribe", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Management.", "x-ves-proto-service": "ves.io.schema.tenant_management.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/tenant_profiles": { "post": { "summary": "Create Tenant Profile.", "description": "Creates a tenant_profile config instance. Name of the object is the name of the tenant profile to be created.", "operationId": "ves.io.schema.tenant_management.tenant_profile.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_profileCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_profileCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.tenant_profile.API.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Tenant-profile resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "tenant-profile" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "tenant-profile" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Profile.", "x-ves-proto-service": "ves.io.schema.tenant_management.tenant_profile.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{metadata.namespace}/tenant_profiles/{metadata.name}": { "put": { "summary": "Replace Tenant Profile.", "description": "Replaces attributes of a tenant_profile configuration.", "operationId": "ves.io.schema.tenant_management.tenant_profile.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_profileReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_profileReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.tenant_profile.API.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "tenant-profile" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "tenant-profile" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Profile.", "x-ves-proto-service": "ves.io.schema.tenant_management.tenant_profile.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/tenant_profiles": { "get": { "summary": "List Tenant Profile.", "description": "List the set of tenant_profile in a namespace.", "operationId": "ves.io.schema.tenant_management.tenant_profile.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_profileListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of tenant_profile.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.tenant_profile.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Profile.", "x-ves-proto-service": "ves.io.schema.tenant_management.tenant_profile.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/tenant_profiles/{name}": { "get": { "summary": "GET Tenant Profile.", "description": "GET tenant_profile reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.tenant_management.tenant_profile.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_profileGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.tenant_profile.API.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Tenant Profile.", "description": "DELETE the specified tenant_profile.", "operationId": "ves.io.schema.tenant_management.tenant_profile.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tenant_profileDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.tenant_management.tenant_profile.API.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "tenant-profile", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "tenant-profile", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tenant Profile.", "x-ves-proto-service": "ves.io.schema.tenant_management.tenant_profile.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/custom/idm/user/sync": { "post": { "summary": "Sync user", "description": "In case when user created initially from identity provider we need to sync the user data.", "operationId": "ves.io.schema.user.CustomAPI.SyncUser", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemauserEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemauserEmpty" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.SyncUser", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Sync resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "sync" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "sync" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/system/users/group_add": { "put": { "summary": "Add user to groups.", "description": "Assign existing user to specific groups.", "operationId": "ves.io.schema.user.CustomAPI.AddUserToGroup", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userUserGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userUserGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.AddUserToGroup", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "group-add" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "group-add" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/system/users/group_remove": { "put": { "summary": "Remove user from groups.", "description": "Remove existing user from specific groups.", "operationId": "ves.io.schema.user.CustomAPI.RemoveUserFromGroup", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userUserGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userUserGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.RemoveUserFromGroup", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "group-remove" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "group-remove" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/accept_tos": { "post": { "summary": "Accept TOS.", "description": "Accept TOS updates version of accepted terms of service.", "operationId": "ves.io.schema.user.CustomAPI.AcceptTOS", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userAcceptTOSResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nValue of namespace is always \"system\".", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userAcceptTOSRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.AcceptTOS", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Accept-to resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "accept-to" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "accept-to" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/role_users": { "post": { "summary": "Assign role to User.", "description": "AssignRole allows customers to assign a namespace/role pair to multiple users.", "operationId": "ves.io.schema.user.CustomAPI.AssignRole", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemauserEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace the requesting user is calling the action from.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userAssignRoleRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.AssignRole", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Role-user resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "role-user" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "role-user" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/send_password_email": { "post": { "summary": "Send Password Email.", "description": "SendPasswordEmail allows admin user to trigger send password email for a user to update user's password.\nDeprecated: use ResetPasswordByAdmin RPC instead.", "operationId": "ves.io.schema.user.CustomAPI.SendPasswordEmail", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userSendPasswordEmailResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nValue of namespace is always \"system\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userSendPasswordEmailRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.SendPasswordEmail", "tags": [ "web" ], "deprecated": true, "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Send-password-email resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "send-password-email" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "send-password-email" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/tos": { "get": { "summary": "GET TOS", "description": "GET TOS provides TOS version with text.", "operationId": "ves.io.schema.user.CustomAPI.GetTOS", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userGetTOSResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nValue of namespace is always \"system\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.GetTOS", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/user_roles": { "get": { "summary": "GET User and Role Assignments.", "description": "List enumerates users and their namespace roles for this tenant.", "operationId": "ves.io.schema.user.CustomAPI.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userListUserRoleResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to use.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create User with Role Assignment.", "description": "Create creates a user and namespace roles binding for this user.", "operationId": "ves.io.schema.user.CustomAPI.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userObject" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nAll users of a tenant must be created in tenant's system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userUserRoleRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "User-role resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "user-role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "user-role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Update User and Role Assignments.", "description": "Replace updates user and namespace roles for this user.", "operationId": "ves.io.schema.user.CustomAPI.Replace_put", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userObject" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nAll users of a tenant must be created in tenant's system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userUserRoleRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "user-role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "user-role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/user_roles/{name}": { "post": { "summary": "Update User and Role Assignments.", "description": "Replace updates user and namespace roles for this user.", "operationId": "ves.io.schema.user.CustomAPI.Replace_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userObject" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nAll users of a tenant must be created in tenant's system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Username\nThis is an optional field meant to be used as username.\nInside F5 Distributed Cloud's UAM, email is already treated as user's username\nand as best practice, recommendation is to keep this same as email field.\nIf not specified, this field will be set same as email field.", "in": "path", "required": true, "x-displayname": "Username", "schema": { "type": "string" }, "x-f5xc-example": "dana@example.com" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userUserRoleRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "User-role resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "user-role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "user-role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/users/cascade_delete": { "post": { "summary": "DELETE User and Related Objects.", "description": "CascadeDelete deletes the user and associated namespace roles for this user.\nUse this only if the user and its referenced objects need to be wiped out altogether.\nNote: users will always be in the system namespace.", "operationId": "ves.io.schema.user.CustomAPI.CascadeDelete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userCascadeDeleteResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nValue of namespace is always \"system\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userCascadeDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.CascadeDelete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Cascade-delete resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cascade-delete" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "cascade-delete" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/{namespace}/whoami": { "get": { "summary": "GET User Details.", "description": "GET fetches user information based on the username header from the request context\nthis API is also called as WhoAmI.", "operationId": "ves.io.schema.user.CustomAPI.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userGetUserRoleResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace of the user object (namespace where the user object is stored).", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/password/admin_reset": { "post": { "summary": "Reset password by admin.", "description": "Reset password by admin resets password for a user specified in request payload.\nThis request is meant to be executed by the tenant's admin.", "operationId": "ves.io.schema.user.CustomAPI.ResetPasswordByAdmin", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemauserEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userResetPasswordByAdminRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.ResetPasswordByAdmin", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Admin-reset resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "admin-reset" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "admin-reset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/password/reset": { "post": { "summary": "Reset password.", "description": "Reset password resets password for user who is making this request.", "operationId": "ves.io.schema.user.CustomAPI.ResetPassword", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemauserEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemauserEmpty" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.CustomAPI.ResetPassword", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Reset resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "reset" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "reset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User", "x-ves-proto-service": "ves.io.schema.user.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/system/user_groups": { "get": { "summary": "GET all User Groups for the tenant.", "description": "List fetches all the groups for the tenant.", "operationId": "ves.io.schema.user_group.CustomAPI.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupListUserGroupsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create User Group.", "description": "Create creates user group with users to be assigned.", "operationId": "ves.io.schema.user_group.CustomAPI.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupUserGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupUserGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.Create", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "User-group resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "user-group" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "user-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Group.", "x-ves-proto-service": "ves.io.schema.user_group.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/system/user_groups/analyze_for_deletion": { "post": { "summary": "Analyze For Deletion.", "description": "AnalyzeForDeletion checks the references of the object to make sure it is deletable.", "operationId": "ves.io.schema.user_group.CustomAPI.AnalyzeForDeletion", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupAnalyzeForDeletionResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupAnalyzeForDeletionRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.AnalyzeForDeletion", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Analyze-for-deletion resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "analyze-for-deletion" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "analyze-for-deletion" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Group.", "x-ves-proto-service": "ves.io.schema.user_group.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/system/user_groups/{name}": { "get": { "summary": "Fetch all the details for a group provided the group ID.", "description": "GET fetches all the details for a group, provided the group ID and the users list associated to the group.", "operationId": "ves.io.schema.user_group.CustomAPI.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupUserGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name of the user group\nname of the specific group.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-6a2fe61e3db8" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE a group provided the group ID.", "description": "DELETE deletes the group, provided the group ID and the users list association to the group\nIt also deletes associated namespace roles for this user.\nUse this only if the user group and its referenced objects need to be wiped out altogether.", "operationId": "ves.io.schema.user_group.CustomAPI.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemauser_groupEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name of the user group\nname of the specific group.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-6a2fe61e3db8" }, { "name": "attempt_remove_references", "description": "X-example: true\nAttemptRemoveReferences ignores the AT/MT configuration references, and\ncontinue with the deletion of the group if set as `true`, else it will return all the\nreferences in the error. But some references like MSP configurations cannot be ignored.", "in": "query", "required": false, "x-displayname": "AttemptRemoveReferences.", "schema": { "type": "boolean", "format": "boolean" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.Delete", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "user-group", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "user-group", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Replace the User Group fields / accesses / associations.", "description": "Replace allows updating of the different user group fields like the display name, description, user associations and RBAC accesses.\nThe name of the user group cannot be edited and the sync_id can be edited only when SCIM is enabled for the tenant.\nIf any of the editable fields are nil / empty in the request, it will be considered as the removal of the field value.", "operationId": "ves.io.schema.user_group.CustomAPI.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupUserGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\nInternal name of the group.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "sales" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupUserGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.Replace", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "user-group" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "user-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Group.", "x-ves-proto-service": "ves.io.schema.user_group.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/system/user_groups/{name}/assign_namespace_roles": { "put": { "summary": "Assign role to User Group.", "description": "AssignRole allows customers to assign a namespace/role pair to user group.", "operationId": "ves.io.schema.user_group.CustomAPI.AssignRole", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupUserGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name of the user group\nname of the specific group.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-6a2fe61e3db8" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupModifyRoleRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.AssignRole", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "assign-namespace-role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "assign-namespace-role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Group.", "x-ves-proto-service": "ves.io.schema.user_group.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/custom/namespaces/system/user_groups/{name}/remove_namespace_roles": { "put": { "summary": "Remove role from User Group.", "description": "RemoveRole allows customers to remove a namespace/role from the user group.", "operationId": "ves.io.schema.user_group.CustomAPI.RemoveRole", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupUserGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name of the user group\nname of the specific group.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-6a2fe61e3db8" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupModifyRoleRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.CustomAPI.RemoveRole", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource isolation and multi-tenancy boundary", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "remove-namespace-role" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "remove-namespace-role" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Group.", "x-ves-proto-service": "ves.io.schema.user_group.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/{namespace}/user_groups": { "get": { "summary": "List User Group.", "description": "List the set of user_group in a namespace.", "operationId": "ves.io.schema.user_group.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of user_group.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.API.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Group.", "x-ves-proto-service": "ves.io.schema.user_group.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/{namespace}/user_groups/{name}": { "get": { "summary": "GET User Group.", "operationId": "ves.io.schema.user_group.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_groupGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user_group.API.Get", "tags": [ "web" ], "description": "GET user_groups.", "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Group.", "x-ves-proto-service": "ves.io.schema.user_group.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/user_identifications": { "post": { "summary": "Create User Identification.", "description": "Create user_identification creates a new object in the storage backend for metadata.namespace.", "operationId": "ves.io.schema.user_identification.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_identificationCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_identificationCreateRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.user_identification.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "User-identification resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "user-identification" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "user-identification" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Identification.", "x-ves-proto-service": "ves.io.schema.user_identification.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/user_identifications/{metadata.name}": { "put": { "summary": "Replace User Identification.", "description": "Replace user_identification replaces an existing object in the storage backend for metadata.namespace.", "operationId": "ves.io.schema.user_identification.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_identificationReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_identificationReplaceRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.user_identification.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "user-identification" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "user-identification" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Identification.", "x-ves-proto-service": "ves.io.schema.user_identification.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/user_identifications": { "get": { "summary": "List User Identification.", "description": "List the set of user_identification in a namespace.", "operationId": "ves.io.schema.user_identification.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_identificationListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of user_identification.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "x-ves-proto-rpc": "ves.io.schema.user_identification.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 152.92, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 152.92, "p95_ms": 305.84, "p99_ms": 458.76, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "User Identification.", "x-ves-proto-service": "ves.io.schema.user_identification.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/user_identifications/{name}": { "get": { "summary": "GET User Identification.", "description": "GET user_identification reads a given object from storage backend for metadata.namespace.", "operationId": "ves.io.schema.user_identification.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_identificationGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "x-ves-proto-rpc": "ves.io.schema.user_identification.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE User Identification.", "description": "DELETE the specified user_identification.", "operationId": "ves.io.schema.user_identification.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_identificationDeleteRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.user_identification.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "User account for access management", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "user-identification", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "user-identification", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Identification.", "x-ves-proto-service": "ves.io.schema.user_identification.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/web/namespaces/system/user/admin_notifications": { "get": { "summary": "GET admin ntfn preferences.", "description": "GET admin ntfn preferences gets current admin notification preferences for user.\nIt combines information from two sources:\n- explicitly set admin notification preferences in user settings object\n- default values from uam config (for those notifications which not explicitly set)", "operationId": "ves.io.schema.user.setting.CustomAPI.GetAdminNtfnPreferences", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNotificationList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.GetAdminNtfnPreferences", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Update admin ntfn preferences.", "description": "Update admin ntfn preferences updates admin notification preferences for the user and store them in user settings object.", "operationId": "ves.io.schema.user.setting.CustomAPI.UpdateAdminNtfnPreferences", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNtfnPreferencesMap" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.UpdateAdminNtfnPreferences", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "admin-notification" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "admin-notification" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/admin_notifications/unset": { "put": { "summary": "Unset admin ntfn preference.", "description": "Unset admin ntfn preference unsets specific admin notification preference for the user and store it in user settings object.\nIt can be used in email newsletters to allow easy unsubscribing for users.", "operationId": "ves.io.schema.user.setting.CustomAPI.UnsetAdminNtfnPreference", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNtfnToUnset" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.UnsetAdminNtfnPreference", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "unset" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "unset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/combined_notifications": { "get": { "summary": "GET combined ntfn preferences.", "description": "GET combined ntfn preferences gets user-ntfn-preferences and admin-ntfn-preferences and returns combined result.", "operationId": "ves.io.schema.user.setting.CustomAPI.GetCombinedNtfnPreferences", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNotificationList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.GetCombinedNtfnPreferences", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Update combined ntfn preferences.", "description": "Update combined ntfn preferences updates both user-ntfn-preferences and admin-ntfn-preferences.", "operationId": "ves.io.schema.user.setting.CustomAPI.UpdateCombinedNtfnPreferences", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNtfnPreferencesMap" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.UpdateCombinedNtfnPreferences", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "combined-notification" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "combined-notification" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/notifications": { "get": { "summary": "GET ntfn preferences.", "description": "GET ntfn preferences gets current notification preferences for user.\nIt combines information from two sources:\n- explicitly set notification preferences in user settings object\n- default values from uam config (for those notifications which not explicitly set)", "operationId": "ves.io.schema.user.setting.CustomAPI.GetNtfnPreferences", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNotificationList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.GetNtfnPreferences", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Update ntfn preferences.", "description": "Update ntfn preferences updates notification preferences for the user and store them in user settings object.", "operationId": "ves.io.schema.user.setting.CustomAPI.UpdateNtfnPreferences", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNtfnPreferencesMap" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.UpdateNtfnPreferences", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "notification" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "notification" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/notifications/unset": { "put": { "summary": "Unset ntfn preference.", "description": "Unset ntfn preference unsets specific notification preference for the user and store it in user settings object.\nIt can be used in email newsletters to allow easy unsubscribing for users.", "operationId": "ves.io.schema.user.setting.CustomAPI.UnsetNtfnPreference", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingNtfnToUnset" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.UnsetNtfnPreference", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "unset" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "unset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/otp/admin_reset": { "put": { "summary": "ResetOtpDeviceByAdmin.", "description": "TODO(evg): description.", "operationId": "ves.io.schema.user.setting.CustomAPI.ResetOtpDeviceByAdmin", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingUserEmail" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.ResetOtpDeviceByAdmin", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "admin-reset" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "admin-reset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/sessions": { "get": { "summary": "GetUserSessions.", "description": "GetUserSessions returns a list of user sessions.", "operationId": "ves.io.schema.user.setting.CustomAPI.GetUserSessions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingUserSessionList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.GetUserSessions", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/settings": { "get": { "summary": "GET", "description": "Retrieves current user settings object defined to the user.", "operationId": "ves.io.schema.user.setting.CustomAPI.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingUserSettingsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.Get", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Update", "description": "Update defined user settings.", "operationId": "ves.io.schema.user.setting.CustomAPI.Update", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingUserSettingsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.Update", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "setting" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "setting" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/settings/idm/disable": { "put": { "summary": "DisableUserInIDM.", "description": "Disables user in Identity.", "operationId": "ves.io.schema.user.setting.CustomAPI.DisableUserInIDM", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingUserEmail" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.DisableUserInIDM", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "disable" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "disable" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/settings/idm/enable": { "put": { "summary": "EnableUserInIDM.", "description": "Enables user in Identity. Use this to enable a user which is disabled.", "operationId": "ves.io.schema.user.setting.CustomAPI.EnableUserInIDM", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingUserEmail" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.EnableUserInIDM", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "enable" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "enable" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/settings/image": { "get": { "summary": "GetUserProfileImage.", "description": "GetUserProfileImage returns user profile picture.", "operationId": "ves.io.schema.user.setting.CustomAPI.GetUserImage", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.GetUserImage", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DeleteUserImage.", "description": "Deletes current user profile picture.", "operationId": "ves.io.schema.user.setting.CustomAPI.DeleteUserImage", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.DeleteUserImage", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "image", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "image", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "UpdateUserImage.", "description": "Updates current user profile picture.", "operationId": "ves.io.schema.user.setting.CustomAPI.UpdateUserImage", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingUpdateImageRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.UpdateUserImage", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "image" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "image" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/settings/request_initial_access": { "put": { "summary": "Request Initial Access.", "description": "Request initial access requests initial access for user within tenant.\nEmails will be send to tenant's admins with corresponding information.", "operationId": "ves.io.schema.user.setting.CustomAPI.RequestInitialAccess", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.RequestInitialAccess", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "request-initial-acces" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "request-initial-acces" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/user/settings/view_preference": { "get": { "summary": "GET view preference.", "description": "GET view preference gets view preference for specific user.", "operationId": "ves.io.schema.user.setting.CustomAPI.GetViewPreference", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingViewPreference" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.GetViewPreference", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Set view preference.", "description": "Set view preference sets view preference for specific user.", "operationId": "ves.io.schema.user.setting.CustomAPI.SetViewPreference", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usersettingEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settingSetViewPreferenceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.user.setting.CustomAPI.SetViewPreference", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "view-preference" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "view-preference" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "User Settings Custom API.", "x-ves-proto-service": "ves.io.schema.user.setting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/was/user_token": { "get": { "summary": "GET Web App Scanning Service User Token.", "description": "GET one time token to connect Web App Scanning Service.", "operationId": "ves.io.schema.was.user_token.CustomAPI.GetUserToken", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_tokenGetUserTokenResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/tenant_and_identity/" }, "x-ves-proto-rpc": "ves.io.schema.was.user_token.CustomAPI.GetUserToken", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Web App Scanning Service User Token API.", "x-ves-proto-service": "ves.io.schema.was.user_token.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "allowed_tenantAllowedAccessConfig": { "type": "object", "description": "Shape for storing access config for a tenant.\nDefault field OPTIONS - disable, read-only, read_write provided for easy access controls\nand underlying allowed groups corresponding to each usecase will be updated accordingly.\nMainly used for storing state for support related tenant access.", "title": "AccessConfig", "x-displayname": "Access Config.", "x-ves-displayorder": "2,1", "x-ves-oneof-field-access_type_choice": "[\"read_only\",\"read_write_all\",\"read_write_ns\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.AllowedAccessConfig", "properties": { "disable": { "type": "boolean", "description": "Temporarily revoke access to this tenant.", "title": "Disable", "format": "boolean", "x-displayname": "Pause Access.", "x-f5xc-description-short": "Temporarily revoke access to this tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "read_only": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "read_write_all", "read_write_ns" ] }, "read_write_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for read write all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "read_only", "read_write_ns" ] }, "read_write_ns": { "allOf": [ { "$ref": "#/components/schemas/allowed_tenantNsReadWriteAccess" } ], "x-f5xc-description-short": "Configuration parameter for read write ns.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "read_only", "read_write_all" ] } }, "x-f5xc-description-short": "Shape for storing access config for a tenant.", "x-f5xc-description-medium": "Shape for storing access config for a tenant. Default field OPTIONS - disable, read-only, read_write provided for easy access controls and underlying allowed groups corresponding to each usecase will be updated accordingly. Mainly used for storing state for support related tenant access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantAllowedAccessConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a allowed_tenant", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantGetSupportTenantAccessResp": { "type": "object", "description": "Response to GET access control configurations for a support tenant.", "title": "GetSupportTenantAccessResp", "x-displayname": "GET Support Tenant Access Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.GetSupportTenantAccessResp", "properties": { "access_config": { "allOf": [ { "$ref": "#/components/schemas/allowed_tenantAllowedAccessConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to GET access control configurations for a support tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantGetSupportTenantAccessResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantNsReadWriteAccess": { "type": "object", "description": "Shape of read write access control for namespaces.", "title": "NsReadWriteAccess", "x-displayname": "Namespaces Read Write Access.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.NsReadWriteAccess", "properties": { "namespaces": { "type": "array", "description": "List of namespace name read/write access needs to be restricted to.", "title": "Namespaces", "maxItems": 32, "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "x-displayname": "Namespaces.", "x-ves-example": "Ns1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.items.string.min_len": "1", "ves.io.schema.rules.repeated.items.string.ves_object_name": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.items.string.min_len": "1", "ves.io.schema.rules.repeated.items.string.ves_object_name": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of namespace name read/write access needs to be restricted to.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of read write access control for namespaces.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantNsReadWriteAccess", "required_fields": [ "namespaces" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespaces\": [\n \"value\"\n ]\n}", "example_yaml": "namespaces:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a allowed_tenant", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/allowed_tenantReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantReplaceSpecType": { "type": "object", "description": "Replaces attributes of a allowed_tenant instance including its metadata like labels, description etc.", "title": "Replace Allowed Tenant", "x-displayname": "Replace Allowed Tenant.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.ReplaceSpecType", "properties": { "allowed_groups": { "type": "array", "description": "List of references to allowed user_group objects for access in to tenant.\nAdmin can use this to control API access by users from from original tenant into an allowed tenant.\nUser access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.", "maxItems": 32, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Allowed Groups.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of references to allowed user_group objects for access in to tenant.", "x-f5xc-description-medium": "List of references to allowed user_group objects for access in to tenant. Admin can use this to control API access by users from from original tenant into an allowed tenant. User access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_id": { "type": "string", "description": "Specify the Tenant ID of the Original Tenant which is allowed to manage.\nNOTE: this is the name of the tenant configuration obj. Not UID.", "maxLength": 256, "x-displayname": "Allowed Tenant ID.", "x-ves-example": "Msp-apac-s4543dsa.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "msp-apac-s4543dsa", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Specify the Tenant ID of the Original Tenant which is allowed to manage.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Replaces attributes of a allowed_tenant instance including its metadata like labels, description etc.", "x-f5xc-description-medium": "Replaces attributes of a allowed_tenant instance including its metadata like labels, description etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantReplaceSpecType", "required_fields": [ "tenant_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"tenant_id\": \"msp-apac-s4543dsa\"\n}", "example_yaml": "tenant_id: msp-apac-s4543dsa" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantUpdateSupportTenantAccessReq": { "type": "object", "description": "Request to update access control configurations for a support tenant.", "title": "UpdateSupportTenantAccessReq", "x-displayname": "Support Tenant Access Update Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.UpdateSupportTenantAccessReq", "properties": { "access_config": { "allOf": [ { "$ref": "#/components/schemas/allowed_tenantAllowedAccessConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to update access control configurations for a support tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantUpdateSupportTenantAccessReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "allowed_tenantUpdateSupportTenantAccessResp": { "type": "object", "description": "Response to update access control configurations for a support tenant.", "title": "UpdateSupportTenantAccessResp", "x-displayname": "Support Tenant Access Update Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.UpdateSupportTenantAccessResp", "properties": { "access_config": { "allOf": [ { "$ref": "#/components/schemas/allowed_tenantAllowedAccessConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to update access control configurations for a support tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_tenantUpdateSupportTenantAccessResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "ioschemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "ioschemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "protobufAny": { "type": "object", "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...;\nAny any;\nany.packfrom(foo);\n...\nIf (any.unpackto(&foo)) {\n...\n}\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...;\nAny any = any.pack(foo);\n...\nIf (any.is(foo.class)) {\nfoo = any.unpack(foo.class);\n}\n\nExample 3: Pack and unpack a message in Python.\n\nFoo = Foo(...)\nany = Any()\nany.pack(foo)\n...\nIf any.is(foo.descriptor):\nany.unpack(foo)\n...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.foo{...}\nany, err := ptypes.marshalany(foo)\n...\nFoo := &pb.foo{}\nif err := ptypes.unmarshalany(any, foo); err != nil {\n...\n}\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.example.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\npackage google.profile;\nmessage Person {\nstring first_name = 1;\nstring last_name = 2;\n}\n\n{\n\"@type\": \"type.googleapis.com/google.profile.person\",\n\"firstName\": ,\n\"lastName\": \n}\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.duration][]):\n\n{\n\"@type\": \"type.googleapis.com/google.protobuf.duration\",\n\"value\": \"1.212s\"\n}", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.", "x-f5xc-description-short": "URL identifying the protocol buffer message type.", "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.", "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protobufAny", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaConditionType": { "type": "object", "description": "Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.", "title": "ConditionType", "x-displayname": "Status Condition.", "x-ves-proto-message": "ves.io.schema.ConditionType", "properties": { "hostname": { "type": "string", "description": "Hostname of the instance of the site that sent the status.", "title": "hostname", "x-displayname": "Hostname", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "last_update_time": { "type": "string", "description": "Last time the condition was updated.", "title": "last_update_time", "format": "date-time", "x-displayname": "Last Updated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human readable string explaining the reason for reaching this condition.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Insufficient memory in data plane.", "x-f5xc-example": "Insufficient memory in data plane", "x-f5xc-description-short": "Human readable string explaining the reason for reaching this condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "service_name": { "type": "string", "description": "Name of the service that sent the status.", "title": "service name", "x-displayname": "Service Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the condition\n\"Success\" Validation has succeeded. Requested operation was successful.\n\"Failed\" Validation has failed.\n\"Incomplete\" Validation of configuration has failed due to missing configuration.\n\"Installed\" Validation has passed and configuration has been installed in data path or K8s\n\"Down\" Configuration is operationally down. E.g. Down interface\n\"Disabled\" Configuration is administratively disabled i.e. objectmetatype.disable = true.\n\"NotApplicable\" Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.", "title": "status", "x-displayname": "Status", "x-ves-example": "Failed", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-example": "Failed", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-description-short": "Status of the condition \"Success\" Validation has succeeded.", "x-f5xc-description-medium": "Status of the condition \"Success\" Validation has succeeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...", "maxLength": 1024, "enum": [ "Success", "Failed", "Incomplete", "Installed", "Down", "Disabled", "NotApplicable" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of the condition\n\"Validation\" represents validation user given configuration object\n\"Operational\" represents operational status of a given configuration object.", "title": "type", "x-displayname": "Type", "x-ves-example": "Operational.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-example": "Operational", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...", "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.", "maxLength": 1024, "enum": [ "Validation", "Operational" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.", "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaConditionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaErrorType__ves_io_schema_ai_assistant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaInitializerType": { "type": "object", "description": "Initializer is information about an initializer that has not yet completed.", "title": "InitializerType", "x-displayname": "Initializer.", "x-ves-proto-message": "ves.io.schema.InitializerType", "properties": { "name": { "type": "string", "description": "Name of the service that is responsible for initializing this object.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaInitializersType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "Initializers tracks the progress of initialization of a configuration object.", "title": "InitializersType", "x-displayname": "Initializers.", "x-ves-proto-message": "ves.io.schema.InitializersType", "properties": { "pending": { "type": "array", "description": "Pending is a list of initializers that must execute in order before this object is initialized.\nWhen the last pending initializer is removed, and no failing result is set, the initializers\nstruct will be set to nil and the object is considered as initialized and visible to all\nclients.", "title": "pending", "items": { "$ref": "#/components/schemas/schemaInitializerType" }, "x-displayname": "Pending", "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.", "x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaObjectCreateMetaType": { "type": "object", "description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "title": "ObjectCreateMetaType", "x-displayname": "Create Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectCreateMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectCreateMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaObjectGetMetaType": { "type": "object", "description": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "title": "ObjectGetMetaType", "x-displayname": "GET Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectGetMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectGetMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaObjectReplaceMetaType": { "type": "object", "description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "title": "ObjectReplaceMetaType", "x-displayname": "Replace Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectReplaceMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotations.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectReplaceMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaStatusMetaType": { "type": "object", "description": "StatusMetaType is metadata that all status must have.", "title": "StatusMetaType", "x-displayname": "Metadata", "x-ves-proto-message": "ves.io.schema.StatusMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "Creation_timestamp is when the status object was created. It is used to find/tie-break\nfor latest status object from same origin.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "Class of creator which created this StatusObject. This will be service's DNS FQDN.\nThis will be set by the system based on client certificate information.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "ver.re1.int.ves.I/O.", "x-f5xc-example": "ver.re1.int.F5 XC", "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.", "x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\nIdentifying the environment also). This will be set by the system based on client certificate\ninformation.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Ver-instance-1.", "x-f5xc-example": "ver-instance-1", "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.", "x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "publish": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusPublishType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_id": { "type": "string", "description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)", "title": "status_id", "x-displayname": "Status ID", "x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...", "x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for a StatusObject.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vtrp_id": { "type": "string", "description": "Origin of this status exchanged by VTRP.", "title": "vtrp_id", "x-displayname": "VTRP ID", "x-f5xc-description-short": "Origin of this status exchanged by VTRP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vtrp_stale": { "type": "boolean", "description": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "title": "vtrp_stale", "format": "boolean", "x-displayname": "VTRP Stale.", "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaStatusPublishType": { "type": "string", "description": "StatusPublishType is all possible publish operations on a StatusObject\n\n- STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n- STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable.", "title": "StatusPublishType", "enum": [ "STATUS_DO_NOT_PUBLISH", "STATUS_PUBLISH" ], "default": "STATUS_DO_NOT_PUBLISH", "x-displayname": "Status Publish Type.", "x-ves-proto-enum": "ves.io.schema.StatusPublishType", "x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.", "x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusPublishType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_DO_NOT_PUBLISH\"", "example_yaml": "STATUS_DO_NOT_PUBLISH\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaStatusType": { "type": "object", "description": "Status is a return value for calls that don't return other objects.", "title": "StatusType", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.StatusType", "properties": { "code": { "type": "integer", "description": "Suggested HTTP return code for this status, 0 if not set.", "title": "code", "format": "int32", "x-displayname": "Code", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the operation.\nOne of: \"Success\" or \"Failure\".", "title": "status", "x-displayname": "Status", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.", "title": "SystemObjectGetMetaType", "x-displayname": "System Metadata.", "x-ves-proto-message": "ves.io.schema.SystemObjectGetMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.", "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "A value identifying the class of the user or service which created this configuration object.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "Prism", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "A value identifying the exact user or service that created this configuration object.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Admin@example.com.", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deletion_timestamp": { "type": "string", "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.", "title": "deletion_timestamp", "format": "date-time", "x-displayname": "Deletion Timestamp.", "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.", "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.", "title": "finalizers", "items": { "type": "string" }, "x-displayname": "Finalizers.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.", "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "allOf": [ { "$ref": "#/components/schemas/schemaInitializersType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-description-short": "Configuration parameter for initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the operator or software. Values here can be interpreted\nby software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "title": "labels", "x-displayname": "Labels", "x-ves-example": "'VES.I/O/soft-deleted': 'true'", "x-f5xc-example": "'F5 XC/soft-deleted''true'", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this object was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "object_index": { "type": "integer", "description": "Unique index for the object. Some objects need a unique integer index to be allocated\nfor each object type. This field will be populated for all objects that need it and will\nbe zero otherwise.", "title": "object_index", "format": "int64", "x-displayname": "Object Index.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.", "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "tenant": { "type": "string", "description": "Tenant to which this configuration object belongs to. The value for this is found from\npresented credentials.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. It is generated by\nthe server on successful creation of an object and is not allowed to change on Replace\nAPI. The value of is taken from uid field of ObjectMetaType, if provided.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSystemObjectGetMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaViewRefType": { "type": "object", "description": "ViewRefType represents a reference to a view.", "title": "ViewRefType", "x-displayname": "View Reference.", "x-ves-proto-message": "ves.io.schema.ViewRefType", "properties": { "kind": { "type": "string", "description": "Kind of the view object.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Http_proxy.", "x-f5xc-example": "http_proxy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "UID of the view object.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d543fad8e1f8.", "x-f5xc-example": "00000000-0000-4000-8000-d543fad8e1f8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ViewRefType represents a reference to a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaViewRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaviewsObjectRefType": { "type": "object", "description": "This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name.", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.views.ObjectRefType", "properties": { "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "minLength": 1, "maxLength": 128, "x-displayname": "Name", "x-ves-example": "Contacts-route.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "contacts-route", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "byteLength": { "max": 128, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "maxLength": 63, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64 } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "maxLength": 64, "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "example-corp", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "byteLength": { "max": 64 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsObjectRefType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"contacts-route\"\n}", "example_yaml": "name: contacts-route" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_managementStatus": { "type": "string", "description": "Status is to identify the status of the managed tenant configuration.\n\n- UNKNOWN: UNKNOWN\nUnknown status of the configuration.\n- NOT_APPLICABLE: Not Applicable\nThe status is not applicable for the managed tenant configuration.\n- PENDING: Pending\nThe configuration is incomplete.\n- ACTIVE: Active\nThe tenant configuration is active.\n- MANAGED_TENANT_DISABLED: Managed Tenant Disabled\nManaged Tenant is disabled.\n- ORIGINAL_TENANT_DISABLED: Operating Tenant Disabled\nOperating Tenant is disabled.", "title": "Status", "enum": [ "UNKNOWN", "NOT_APPLICABLE", "PENDING", "ACTIVE", "MANAGED_TENANT_DISABLED", "ORIGINAL_TENANT_DISABLED" ], "default": "UNKNOWN", "x-displayname": "Status", "x-ves-proto-enum": "ves.io.schema.tenant_management.Status", "x-f5xc-description-short": "Status is to identify the status of the managed tenant configuration. - UNKNOWN: UNKNOWN Unknown status of the configuration. - NOT_APPLICABLE...", "x-f5xc-description-medium": "Status is to identify the status of the managed tenant configuration. - UNKNOWN: UNKNOWN Unknown status of the configuration. - NOT_APPLICABLE: Not Applicable The status is not applicable for the managed tenant configuration. - PENDING: Pending The configuration is incomplete. - ACTIVE: Active...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNKNOWN\"", "example_yaml": "UNKNOWN\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of allowed_tenant", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementallowed_tenantCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementallowed_tenantGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantCreateSpecType": { "type": "object", "description": "Creates a allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "title": "Create Allowed Tenant", "x-displayname": "Create Allowed Tenant.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.CreateSpecType", "properties": { "allowed_groups": { "type": "array", "description": "List of references to allowed user_group objects for access in to tenant.\nAdmin can use this to control API access by users from from original tenant into an allowed tenant.\nUser access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.", "maxItems": 32, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Allowed Groups.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of references to allowed user_group objects for access in to tenant.", "x-f5xc-description-medium": "List of references to allowed user_group objects for access in to tenant. Admin can use this to control API access by users from from original tenant into an allowed tenant. User access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_id": { "type": "string", "description": "Specify the Tenant ID of the Original Tenant which is allowed to manage.\nNOTE: this is the name of the tenant configuration obj. Not UID.", "maxLength": 256, "x-displayname": "Allowed Tenant ID.", "x-ves-example": "Msp-apac-s4543dsa.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "msp-apac-s4543dsa", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Specify the Tenant ID of the Original Tenant which is allowed to manage.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Creates a allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "x-f5xc-description-medium": "Creates a allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantCreateSpecType", "required_fields": [ "tenant_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"tenant_id\": \"msp-apac-s4543dsa\"\n}", "example_yaml": "tenant_id: msp-apac-s4543dsa" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read allowed_tenant", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementallowed_tenantCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/allowed_tenantReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementallowed_tenantGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_managementallowed_tenantStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantGetSpecType": { "type": "object", "description": "GET allowed_tenant reads a given object from storage backend for metadata.namespace.", "title": "Get Allowed Tenant", "x-displayname": "GET Allowed Tenant.", "x-ves-displayorder": "1,2,3", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.GetSpecType", "properties": { "allowed_groups": { "type": "array", "description": "List of references to allowed user_group objects for access in to tenant.\nAdmin can use this to control API access by users from from original tenant into an allowed tenant.\nUser access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.", "maxItems": 32, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Allowed Groups.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of references to allowed user_group objects for access in to tenant.", "x-f5xc-description-medium": "List of references to allowed user_group objects for access in to tenant. Admin can use this to control API access by users from from original tenant into an allowed tenant. User access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tenant_id": { "type": "string", "description": "Specify the Tenant ID of the Original Tenant which is allowed to manage.\nNOTE: this is the name of the tenant configuration obj. Not UID.", "maxLength": 256, "x-displayname": "Allowed Tenant ID.", "x-ves-example": "Msp-apac-s4543dsa.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "msp-apac-s4543dsa", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Specify the Tenant ID of the Original Tenant which is allowed to manage.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "GET allowed_tenant reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantGetSpecType", "required_fields": [ "tenant_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"tenant_id\": \"msp-apac-s4543dsa\"\n}", "example_yaml": "tenant_id: msp-apac-s4543dsa" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of allowed_tenant", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/tenant_managementallowed_tenantListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantListResponseItem": { "type": "object", "description": "By default a summary of allowed_tenant is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of allowed_tenant", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this allowed_tenant.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this allowed_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this allowed_tenant.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this allowed_tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates allowed_tenant is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates allowed_tenant is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementallowed_tenantGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this allowed_tenant.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this allowed_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this allowed_tenant.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_managementallowed_tenantStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this allowed_tenant.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of allowed_tenant is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of allowed_tenant is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementallowed_tenantStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for Allowed Tenant", "x-displayname": "Allowed Tenant.", "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementallowed_tenantStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "authenticationCookieParams": { "type": "object", "description": "Specifies different cookie related config parameters for authentication.", "title": "Cookie Parameters Config", "x-displayname": "Cookie Parameters.", "x-ves-oneof-field-secret_choice": "[\"auth_hmac\",\"kms_key_hmac\"]", "x-ves-proto-message": "ves.io.schema.authentication.CookieParams", "properties": { "auth_hmac": { "allOf": [ { "$ref": "#/components/schemas/authenticationHMACKeyPair" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "kms_key_hmac" ] }, "cookie_expiry": { "type": "integer", "description": "Specifies in seconds max duration of the allocated cookie. This maps to “Max-Age” attribute in the session cookie.\nThis will act as an expiry duration on the client side after which client will not be setting the\ncookie as part of the request.\nDefault cookie expiry is 3600 seconds.", "title": "cookie expiry", "format": "int64", "x-displayname": "Cookie Expiry duration.", "x-ves-example": "5000", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "86400" }, "x-f5xc-example": "5000", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "86400" }, "x-f5xc-description-short": "Specifies in seconds max duration of the allocated cookie. This maps to “Max-Age” attribute in the session cookie.", "x-f5xc-description-medium": "Specifies in seconds max duration of the allocated cookie. This maps to “Max-Age” attribute in the session cookie. This will act as an expiry duration on the client side after which client will not be setting the cookie as part of the request.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 86400, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cookie_refresh_interval": { "type": "integer", "description": "Specifies in seconds refresh interval for session cookie.\nThis is used to keep the active user active and reduce RE-login.\nWhen an incoming cookie's session expiry is still valid, and time to expire falls behind this interval,\nRE-issue a cookie with new expiry and with the same original session expiry.\nDefault refresh interval is 3000 seconds.", "title": "cookie refresh interval", "format": "int64", "x-displayname": "Cookie Refresh Interval.", "x-ves-example": "3600", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "86400" }, "x-f5xc-example": "3600", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "86400" }, "x-f5xc-description-short": "Specifies in seconds refresh interval for session cookie. This is used to keep the active user active and reduce RE-login.", "x-f5xc-description-medium": "Specifies in seconds refresh interval for session cookie. This is used to keep the active user active and reduce RE-login. When an incoming cookie's session expiry is still valid, and time to expire falls behind this interval, RE-issue a cookie with new expiry and with the same original session...", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 86400, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kms_key_hmac": { "allOf": [ { "$ref": "#/components/schemas/authenticationKMSKeyRefType" } ], "x-f5xc-description-short": "Configuration parameter for kms key hmac.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auth_hmac" ], "x-f5xc-references": [ { "resource_kind": null, "field_path": "kms_key_hmac", "gated_by": { "choice": "secret_choice" }, "required": false, "cardinality": "single" } ] }, "session_expiry": { "type": "integer", "description": "Specifies in seconds max lifetime of an authenticated session after which the user will be forced to login again.\nDefault session expiry is 86400 seconds(24 hours).", "title": "session expiry", "format": "int64", "x-displayname": "Session Expiry duration.", "x-ves-example": "36000", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "1296000" }, "x-f5xc-example": "36000", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "1296000" }, "x-f5xc-description-short": "Specifies in seconds max lifetime of an authenticated session after which the user will be forced to login again.", "x-f5xc-description-medium": "Specifies in seconds max lifetime of an authenticated session after which the user will be forced to login again. Default session expiry is 86400 seconds(24 hours).", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 1296000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Specifies different cookie related config parameters for authentication.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationCookieParams", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of authentication", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.authentication.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authenticationCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.authentication.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authenticationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationCreateSpecType": { "type": "object", "title": "Create Authentication Object", "x-displayname": "Create Authentication.", "x-ves-oneof-field-auth_type_choice": "[\"oidc_auth\"]", "x-ves-proto-message": "ves.io.schema.authentication.CreateSpecType", "properties": { "cookie_params": { "allOf": [ { "$ref": "#/components/schemas/authenticationCookieParams" } ], "x-f5xc-description-short": "Configuration parameter for cookie params.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "oidc_auth": { "allOf": [ { "$ref": "#/components/schemas/authenticationOIDCAuthType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a authentication", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.authentication.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read authentication", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.authentication.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/authenticationCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/authenticationReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authenticationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/authenticationStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationGetSpecType": { "type": "object", "title": "Get Authentication", "x-displayname": "GET Authentication.", "x-ves-oneof-field-auth_type_choice": "[\"oidc_auth\"]", "x-ves-proto-message": "ves.io.schema.authentication.GetSpecType", "properties": { "cookie_params": { "allOf": [ { "$ref": "#/components/schemas/authenticationCookieParams" } ], "x-f5xc-description-short": "Configuration parameter for cookie params.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "oidc_auth": { "allOf": [ { "$ref": "#/components/schemas/authenticationOIDCAuthType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationHMACKeyPair": { "type": "object", "description": "HMAC primary and secondary keys to be used for hashing the Cookie.\nEach key also have an associated expiry timestamp, beyond which key is invalid.", "title": "HMAC Key Pair", "x-displayname": "HMAC Key Pair.", "x-ves-proto-message": "ves.io.schema.authentication.HMACKeyPair", "properties": { "prim_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prim_key_expiry": { "type": "string", "description": "Primary HMAC Key Expiry time.", "title": "HMAC Primary Key Expiry Time", "format": "date-time", "x-displayname": "HMAC Primary Key Expiry.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "sec_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sec_key_expiry": { "type": "string", "description": "Secondary HMAC Key Expiry time.", "title": "HMAC Secondary Key Expiry Time", "format": "date-time", "x-displayname": "HMAC Secondary Key Expiry.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "HMAC primary and secondary keys to be used for hashing the Cookie. Each key also have an associated expiry timestamp, beyond which key is invalid.", "x-f5xc-description-medium": "HMAC primary and secondary keys to be used for hashing the Cookie. Each key also have an associated expiry timestamp, beyond which key is invalid.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationHMACKeyPair", "required_fields": [ "prim_key_expiry", "sec_key_expiry" ], "mutually_exclusive_groups": [], "example_json": "{\n \"prim_key_expiry\": \"value\",\n \"sec_key_expiry\": \"{\\\"key\\\": \\\"value\\\"}\"\n}", "example_yaml": "prim_key_expiry: value\nsec_key_expiry: '{\"key\": \"value\"}'" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationKMSKeyRefType": { "type": "object", "description": "Reference to KMS Key Object.", "title": "KMS Key Ref", "x-displayname": "KMS Key Reference.", "x-ves-proto-message": "ves.io.schema.authentication.KMSKeyRefType", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationKMSKeyRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of authentication", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.authentication.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/authenticationListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationListResponseItem": { "type": "object", "description": "By default a summary of authentication is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of authentication", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.authentication.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this authentication.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this authentication.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this authentication.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this authentication.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates authentication is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates authentication is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/authenticationGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this authentication.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this authentication.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this authentication.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/authenticationStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this authentication.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of authentication is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of authentication is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationOIDCAuthParams": { "type": "object", "title": "OIDCAuthParams", "x-displayname": "OIDCAuthParams.", "x-ves-proto-message": "ves.io.schema.authentication.OIDCAuthParams", "properties": { "auth_endpoint_url": { "type": "string", "description": "URL of the authorization server's authorization endpoint.", "title": "Authorization Endpoint", "minLength": 1, "maxLength": 128, "x-displayname": "Authorization Endpoint.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the authorization server's authorization endpoint.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "end_session_endpoint_url": { "type": "string", "description": "URL of the authorization server's Logout endpoint.", "title": "Logout Endpoint", "minLength": 1, "maxLength": 128, "x-displayname": "Logout Endpoint.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the authorization server's Logout endpoint.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "token_endpoint_url": { "type": "string", "description": "URL of the authorization server's Token endpoint.", "title": "Token Endpoint", "minLength": 1, "maxLength": 128, "x-displayname": "Token Endpoint.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the authorization server's Token endpoint.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationOIDCAuthParams", "required_fields": [ "auth_endpoint_url", "end_session_endpoint_url", "token_endpoint_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"auth_endpoint_url\": \"value\",\n \"end_session_endpoint_url\": \"value\",\n \"token_endpoint_url\": \"example\"\n}", "example_yaml": "auth_endpoint_url: value\nend_session_endpoint_url: value\ntoken_endpoint_url: example" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationOIDCAuthType": { "type": "object", "title": "OIDCAuthType", "x-displayname": "OIDCAuthType.", "x-ves-oneof-field-auth_params_choice": "[\"oidc_auth_params\",\"oidc_well_known_config_url\"]", "x-ves-proto-message": "ves.io.schema.authentication.OIDCAuthType", "properties": { "client_secret": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "oidc_auth_params": { "allOf": [ { "$ref": "#/components/schemas/authenticationOIDCAuthParams" } ], "x-f5xc-description-short": "Configuration parameter for oidc auth params.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "oidc_well_known_config_url" ] }, "oidc_client_id": { "type": "string", "description": "Client ID used while sending the Authorization Request to OIDC server.", "title": "OIDC Client ID", "minLength": 1, "maxLength": 256, "x-displayname": "OIDC Client ID.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Client ID used while sending the Authorization Request to OIDC server.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "oidc_well_known_config_url": { "type": "string", "description": "Exclusive with [oidc_auth_params]\nAn OIDC well-known configuration URL that will be used to fetch authentication related endpoints.", "title": "OIDC Config URL", "minLength": 1, "maxLength": 128, "x-displayname": "Well-known Configuration URL.", "x-ves-example": "https://login.microsoftonline.com/some-client-ID/v2.0/.well-known/openid-configuration.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "https://login.microsoftonline.com/some-client-id/v2.0/.well-known/openid-configuration", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Exclusive with [oidc_auth_params] An OIDC well-known configuration URL that will be used to fetch authentication related endpoints.", "x-f5xc-description-medium": "Exclusive with [oidc_auth_params] An OIDC well-known configuration URL that will be used to fetch authentication related endpoints.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "oidc_auth_params" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationOIDCAuthType", "required_fields": [ "oidc_client_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"oidc_client_id\": \"value\"\n}", "example_yaml": "oidc_client_id: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a authentication", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.authentication.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authenticationReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.authentication.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationReplaceSpecType": { "type": "object", "title": "Replace Authentication", "x-displayname": "Replace Authentication.", "x-ves-oneof-field-auth_type_choice": "[\"oidc_auth\"]", "x-ves-proto-message": "ves.io.schema.authentication.ReplaceSpecType", "properties": { "cookie_params": { "allOf": [ { "$ref": "#/components/schemas/authenticationCookieParams" } ], "x-f5xc-description-short": "Configuration parameter for cookie params.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "oidc_auth": { "allOf": [ { "$ref": "#/components/schemas/authenticationOIDCAuthType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authenticationStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of Authentication Object", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.authentication.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authenticationStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBlindfoldSecretInfoType": { "type": "object", "description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "title": "BlindfoldSecretInfoType", "x-displayname": "Blindfold Secret.", "x-ves-displayorder": "3,1,2", "x-ves-proto-message": "ves.io.schema.BlindfoldSecretInfoType", "properties": { "decryption_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "title": "Decryption Provider", "x-displayname": "Decryption Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location": { "type": "string", "description": "Location is the uri_ref. It could be in URL format for string:///\nOr it could be a path if the store provider is an HTTP/HTTPS location.", "title": "Location", "x-displayname": "Location", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "minLength": 4, "maxLength": 131072, "format": "uri", "deterministic": true, "metadata": { "source": "manual-override", "confidence": 1.0, "category": "content", "note": "Blindfold envelope encryption (AES-256-GCM + RSA-OAEP) of an RSA-2048 TLS private key produces ~3700 char string:/// URL. 128KB max secret size = ~175KB base64. Discovery reported 1024 which is incorrect.", "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "store_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Store Provider", "x-displayname": "Store Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBlindfoldSecretInfoType", "required_fields": [ "location" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "location: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "per-tenant" } } }, "schemaClearSecretInfoType": { "type": "object", "description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "title": "ClearSecretInfoType", "x-displayname": "In-Clear Secret.", "x-ves-displayorder": "2,1", "x-ves-proto-message": "ves.io.schema.ClearSecretInfoType", "properties": { "provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Provider", "x-displayname": "Provider", "x-ves-example": "Box-provider.", "x-f5xc-example": "box-provider", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "url": { "type": "string", "description": "URL of the secret. Currently supported URL schemes is string:///.\nFor string:/// scheme, Secret needs to be encoded Base64 format.\nWhen asked for this secret, caller will GET Secret bytes after Base64 decoding.", "title": "URL", "maxLength": 131072, "x-displayname": "URL", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.", "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding.", "format": "uri", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 131072, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 131072 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaClearSecretInfoType", "required_fields": [ "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"url\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "url: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaSecretType": { "type": "object", "description": "SecretType is used in an object to indicate a sensitive/confidential field.", "title": "SecretType", "x-displayname": "Secret", "x-ves-oneof-field-secret_info_oneof": "[\"blindfold_secret_info\",\"clear_secret_info\"]", "x-ves-proto-message": "ves.io.schema.SecretType", "properties": { "blindfold_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaBlindfoldSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "clear_secret_info" ] }, "clear_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaClearSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blindfold_secret_info" ] } }, "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSecretType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Secret management is platform-level" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "authorization_serverCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of authorization_server", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.authorization_server.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.authorization_server.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverCreateSpecType": { "type": "object", "description": "Create authorization_server creates a new object in the storage backend for metadata.namespace.", "title": "Create authorization server", "x-displayname": "Create Authorization Server.", "x-ves-proto-message": "ves.io.schema.authorization_server.CreateSpecType", "properties": { "jwks_uri": { "type": "string", "description": "X-textBlockContent:\nAutomatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "maxLength": 256, "x-displayname": "JWKS URI", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.uri": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.uri": "true" }, "x-f5xc-description-short": "X-textBlockContent: Automatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "x-f5xc-description-medium": "X-textBlockContent: Automatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Create authorization_server creates a new object in the storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverCreateSpecType", "required_fields": [ "jwks_uri" ], "mutually_exclusive_groups": [], "example_json": "{\n \"jwks_uri\": \"value\"\n}", "example_yaml": "jwks_uri: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a authorization_server", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.authorization_server.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read authorization_server", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.authorization_server.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/authorization_serverStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverGetSpecType": { "type": "object", "description": "GET authorization_server reads a given object from storage backend for metadata.namespace.", "title": "Get authorization server", "x-displayname": "GET Authorization Server.", "x-ves-proto-message": "ves.io.schema.authorization_server.GetSpecType", "properties": { "jwks_uri": { "type": "string", "description": "X-textBlockContent:\nAutomatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "maxLength": 256, "x-displayname": "JWKS URI", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.uri": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.uri": "true" }, "x-f5xc-description-short": "X-textBlockContent: Automatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "x-f5xc-description-medium": "X-textBlockContent: Automatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "last_fetch_status": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_successful_fetch": { "type": "string", "description": "Configuration parameter for last successful fetch", "format": "date-time", "x-displayname": "Last Successful Fetch.", "x-ves-example": "01-01-1970T00:00:00Z.", "x-f5xc-example": "01-01-1970T00:00:00Z", "x-f5xc-description-short": "Configuration parameter for last successful fetch.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GET authorization_server reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverGetSpecType", "required_fields": [ "jwks_uri" ], "mutually_exclusive_groups": [], "example_json": "{\n \"jwks_uri\": \"value\"\n}", "example_yaml": "jwks_uri: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of authorization_server", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.authorization_server.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/authorization_serverListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverListResponseItem": { "type": "object", "description": "By default a summary of authorization_server is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of authorization_server", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.authorization_server.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this authorization_server.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this authorization_server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this authorization_server.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this authorization_server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates authorization_server is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates authorization_server is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this authorization_server.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this authorization_server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this authorization_server.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/authorization_serverStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this authorization_server.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this authorization_server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of authorization_server is returned in 'List'.", "x-f5xc-description-medium": "By default a summary of authorization_server is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a authorization_server", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.authorization_server.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/authorization_serverReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.authorization_server.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverReplaceSpecType": { "type": "object", "description": "Replace authorization_server replaces an existing object in the storage backend for metadata.namespace.", "title": "Replace authorization server", "x-displayname": "Replace Authorization Server.", "x-ves-proto-message": "ves.io.schema.authorization_server.ReplaceSpecType", "properties": { "jwks_uri": { "type": "string", "description": "X-textBlockContent:\nAutomatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "maxLength": 256, "x-displayname": "JWKS URI", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.uri": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.uri": "true" }, "x-f5xc-description-short": "X-textBlockContent: Automatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "x-f5xc-description-medium": "X-textBlockContent: Automatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Replace authorization_server replaces an existing object in the storage backend for metadata.namespace.", "x-f5xc-description-medium": "Replace authorization_server replaces an existing object in the storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverReplaceSpecType", "required_fields": [ "jwks_uri" ], "mutually_exclusive_groups": [], "example_json": "{\n \"jwks_uri\": \"value\"\n}", "example_yaml": "jwks_uri: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverStatus": { "type": "string", "description": "Status\n\nThe fetch has not been attempted, or the status is unavailable. Please verify the Server JWKS URL and try fetching manually. If the issue persists, contact support.\nThe JWKS file was successfully fetched from the Authorization Server\nThe fetch attempt failed, and the JWKS file could not be retrieved. Please ensure that the JWKS URL is valid\nThe JWKS file was fetched but cannot be used. It is either not in the correct format or exceeds the allowed file size.", "title": "Status", "enum": [ "STATUS_UNKNOWN", "STATUS_SUCCEEDED", "STATUS_FAILED", "STATUS_SUCCEEDED_WITH_ERROR" ], "default": "STATUS_UNKNOWN", "x-displayname": "Status", "x-ves-proto-enum": "ves.io.schema.authorization_server.Status", "x-f5xc-description-short": "Status The fetch has not been attempted, or the status is unavailable. Please verify the Server JWKS URL and try fetching manually.", "x-f5xc-description-medium": "Status The fetch has not been attempted, or the status is unavailable. Please verify the Server JWKS URL and try fetching manually. If the issue persists, contact support.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_UNKNOWN\"", "example_yaml": "STATUS_UNKNOWN\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of authorization server", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.authorization_server.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverUpdateAuthorizationServerRequest": { "type": "object", "description": "Request message for UpdateAuthorizationServer API.", "title": "Update Authorization Server Request", "x-displayname": "Update Authorization Server Request.", "x-ves-proto-message": "ves.io.schema.authorization_server.UpdateAuthorizationServerRequest", "properties": { "name": { "type": "string", "description": "Human-readable name for the resource", "title": "name", "x-displayname": "Name", "x-ves-example": "Okta", "x-f5xc-example": "okta", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Human-readable name for the resource", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request message for UpdateAuthorizationServer API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverUpdateAuthorizationServerRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "authorization_serverUpdateAuthorizationServerResponse": { "type": "object", "description": "Response message for UpdateAuthorizationServer API.", "title": "Update Authorization Server Response", "x-displayname": "Update Authorization Server Response.", "x-ves-proto-message": "ves.io.schema.authorization_server.UpdateAuthorizationServerResponse", "x-f5xc-description-short": "Response message for UpdateAuthorizationServer API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for authorization_serverUpdateAuthorizationServerResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "apiHttpBody": { "type": "object", "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\nmessage GetResourceRequest {\n// A unique request ID.\nString request_id = 1;\n\n// The raw HTTP body is bound to this field.\ngoogle.api.httpbody http_body = 2;\n}\n\nservice ResourceService {\nrpc GetResource(GetResourceRequest) returns (google.api.httpbody);\nrpc UpdateResource(google.api.httpbody) returns\n(google.protobuf.empty);\n}\n\nExample with streaming methods:\n\nservice CaldavService {\nrpc GetCalendar(stream google.api.httpbody)\nreturns (stream google.api.httpbody);\nrpc UpdateCalendar(stream google.api.httpbody)\nreturns (stream google.api.httpbody);\n}\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.", "properties": { "content_type": { "type": "string", "description": "The HTTP Content-Type header value specifying the content type of the body.", "x-f5xc-description-short": "The HTTP Content-Type header value specifying the content type of the body.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "type": "string", "description": "The HTTP request/response body as raw binary.", "format": "byte", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The HTTP request/response body as raw binary.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "extensions": { "type": "array", "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.", "items": { "$ref": "#/components/schemas/protobufAny" }, "x-f5xc-description-short": "Application specific response metadata. Must be set in the first response for streaming APIs.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Message that represents an arbitrary HTTP body.", "x-f5xc-description-medium": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for apiHttpBody", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenantCustomerInfo": { "type": "object", "description": "Optional details for the new child tenant.", "title": "customer_info", "x-displayname": "Customer Info.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.CustomerInfo", "properties": { "additional_info": { "type": "string", "description": "Use this field for any additional information about the new child tenant.", "title": "additional_info", "maxLength": 1024, "x-displayname": "Additional Info.", "x-ves-example": "This is used for testing purpose.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-example": "This is used for testing purpose", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-description-short": "Use this field for any additional information about the new child tenant.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "email": { "type": "string", "description": "Email address in RFC 5322 format", "title": "email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_name": { "type": "string", "description": "Human-readable name for the resource", "title": "first_name", "maxLength": 128, "x-displayname": "First Name.", "x-ves-example": "John", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "john", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "Human-readable name for the resource", "title": "last_name", "maxLength": 128, "x-displayname": "Last Name", "x-ves-example": "David", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "david", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Optional details for the new child tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenantCustomerInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenantDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a child_tenant", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenantDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenantListChildTenantsResp": { "type": "object", "description": "Response to GET list of child tenant access.", "title": "ListMSPChildTenantsResp", "x-displayname": "List Child Tenants Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.ListChildTenantsResp", "properties": { "access_config": { "type": "array", "description": "Allowed access configuration details for the tenant.", "title": "access_config", "items": { "$ref": "#/components/schemas/tenant_managementAccessInfo" }, "x-displayname": "Access Config.", "x-f5xc-description-short": "Allowed access configuration details for the tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "next_page": { "type": "string", "description": "NextPage contains the UUID of the first item of the next page.\nThis value can be passed back as the PageStart in the next request.\nIf this empty means current one is the last page.", "title": "next_page", "x-displayname": "NextPage", "x-f5xc-description-short": "NextPage contains the UUID of the first item of the next page. This value can be passed back as the PageStart in the next request.", "x-f5xc-description-medium": "NextPage contains the UUID of the first item of the next page. This value can be passed back as the PageStart in the next request. If this empty means current one is the last page.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "TotalCount holds total count of access config.", "title": "total_count", "format": "int32", "x-displayname": "TotalCount.", "x-f5xc-description-short": "TotalCount holds total count of access config.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_filtered_count": { "type": "integer", "description": "TotalFilteredCount holds total count of access config after filtering.", "title": "total_filtered_count", "format": "int32", "x-displayname": "TotalFilteredCount.", "x-f5xc-description-short": "TotalFilteredCount holds total count of access config after filtering.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to GET list of child tenant access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenantListChildTenantsResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenantMigrateChildTenantsReq": { "type": "object", "description": "Request to migrate child tenants to a specified new child tenant manager.", "title": "MigrateChildTenantsReq", "x-displayname": "Migrate child tenants request.", "x-ves-oneof-field-migratechildtenantsreqchoice": "[\"ct_list_to_target_ctm\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.MigrateChildTenantsReq", "properties": { "ct_list_to_target_ctm": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementCTListToCTM" } ], "x-f5xc-description-short": "Configuration parameter for ct list to target ctm.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to migrate child tenants to a specified new child tenant manager.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenantMigrateChildTenantsReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenantMigrateChildTenantsResp": { "type": "object", "description": "Response of migrating child tenants to a specified CTM.", "title": "MigrateChildTenantsResp", "x-displayname": "Migrate child tenants response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.MigrateChildTenantsResp", "properties": { "child_tenant_manager": { "type": "string", "description": "Name of the child tenant manager to which all the child tenants are migrating to.", "title": "Child tenant manager", "x-displayname": "Child tenant manager.", "x-f5xc-description-short": "Name of the child tenant manager to which all the child tenants are migrating to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "errors": { "type": "array", "description": "Errors(if any) while migrating child tenants.", "title": "Errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_tenant_management_child_tenant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while migrating child tenants.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "migrate_initiated_for_ct_count": { "type": "integer", "description": "This specifies the total number of child tenants for which migration has been initiated to a specified CTM.", "title": "Migrate initiated for child tenants count", "format": "int32", "x-displayname": "Migrate initiated for child tenants count.", "x-f5xc-description-short": "Specifies the total number of child tenants for which migration has been initiated to a specified CTM.", "x-f5xc-description-medium": "Specifies the total number of child tenants for which migration has been initiated to a specified CTM.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_ct_count": { "type": "integer", "description": "This specifies total number of child tenants requested to be migrated to a specified CTM.", "title": "Total child tenant count", "format": "int32", "x-displayname": "Total child tenant count requested for migration.", "x-f5xc-description-short": "Specifies total number of child tenants requested to be migrated to a specified CTM.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response of migrating child tenants to a specified CTM.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenantMigrateChildTenantsResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenantReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a child_tenant", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenantReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenantReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenantReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "contactContactType": { "type": "string", "description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)", "title": "Contact Type", "enum": [ "MAILING", "BILLING", "PAYMENT" ], "default": "MAILING", "x-displayname": "Contact Type.", "x-ves-proto-enum": "ves.io.schema.contact.ContactType", "x-f5xc-description-short": "Determines the contact type Indicates snail mail address (used for correspondence) Indicates billing address (this address will appear on...", "x-f5xc-description-medium": "Determines the contact type Indicates snail mail address (used for correspondence) Indicates billing address (this address will appear on invoices) Indicates contact used for a payment method (this address is used when charging a payment method).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactContactType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"MAILING\"", "example_yaml": "MAILING\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportAttachmentType": { "type": "object", "description": "Attachment represents a single support ticket comment attachment. Attachment are normally not store with the ticket itself,\nthey represent a handle in the third party, so the contact can be retrieved omn demand.", "title": "Attachment", "x-displayname": "Attachment.", "x-ves-proto-message": "ves.io.schema.customer_support.AttachmentType", "properties": { "attachment": { "type": "string", "description": "Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.", "title": "Binary attachment", "format": "byte", "x-displayname": "Attachment data.", "x-ves-example": "DGVzdCBhdHRhY2htZW50.", "x-f5xc-example": "dGVzdCBhdHRhY2htZW50", "x-f5xc-description-short": "Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.", "x-f5xc-description-medium": "Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "content_type": { "type": "string", "description": "Mime content type of the attachment. Helps the UI to properly display the data.", "title": "Content type", "x-displayname": "Content type.", "x-ves-example": "Application/pdf.", "x-f5xc-example": "application/pdf", "x-f5xc-description-short": "Mime content type of the attachment. Helps the UI to properly display the data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filename": { "type": "string", "description": "Filename of the attachment as provided by the caller.", "title": "Filename of the attachment", "x-displayname": "Filename", "x-ves-example": "attachment.pdf.", "x-f5xc-example": "attachment.pdf", "x-f5xc-description-short": "Filename of the attachment as provided by the caller.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tp_id": { "type": "string", "description": "Optional ID as assigned by the 3rd party actually storing the data.", "title": "3rd party ID", "x-displayname": "3rd party ID.", "x-ves-example": "1234", "x-f5xc-example": "1234", "x-f5xc-description-short": "Optional ID as assigned by the 3rd party actually storing the data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Attachment represents a single support ticket comment attachment.", "x-f5xc-description-medium": "Attachment represents a single support ticket comment attachment. Attachment are normally not store with the ticket itself, they represent a handle in the third party, so the contact can be retrieved omn demand.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportAttachmentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportCloseResponse": { "type": "object", "description": "Gives details of result of closing a customer support ticket.", "title": "Close response", "x-displayname": "Response to closing a customer support ticket.", "x-ves-proto-message": "ves.io.schema.customer_support.CloseResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Gives details of result of closing a customer support ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportCloseResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportCommentResponse": { "type": "object", "description": "Gives details of result of adding a customer support ticket.", "title": "Comment response", "x-displayname": "Response to adding of new customer support ticket comment.", "x-ves-proto-message": "ves.io.schema.customer_support.CommentResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Gives details of result of adding a customer support ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportCommentResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportCommentType": { "type": "object", "description": "Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself.\nCustomers usually download all comments on an issue which resembles a conversation on an issue.", "title": "Comment", "x-displayname": "Comment", "x-ves-proto-message": "ves.io.schema.customer_support.CommentType", "properties": { "attachment_ids": { "type": "array", "description": "Third party ID of any attachment related to this ticket comment.", "title": "Third party attachment ID", "items": { "type": "string" }, "x-displayname": "Attachment IDs.", "x-ves-example": "12345", "x-f5xc-example": "12345", "x-f5xc-description-short": "Third party ID of any attachment related to this ticket comment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "attachments_info": { "type": "array", "description": "Information about any attachments (such as screenshots, plain text files) the comment can have.", "title": "Attachments information", "items": { "$ref": "#/components/schemas/customer_supportAttachmentType" }, "x-displayname": "Attachments details.", "x-f5xc-description-short": "Information about any attachments (such as screenshots, plain text files) the comment can have.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "author_email": { "type": "string", "description": "Email of the author of the comment.", "title": "Email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "author_name": { "type": "string", "description": "Author of the comment (as a name)", "title": "Author", "x-displayname": "Author", "x-ves-example": "John Smith.", "x-f5xc-example": "John Smith", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "comment_id": { "type": "string", "description": "ID assigned to this comment by support provider.", "title": "Comment ID", "x-displayname": "Comment ID.", "x-ves-example": "02s3S000000vvYSQAY.", "x-f5xc-example": "02s3S000000vvYSQAY", "x-f5xc-description-short": "ID assigned to this comment by support provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "created_at": { "type": "string", "description": "Comment creation time.", "title": "Creation timestamp", "format": "date-time", "x-displayname": "At", "x-ves-example": "01-01-1970T00:00:00Z.", "x-f5xc-example": "01-01-1970T00:00:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "html": { "type": "string", "description": "Comment body as HTML.", "title": "HTML text", "x-displayname": "Comment", "x-ves-example": "

Looking good

", "x-f5xc-example": "

Looking good

", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "plain_text": { "type": "string", "description": "Comment body as plain text.", "title": "Plain text", "x-displayname": "Comment", "x-ves-example": "Looking good.", "x-f5xc-example": "Looking good", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself.", "x-f5xc-description-medium": "Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself. Customers usually download all comments on an issue which resembles a conversation on an issue.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportCommentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportEscalationResponse": { "type": "object", "description": "Any error that may occurred during escalating of a ticket.", "title": "Escalation response", "x-displayname": "Response to escalation request.", "x-ves-proto-message": "ves.io.schema.customer_support.EscalationResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any error that may occurred during escalating of a ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportEscalationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportPriorityResponse": { "type": "object", "description": "Gives details of result of changing priority a customer support ticket.", "title": "Change priority response", "x-displayname": "Response to changing of priority of a customer support ticket.", "x-ves-proto-message": "ves.io.schema.customer_support.PriorityResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Gives details of result of changing priority a customer support ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportPriorityResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportReopenResponse": { "type": "object", "description": "Gives details of result of reopening a customer support ticket.", "title": "Reopen response", "x-displayname": "Response to reopening a customer support ticket.", "x-ves-proto-message": "ves.io.schema.customer_support.ReopenResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Gives details of result of reopening a customer support ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportReopenResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportSupportService": { "type": "string", "description": "Indicates the list of support service\n\nUnknown Support Service\nAccount Protection Support Service\nAdministration Support Service\nApplication Traffic Insight Support Service\nAudit Logs & Alerts Support Service\nAuthentication Intelligence Support Service\nBilling Support Service\nClient Side Defense Support Service\nCloud & Edge Sites Support Service\ndeprecated: use SS_MULTI_CLOUD_NETWORK_CONNECT instead\nDDoS & Transit Support Service\nDeprecated: use SS_ROUTED_DDOS instead\nDistributed Apps Support Service\nDNS Management Support Service\nLoadBalancers Support Service\ndeprecated: use SS_MULTI_CLOUD_APP_CONNECT instead\nShared Configuration Support Service\nWeb App & API Protection Support Service\nOther Support Service\nBot Defense Support Service\nContent delivery network Support Service\nObservability Support Service\nDelegated Access Support Service\nNetworking & security across clouds, edge and on-premises\nConnect apps across clouds, edge and on-premises using Load Balancers\nData Intelligence Support Service\nNGINX One Support Service\nWeb App Scanning Support Service\nRouted DDoS Support Service\nMobile App Shield protects mobile apps from reverse engineering, tampering and malware\nDefault for deprecated services\nAutomation Support Service for Terraform Provider.", "title": "SupportService", "enum": [ "SS_UNKNOWN", "SS_ACCOUNT_PROTECTION", "SS_ADMINISTRATION", "SS_APPLICATION_TRAFFIC_INSIGHT", "SS_AUDIT_LOGS_AND_ALERTS", "SS_AUTHENTICATION_INTELLIGENCE", "SS_BILLING", "SS_CLIENT_SIDE_DEFENSE", "SS_CLOUD_AND_EDGE_SITES", "SS_DDOS_AND_TRANSIT_SERVICES", "SS_DISTRIBUTED_APPS", "SS_DNS_MANAGEMENT", "SS_LOAD_BALANCERS", "SS_SHARED_CONFIGURATION", "SS_WEB_APP_AND_API_PROTECTION", "SS_OTHER", "SS_BOT_DEFENSE", "SS_CDN", "SS_OBSERVABILITY", "SS_DELEGATED_ACCESS", "SS_MULTI_CLOUD_NETWORK_CONNECT", "SS_MULTI_CLOUD_APP_CONNECT", "SS_DATA_INTELLIGENCE", "SS_NGINX_ONE", "SS_WEB_APP_SCANNING", "SS_ROUTED_DDOS", "SS_MOBILE_APP_SHIELD", "SS_DEPRECATED", "SS_AUTOMATION" ], "default": "SS_UNKNOWN", "x-displayname": "Support Service.", "x-ves-proto-enum": "ves.io.schema.customer_support.SupportService", "x-f5xc-description-short": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application...", "x-f5xc-description-medium": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application Traffic Insight Support Service Audit Logs & Alerts Support Service Authentication Intelligence Support Service Billing Support Service Client Side Defense...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportSupportService", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SS_UNKNOWN\"", "example_yaml": "SS_UNKNOWN\n..." }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportSupportTicketPriority": { "type": "string", "description": "Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue.", "title": "SupportTicketPriority", "enum": [ "PRIORITY_UNKNOWN", "PRIORITY_NORMAL", "PRIORITY_HIGH", "PRIORITY_URGENT" ], "default": "PRIORITY_UNKNOWN", "x-displayname": "Priority", "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketPriority", "x-f5xc-description-short": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues.", "x-f5xc-description-medium": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues. Unknown/empty priority Normal priority issue High priority issue Urgent priority issue.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportSupportTicketPriority", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PRIORITY_UNKNOWN\"", "example_yaml": "PRIORITY_UNKNOWN\n..." }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportSupportTicketStatus": { "type": "string", "description": "State of the ticket so the customers know if the problem is being looked into\n\nUnknown or empty support ticket status\nIndicates a new ticket, waiting to be assigned to an agent\nIndicates an open issues, actively being looked into\nIndicates a pending issue, an open issue not actively being looked into\nIndicates on issue that on-hold, waiting for more information\nIndicates a solved issue, waiting for customer's confirmation\nIndicates a closed issue, resolved and customer approved\nIndicates a failed ticket, a failed ticket didn't make it into Salesforce and a customer should create new one instead.", "title": "SupportTicketStatus", "enum": [ "STATUS_UNKNOWN", "STATUS_NEW", "STATUS_OPEN", "STATUS_PENDING", "STATUS_ONHOLD", "STATUS_SOLVED", "STATUS_CLOSED", "STATUS_FAILED" ], "default": "STATUS_UNKNOWN", "x-displayname": "Support Ticket Status.", "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketStatus", "x-f5xc-description-short": "State of the ticket so the customers know if the problem is being looked into Unknown or empty support ticket status Indicates a new ticket...", "x-f5xc-description-medium": "State of the ticket so the customers know if the problem is being looked into Unknown or empty support ticket status Indicates a new ticket, waiting to be assigned to an agent Indicates an open issues, actively being looked into Indicates a pending issue, an open issue not actively being looked...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportSupportTicketStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_UNKNOWN\"", "example_yaml": "STATUS_UNKNOWN\n..." }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportSupportTicketType": { "type": "string", "description": "Several types of issues are supported, such as problems, questions.\n\nUnknown or empty ticket type\nIndicates a problem (e.g. Misconfiguration)\nIndicates a task (a request to do something)\nIndicates a question (billing, services related)\nIndicates an incident (something is not working)\nIndicates a technical support ticket\nIndicates an account support ticket\nIndicates an Incident support ticket.", "title": "SupportTicketType", "enum": [ "TYPE_UNKNOWN", "TYPE_PROBLEM", "TYPE_TASK", "TYPE_QUESTION", "TYPE_INCIDENT", "TYPE_TECHNICAL_SUPPORT", "TYPE_ACCOUNT_SUPPORT", "TYPE_INCIDENT_SUPPORT" ], "default": "TYPE_UNKNOWN", "x-displayname": "Support Ticket.", "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketType", "x-f5xc-description-short": "Several types of issues are supported, such as problems, questions. Unknown or empty ticket type Indicates a problem (e.g.", "x-f5xc-description-medium": "Several types of issues are supported, such as problems, questions. Unknown or empty ticket type Indicates a problem (e.g. Misconfiguration) Indicates a task (a request to do something) Indicates a question (billing, services related) Indicates an incident (something is not working) Indicates a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportSupportTicketType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TYPE_UNKNOWN\"", "example_yaml": "TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "customer_supportSupportTopic": { "type": "string", "description": "Support Topic indicates the list of topics for service tickets\n\nUnknown/empty priority\nACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST\nACCOUNT_SUPPORT_TOPIC_ACCOUNT\nACCOUNT_SUPPORT_TOPIC_BILLING\nACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE\nACCOUNT_SUPPORT_TOPIC_PUBLIC_IP\nACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE\nACCOUNT_SUPPORT_TOPIC_RMA\nACCOUNT_SUPPORT_TOPIC_TAX_EXEMPT_VERIFICATION\nACCOUNT_SUPPORT_TOPIC_OTHERS\nTECHNICAL_SUPPORT_TOPIC_CONFIGURATION_CHANGES\nTECHNICAL_SUPPORT_TOPIC_ERROR_MESSAGE\nTECHNICAL_SUPPORT_TOPIC_NEW_CONFIGURATION\nTECHNICAL_SUPPORT_TOPIC_PRODUCT_QUESTION\nTECHNICAL_SUPPORT_TOPIC_TROUBLESHOOTING\nTECHNICAL_SUPPORT_TOPIC_OTHERS\nINCIDENT_SUPPORT_TOPIC_LATENCY\nINCIDENT_SUPPORT_TOPIC_PERFORMANCE_DEGRADATION\nINCIDENT_SUPPORT_TOPIC_PARTIAL_OUTAGE\nINCIDENT_SUPPORT_TOPIC_COMPLETE_OUTAGE\nINCIDENT_SUPPORT_TOPIC_OTHERS\nTASK_TOPIC_PLAN_TRANSITION\nPROBLEM_TOPIC_SUPPORT_ALERT\nQUESTION_TOPIC_INFRASTRUCTURE\nTECHNICAL_SUPPORT_TOPIC_DELEGATED_DOMAIN_MIGRATION\nTECHNICAL_SUPPORT_TOPIC_TERRAFORM_PROVIDER.", "title": "SupportTopic", "enum": [ "TOPIC_UNKNOWN", "ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST", "ACCOUNT_SUPPORT_TOPIC_ACCOUNT", "ACCOUNT_SUPPORT_TOPIC_BILLING", "ACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE", "ACCOUNT_SUPPORT_TOPIC_PUBLIC_IP", "ACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE", "ACCOUNT_SUPPORT_TOPIC_RMA", "ACCOUNT_SUPPORT_TOPIC_TAX_EXEMPT_VERIFICATION", "ACCOUNT_SUPPORT_TOPIC_OTHERS", "TECHNICAL_SUPPORT_TOPIC_CONFIGURATION_CHANGES", "TECHNICAL_SUPPORT_TOPIC_ERROR_MESSAGE", "TECHNICAL_SUPPORT_TOPIC_NEW_CONFIGURATION", "TECHNICAL_SUPPORT_TOPIC_PRODUCT_QUESTION", "TECHNICAL_SUPPORT_TOPIC_TROUBLESHOOTING", "TECHNICAL_SUPPORT_TOPIC_OTHERS", "INCIDENT_SUPPORT_TOPIC_LATENCY", "INCIDENT_SUPPORT_TOPIC_PERFORMANCE_DEGRADATION", "INCIDENT_SUPPORT_TOPIC_PARTIAL_OUTAGE", "INCIDENT_SUPPORT_TOPIC_COMPLETE_OUTAGE", "INCIDENT_SUPPORT_TOPIC_OTHERS", "TASK_TOPIC_PLAN_TRANSITION", "PROBLEM_TOPIC_SUPPORT_ALERT", "QUESTION_TOPIC_INFRASTRUCTURE", "TECHNICAL_SUPPORT_TOPIC_DELEGATED_DOMAIN_MIGRATION", "TECHNICAL_SUPPORT_TOPIC_TERRAFORM_PROVIDER" ], "default": "TOPIC_UNKNOWN", "x-displayname": "Support Topic.", "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTopic", "x-f5xc-description-short": "Support Topic indicates the list of topics for service tickets Unknown/empty priority ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST...", "x-f5xc-description-medium": "Support Topic indicates the list of topics for service tickets Unknown/empty priority ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST ACCOUNT_SUPPORT_TOPIC_ACCOUNT ACCOUNT_SUPPORT_TOPIC_BILLING ACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE ACCOUNT_SUPPORT_TOPIC_PUBLIC_IP ACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for customer_supportSupportTopic", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TOPIC_UNKNOWN\"", "example_yaml": "TOPIC_UNKNOWN\n..." }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ioschemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaCRMInfo": { "type": "object", "description": "CRM Information.", "title": "CRM Information", "x-displayname": "CRM Information.", "x-ves-proto-message": "ves.io.schema.CRMInfo", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaCRMInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaErrorType__ves_io_schema_tenant_management_child_tenant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/ioschemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemacontactGlobalSpecType": { "type": "object", "description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.", "title": "Contact", "x-displayname": "Contact", "x-ves-proto-message": "ves.io.schema.contact.GlobalSpecType", "properties": { "address1": { "type": "string", "description": "Network address or location", "title": "address1", "x-displayname": "Address Line 1.", "x-ves-example": "1234 Main road.", "x-f5xc-example": "1234 Main road", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "address2": { "type": "string", "description": "Network address or location", "title": "address2", "x-displayname": "Address Line 2.", "x-ves-example": "P.O BOX 56.", "x-f5xc-example": "P.O BOX 56", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "city": { "type": "string", "description": "Configuration parameter for city", "title": "city", "x-displayname": "City", "x-ves-example": "Sunnyvale", "x-f5xc-example": "Sunnyvale", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_type": { "allOf": [ { "$ref": "#/components/schemas/contactContactType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Configuration parameter for country", "title": "country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "county": { "type": "string", "description": "Configuration parameter for county", "title": "county", "x-displayname": "County", "x-ves-example": "Santa Clara.", "x-f5xc-example": "Santa Clara", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phone_number": { "type": "string", "description": "Configuration parameter for phone number", "title": "phone_number", "x-displayname": "Phone Number.", "x-ves-example": "+11234567890.", "x-f5xc-example": "+11234567890", "x-f5xc-description-short": "Configuration parameter for phone number.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "Current state of the resource", "title": "state", "x-displayname": "State", "x-ves-example": "California.", "x-f5xc-example": "California", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state_code": { "type": "string", "description": "Configuration parameter for state code", "title": "state code", "x-displayname": "State Code.", "x-ves-example": "CA", "x-f5xc-example": "CA", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "zip_code": { "type": "string", "description": "IP address configuration", "title": "zip_code", "x-displayname": "ZIP code", "x-ves-example": "95054", "x-f5xc-example": "95054", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Instance of one single contact that can be used to communicate with customers.", "x-f5xc-description-medium": "Instance of one single contact that can be used to communicate with customers. Depending on contact type we use these details to send general communication (regular, physical mail) or invoices.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacontactGlobalSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacustomer_supportCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of customer_support", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.customer_support.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportCreateSpecType__ves_io_schema_tenant_management_child_tenant" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacustomer_supportCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacustomer_supportCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.customer_support.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportGetSpecType__ves_io_schema_tenant_management_child_tenant" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacustomer_supportCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacustomer_supportCreateSpecType__ves_io_schema_tenant_management_child_tenant": { "type": "object", "description": "Creates a new customer support ticket in our customer support provider system.", "title": "Create issue specification", "x-displayname": "Create Customer Support.", "x-ves-proto-message": "ves.io.schema.customer_support.CreateSpecType", "properties": { "category": { "type": "string", "description": "Ticket area further narrows down the ticket - infrastructure, application,\ndashboards can be examples.", "title": "Deprecated", "x-displayname": "Category", "x-ves-deprecated": "Replaced by 'topic'", "x-ves-example": "Infrastructure.", "x-f5xc-example": "infrastructure", "x-f5xc-description-short": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.", "x-f5xc-description-medium": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "comments": { "type": "array", "description": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.", "items": { "$ref": "#/components/schemas/customer_supportCommentType" }, "x-displayname": "Comments", "x-f5xc-example": "[\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]", "x-f5xc-description-short": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.", "x-f5xc-description-medium": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Customer's description of the issue (free text)", "x-displayname": "Description.", "x-ves-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John.", "x-f5xc-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John", "x-f5xc-description-short": "Customer's description of the issue (free text).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ongoing": { "type": "boolean", "description": "Ongoing is a flag that indicates whether the issue is ongoing or not.", "format": "boolean", "x-displayname": "Ongoing", "x-f5xc-description-short": "Ongoing is a flag that indicates whether the issue is ongoing or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "priority": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTicketPriority" } ], "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "product_data": { "type": "string", "description": "Product data is a free text field that can be used to describe the issue in more detail.", "x-displayname": "Product Data.", "x-ves-example": "Happening in the loreimpsum namespace and impacts most of our sites.", "x-f5xc-example": "Happening in the loreimpsum namespace and impacts most of our sites", "x-f5xc-description-short": "Product data is a free text field that can be used to describe the issue in more detail.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "relates_to": { "type": "array", "description": "Optional reference to any original ticket in case the ticket being created is a followup.", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Ticket which this one relates to.", "x-f5xc-description-short": "Optional reference to any original ticket in case the ticket being created is a followup.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportService" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTicketStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "subject": { "type": "string", "description": "Subject of the ticket.", "x-displayname": "Subject", "x-ves-example": "Problem logging into account.", "x-f5xc-example": "Problem logging into account", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timeline": { "type": "string", "description": "Timeline is a free text field that can be used to describe the issue in more detail.", "x-displayname": "Timeline", "x-ves-example": "Both LBs have been down since noon on Jan 5, 2022.", "x-f5xc-example": "Both LBs have been down since noon on Jan 5, 2022.", "x-f5xc-description-short": "Timeline is a free text field that can be used to describe the issue in more detail.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timezone": { "type": "string", "description": "Stores the timezone provided by the user at the time of support ticket creation.", "x-displayname": "Timezone", "x-ves-example": "(GMT 0:00) GB-Eire - Greenwich Mean Time.", "x-f5xc-example": "(GMT 0:00) GB-Eire - Greenwich Mean Time", "x-f5xc-description-short": "Stores the timezone provided by the user at the time of support ticket creation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Z][a-zA-Z_]+/[A-Z][a-zA-Z_]+$", "formatDescription": "IANA timezone database (e.g., America/New_York)", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "topic": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTopic" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tp_id": { "type": "string", "description": "ID assigned to this ticket by our support provider.", "x-displayname": "Third Party ID.", "x-ves-example": "123", "x-f5xc-example": "123", "x-f5xc-description-short": "ID assigned to this ticket by our support provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "type": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTicketType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Creates a new customer support ticket in our customer support provider system.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacustomer_supportCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacustomer_supportErrorCode": { "type": "string", "description": "ErrorCode is used to know the specific reason for customer support operation failures\n\n- EUNKNOWN: an unknown error occurred\n- EOK: Successful operation\n- E_NOT_CLOSED: Customer support ticket not closed\n- E_NOT_OPEN: Customer support ticket not open\n- E_NOT_ELIGIBLE: Customer is not eligible for this operation (i.e. When escalating a ticket then this indicates customer not being enterprise)\n- E_NOT_NOT_FOUND: Support ticket couldn't be found.", "title": "error code", "enum": [ "EUNKNOWN", "EOK", "E_NOT_CLOSED", "E_NOT_OPEN", "E_NOT_ELIGIBLE", "E_NOT_NOT_FOUND" ], "default": "EUNKNOWN", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.customer_support.ErrorCode", "x-f5xc-description-short": "ErrorCode is used to know the specific reason for customer support operation failures - EUNKNOWN: an unknown error occurred - EOK: Successful...", "x-f5xc-description-medium": "ErrorCode is used to know the specific reason for customer support operation failures - EUNKNOWN: an unknown error occurred - EOK: Successful operation - E_NOT_CLOSED: Customer support ticket not closed - E_NOT_OPEN: Customer support ticket not open - E_NOT_ELIGIBLE: Customer is not eligible for...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacustomer_supportErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EUNKNOWN\"", "example_yaml": "EUNKNOWN\n..." }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacustomer_supportGetSpecType__ves_io_schema_tenant_management_child_tenant": { "type": "object", "description": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.", "title": "Get issue specification", "x-displayname": "GET Customer Support.", "x-ves-proto-message": "ves.io.schema.customer_support.GetSpecType", "properties": { "author_name": { "type": "string", "description": "Author of the comment (as a name)", "x-displayname": "Author", "x-ves-example": "John Smith.", "x-f5xc-example": "John Smith", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "category": { "type": "string", "description": "Ticket area further narrows down the ticket - infrastructure, application,\ndashboards can be examples.", "title": "Deprecated", "x-displayname": "Category", "x-ves-deprecated": "Replaced by 'topic'", "x-ves-example": "Infrastructure.", "x-f5xc-example": "infrastructure", "x-f5xc-description-short": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.", "x-f5xc-description-medium": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "comments": { "type": "array", "description": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.", "items": { "$ref": "#/components/schemas/customer_supportCommentType" }, "x-displayname": "Comments", "x-f5xc-example": "[\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]", "x-f5xc-description-short": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.", "x-f5xc-description-medium": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "created_at": { "type": "string", "description": "Created at timestamp.", "format": "date-time", "x-displayname": "Created at.", "x-ves-example": "01-01-1970T00:00:00Z.", "x-f5xc-example": "01-01-1970T00:00:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "custom_fields": { "type": "array", "description": "Any custom fields (read only). Custom fields have to be defined first before they'RE used.\nCustom fields have no direct impact on the issue but help to better categorize issues.", "items": { "type": "string" }, "x-displayname": "Custom Fields.", "x-ves-example": "Custom-field-ID:custom-field-value.", "x-f5xc-example": "custom-field-id:custom-field-value", "x-f5xc-description-short": "Any custom fields (read only). Custom fields have to be defined first before they'RE used.", "x-f5xc-description-medium": "Any custom fields (read only). Custom fields have to be defined first before they'RE used. Custom fields have no direct impact on the issue but help to better categorize issues.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Customer's description of the issue (free text)", "x-displayname": "Description.", "x-ves-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John.", "x-f5xc-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John", "x-f5xc-description-short": "Customer's description of the issue (free text).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "escalated": { "type": "boolean", "description": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it.\nOnly existing enterprise customer tickets with priority other then PRIORITY_URGENT can be escalated.", "format": "boolean", "x-displayname": "Escalated", "x-f5xc-description-short": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it.", "x-f5xc-description-medium": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it. Only existing enterprise customer tickets with priority other then PRIORITY_URGENT can be escalated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "followups": { "type": "array", "description": "Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket.\nUsed in situations when the original ticket has been closed but the issue occurred again or a new problem occurred in relation to this closed ticket.", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Followup tickets.", "x-f5xc-description-short": "Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket.", "x-f5xc-description-medium": "Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket. Used in situations when the original ticket has been closed but the issue occurred again or a new problem occurred in relation to this closed ticket.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ongoing": { "type": "boolean", "description": "Ongoing is a flag that indicates whether the issue is ongoing or not.", "format": "boolean", "x-displayname": "Ongoing", "x-f5xc-description-short": "Ongoing is a flag that indicates whether the issue is ongoing or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "priority": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTicketPriority" } ], "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "product_data": { "type": "string", "description": "Product data is a free text field that can be used to describe the issue in more detail.", "x-displayname": "Product Data.", "x-ves-example": "Happening in the loreimpsum namespace and impacts most of our sites.", "x-f5xc-example": "Happening in the loreimpsum namespace and impacts most of our sites", "x-f5xc-description-short": "Product data is a free text field that can be used to describe the issue in more detail.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "relates_to": { "type": "array", "description": "Optional reference to any original ticket in case the ticket being created is a followup.", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Ticket which this one relates to.", "x-f5xc-description-short": "Optional reference to any original ticket in case the ticket being created is a followup.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportService" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTicketStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "subject": { "type": "string", "description": "Subject of the ticket.", "x-displayname": "Subject", "x-ves-example": "Problem logging into account.", "x-f5xc-example": "Problem logging into account", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "array", "description": "Tags help to further categorize issues (read-only field)", "items": { "type": "string" }, "x-displayname": "Tags", "x-ves-example": "UAM,UI", "x-f5xc-example": "UAM,UI", "x-f5xc-description-short": "Tags help to further categorize issues (read-only field).", "x-f5xc-constraints": { "constraintType": "array", "category": "metadata", "minItems": 0, "maxItems": 100, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timeline": { "type": "string", "description": "Timeline is a free text field that can be used to describe the issue in more detail.", "x-displayname": "Timeline", "x-ves-example": "Both LBs have been down since noon on Jan 5, 2022.", "x-f5xc-example": "Both LBs have been down since noon on Jan 5, 2022.", "x-f5xc-description-short": "Timeline is a free text field that can be used to describe the issue in more detail.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timezone": { "type": "string", "description": "Stores the timezone provided by the user at the time of support ticket creation.", "x-displayname": "Timezone", "x-ves-example": "(GMT 0:00) GB-Eire - Greenwich Mean Time.", "x-f5xc-example": "(GMT 0:00) GB-Eire - Greenwich Mean Time", "x-f5xc-description-short": "Stores the timezone provided by the user at the time of support ticket creation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Z][a-zA-Z_]+/[A-Z][a-zA-Z_]+$", "formatDescription": "IANA timezone database (e.g., America/New_York)", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "topic": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTopic" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tp_id": { "type": "string", "description": "ID assigned to this ticket by our support provider.", "x-displayname": "Third Party ID.", "x-ves-example": "123", "x-f5xc-example": "123", "x-f5xc-description-short": "ID assigned to this ticket by our support provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "type": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTicketType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "update_at": { "type": "string", "description": "Date of the last modification.", "format": "date-time", "x-displayname": "Updated at.", "x-ves-example": "01-01-1970T00:00:00Z.", "x-f5xc-example": "01-01-1970T00:00:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user": { "type": "array", "description": "Logged in user (read-only)", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "User", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "via": { "type": "object", "description": "Via describes the way of a ticket reaching us (read-only)", "x-displayname": "Via", "x-ves-example": "['channel':'web', 'source': '{}']", "x-f5xc-example": "['channel':'web', 'source''{}']", "x-f5xc-description-short": "Via describes the way of a ticket reaching us (read-only).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.", "x-f5xc-description-medium": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacustomer_supportGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacustomer_supportListResponseItem": { "type": "object", "description": "By default a summary of customer_support is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of customer_support", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.customer_support.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this customer_support.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this customer_support.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this customer_support.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this customer_support.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates customer_support is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates customer_support is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportGetSpecType__ves_io_schema_tenant_management_child_tenant" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this customer_support.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this customer_support.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this customer_support.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/schemacustomer_supportStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this customer_support.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this customer_support.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of customer_support is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of customer_support is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacustomer_supportListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacustomer_supportStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Customer support status", "x-displayname": "Customer support object.", "x-ves-proto-message": "ves.io.schema.customer_support.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacustomer_supportStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "support", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schematenant_managementCommentRequest": { "type": "object", "description": "Adds a new comment to an existing customer support ticket.", "title": "CommentRequest", "x-displayname": "Customer support ticket comment request.", "x-ves-proto-message": "ves.io.schema.tenant_management.CommentRequest", "properties": { "attachments": { "type": "array", "description": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.", "title": "Binary attachments", "items": { "$ref": "#/components/schemas/customer_supportAttachmentType" }, "x-displayname": "Attachments.", "x-f5xc-description-short": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "comment": { "type": "string", "description": "Comment on a existing customer support ticket.", "title": "comment", "x-displayname": "Comment", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Comment on a existing customer support ticket.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tp_id": { "type": "string", "description": "ID assigned to this ticket by our support provider.", "title": "Third party ID", "x-displayname": "Third Party ID.", "x-ves-example": "123", "x-f5xc-example": "123", "x-f5xc-description-short": "ID assigned to this ticket by our support provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Adds a new comment to an existing customer support ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematenant_managementCommentRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematenant_managementPriorityRequest": { "type": "object", "description": "Priority of an existing customer support ticket.", "title": "PriorityRequest", "x-displayname": "Customer support ticket priority request.", "x-ves-proto-message": "ves.io.schema.tenant_management.PriorityRequest", "properties": { "priority": { "allOf": [ { "$ref": "#/components/schemas/customer_supportSupportTicketPriority" } ], "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tp_id": { "type": "string", "description": "ID assigned to this ticket by our support provider.", "title": "Third party ID", "x-displayname": "Third Party ID.", "x-ves-example": "123", "x-f5xc-example": "123", "x-f5xc-description-short": "ID assigned to this ticket by our support provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Priority of an existing customer support ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematenant_managementPriorityRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementAccessInfo": { "type": "object", "description": "Access details of a managed tenant.", "title": "AccessInfo", "x-displayname": "Access Info.", "x-ves-proto-message": "ves.io.schema.tenant_management.AccessInfo", "properties": { "groups": { "type": "array", "description": "List of local user group association to user groups in the managed tenant.", "title": "groups", "items": { "$ref": "#/components/schemas/tenant_managementGroupAssignmentType" }, "x-displayname": "Groups", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of local user group association to user groups in the managed tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link": { "allOf": [ { "$ref": "#/components/schemas/viewsLinkRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "link", "gated_by": null, "required": false, "cardinality": "single" } ] }, "name": { "type": "string", "description": "Name of the managed tenant config object. It can be used as known identifier.", "title": "Name", "x-displayname": "Name", "x-ves-example": "L1-support.", "x-f5xc-example": "l1-support", "x-f5xc-description-short": "Name of the managed tenant config object. It can be used as known identifier.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "support_request_count": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementSupportTicketInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_status": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementTenantStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementAccessInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementAllTenantsTicketSummary": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.AllTenantsTicketSummary", "properties": { "open_support_tickets_count": { "type": "integer", "description": "Number of support tickets open in all tenants.", "title": "Open Support Tickets Count", "format": "int32", "x-displayname": "Open Support Tickets Count.", "x-f5xc-description-short": "Number of support tickets open in all tenants.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementAllTenantsTicketSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementCTListToCTM": { "type": "object", "description": "Child tenants reference to child tenant manager.", "title": "CTListToCTM", "x-displayname": "CTListToCTM.", "x-ves-proto-message": "ves.io.schema.tenant_management.CTListToCTM", "properties": { "child_tenant_manager": { "type": "string", "description": "Name of the child tenant manager where child tenants needs to be referred.", "title": "Child Tenant Manager", "x-displayname": "Child Tenant Manager.", "x-ves-example": "Ctm-1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ctm-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of the child tenant manager where child tenants needs to be referred.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "child_tenants": { "type": "array", "description": "List of child tenants refer to a child tenant manager.", "title": "Child Tenants", "minItems": 1, "items": { "type": "string" }, "x-displayname": "Child Tenants.", "x-ves-example": "Child-tenant-1,child-tenant-2.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.not_empty": "true", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "child-tenant-1,child-tenant-2", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.not_empty": "true", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of child tenants refer to a child tenant manager.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Child tenants reference to child tenant manager.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementCTListToCTM", "required_fields": [ "child_tenant_manager", "child_tenants" ], "mutually_exclusive_groups": [], "example_json": "{\n \"child_tenant_manager\": \"ctm-1\",\n \"child_tenants\": [\n \"value\"\n ]\n}", "example_yaml": "child_tenant_manager: ctm-1\nchild_tenants:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementCTTicketSummary": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.CTTicketSummary", "properties": { "open_support_tickets_count": { "type": "integer", "description": "Number of support tickets open in child tenant.", "title": "Open Support Tickets Count", "format": "int32", "x-displayname": "Open Support Tickets Count.", "x-f5xc-description-short": "Number of support tickets open in child tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementCTTicketSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementGetByTpIdResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC for customer_support in child / managed tenant.", "title": "GetByTpIdResponse", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.GetByTpIdResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemacustomer_supportGetSpecType__ves_io_schema_tenant_management_child_tenant" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Output message of the 'GET' RPC for customer_support in child / managed tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementGetByTpIdResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementGroupAssignmentType": { "type": "object", "description": "Shape for specifying user group association to user groups in a managed tenant.", "title": "GroupAssignmentType", "x-displayname": "Group to Assign.", "x-ves-proto-message": "ves.io.schema.tenant_management.GroupAssignmentType", "properties": { "group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "group", "gated_by": null, "required": false, "cardinality": "single" } ] }, "managed_tenant_groups": { "type": "array", "description": "List of group names in managed tenant (MT).\nNote - To properly establish access, admin of managed tenant need to create corresponding Allowed Tenant\nconfiguration object with access to use same group names. Once it's setup, when user from original tenant\naccess managed tenant, underlying roles from managed tenant will be applied to user.", "title": "managed_tenant_groups", "maxItems": 32, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Managed Tenant Groups.", "x-ves-example": "User-group1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "user-group1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of group names in managed tenant (MT).", "x-f5xc-description-medium": "List of group names in managed tenant (MT). Note - To properly establish access, admin of managed tenant need to create corresponding Allowed Tenant configuration object with access to use same group names. Once it's setup, when user from original tenant access managed tenant, underlying roles...", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape for specifying user group association to user groups in a managed tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementGroupAssignmentType", "required_fields": [ "managed_tenant_groups" ], "mutually_exclusive_groups": [], "example_json": "{\n \"managed_tenant_groups\": [\n \"value\"\n ]\n}", "example_yaml": "managed_tenant_groups:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementListSupportTicketResponse": { "type": "object", "description": "This is the output message of 'ListSupportTicketResponse' RPC.", "title": "ListSupportTicketResponse", "x-displayname": "List Support Ticket Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.ListSupportTicketResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_tenant_management_child_tenant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/schemacustomer_supportListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Output message of 'ListSupportTicketResponse' RPC.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementListSupportTicketResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementSupportTicketInfo": { "type": "object", "x-ves-oneof-field-supportticketinfochoice": "[\"all_tenants_summary\",\"ct_summary\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketInfo", "properties": { "all_tenants_summary": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementAllTenantsTicketSummary" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ct_summary" ] }, "ct_summary": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementCTTicketSummary" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_tenants_summary" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementSupportTicketInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementSupportTicketRequest": { "type": "object", "description": "Input request to fetch customer_support ticket in child / managed tenant.", "title": "SupportTicketRequest", "x-displayname": "Support Ticket Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketRequest", "properties": { "tp_id": { "type": "string", "description": "ID assigned to this ticket by our support provider.", "title": "Third party ID", "x-displayname": "Third Party ID.", "x-ves-example": "123", "x-f5xc-example": "123", "x-f5xc-description-short": "ID assigned to this ticket by our support provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Input request to fetch customer_support ticket in child / managed tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementSupportTicketRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementTenantStatus": { "type": "string", "description": "Status indicates status of a tenant, like active, to be deleted, disabled and so on\n\ntenant is active\ntenant is disabled\ntenant is about to be deleted\nany other status then active.", "title": "TenantStatus", "enum": [ "TENANT_STATUS_ACTIVE", "TENANT_STATUS_DISABLED", "TENANT_STATUS_TO_BE_DELETED", "TENANT_STATUS_INACTIVE" ], "default": "TENANT_STATUS_ACTIVE", "x-displayname": "Status", "x-ves-proto-enum": "ves.io.schema.tenant_management.TenantStatus", "x-f5xc-description-short": "Status indicates status of a tenant, like active, to be deleted, disabled and so on tenant is active tenant is disabled tenant is about to be...", "x-f5xc-description-medium": "Status indicates status of a tenant, like active, to be deleted, disabled and so on tenant is active tenant is disabled tenant is about to be deleted any other status then active.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementTenantStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TENANT_STATUS_ACTIVE\"", "example_yaml": "TENANT_STATUS_ACTIVE\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of child_tenant", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantCreateSpecType": { "type": "object", "description": "Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.", "title": "Create child tenant", "x-displayname": "Child Tenant.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.CreateSpecType", "properties": { "child_tenant_manager": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "child_tenant_manager", "gated_by": null, "required": false, "cardinality": "single" } ] }, "company_name": { "type": "string", "description": "Company name (enterprise only)", "maxLength": 256, "x-displayname": "Company Name.", "x-ves-example": "F5", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "f5", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_detail": { "allOf": [ { "$ref": "#/components/schemas/schemacontactGlobalSpecType" } ], "x-f5xc-description-short": "Configuration parameter for contact detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "customer_info": { "allOf": [ { "$ref": "#/components/schemas/child_tenantCustomerInfo" } ], "x-f5xc-description-short": "Configuration parameter for customer info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Text string that will be used for the subdomain of the new Child Tenant.\nThis will be where users will directly log into the new Child Tenant. Example domain.console.ves.volterra.I/O.", "minLength": 5, "maxLength": 17, "x-displayname": "Domain", "x-ves-example": "F5 Distributed Cloud.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "17", "ves.io.schema.rules.string.min_len": "5", "ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"volterra\\\",\\\"f5\\\"]", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "F5 Distributed Cloud", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "17", "ves.io.schema.rules.string.min_len": "5", "ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"F5 Distributed Cloud\\\",\\\"f5\\\"]", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Text string that will be used for the subdomain of the new Child Tenant. This will be where users will directly log into the new Child Tenant.", "x-f5xc-description-medium": "Text string that will be used for the subdomain of the new Child Tenant. This will be where users will directly log into the new Child Tenant. Example domain.console.ves.volterra.I/O.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 5, "maxLength": 17, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant_profile": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "tenant_profile", "field_path": "tenant_profile", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.", "x-f5xc-description-medium": "Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantCreateSpecType", "required_fields": [ "domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain\": \"F5 Distributed Cloud\"\n}", "example_yaml": "domain: F5 Distributed Cloud" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantFSMState": { "type": "string", "description": "- StateInitializing: StateInitializing\n\nSuccessfully received Child Tenant creation request and has started processing the tenant creation.\n- StateCreating: StateCreating\n\nChild Tenant is in initial bootstrapping process.\n- StateCreateFailed: StateCreateFailed\n\nChild Tenant initial bootstrapping failed\n- StateInactive: StateInactive\n\nChild tenant state when hierarchical access between parent and child node could not be established\n- StateActive: StateActive\n\nChild Tenant is active and ready for access.\n- StateConfiguring: StateConfiguring\n\nProcessing additional configuration for the Child Tenant.\n- StateConfiguringFailed: StateConfiguringFailed\n\nAdditional configuration for the Child Tenant has failed\n- StateDeleteInProgress: StateDeleteInProgress\n\nChild tenant deletion is in progress\n- StateDeleteFailed: StateDeleteFailed\n\nChild tenant deletion failed.", "title": "States", "enum": [ "StateInitializing", "StateCreating", "StateCreateFailed", "StateInactive", "StateActive", "StateConfiguring", "StateConfiguringFailed", "StateDeleteInProgress", "StateDeleteFailed" ], "default": "StateInitializing", "x-displayname": "States", "x-ves-proto-enum": "ves.io.schema.tenant_management.child_tenant.FSMState", "x-f5xc-description-short": "- StateInitializing: StateInitializing Successfully received Child Tenant creation request and has started processing the tenant creation. ...", "x-f5xc-description-medium": "- StateInitializing: StateInitializing Successfully received Child Tenant creation request and has started processing the tenant creation. - StateCreating: StateCreating Child Tenant is in initial bootstrapping process. - StateCreateFailed: StateCreateFailed Child Tenant initial bootstrapping...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantFSMState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"StateInitializing\"", "example_yaml": "StateInitializing\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read child_tenant", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/child_tenantReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_managementchild_tenantStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantGetSpecType": { "type": "object", "description": "GET child_tenant reads a given object from storage backend for metadata.namespace.", "title": "Get child tenant", "x-displayname": "GET Child Tenant.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.GetSpecType", "properties": { "child_tenant_manager": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "child_tenant_manager", "gated_by": null, "required": false, "cardinality": "single" } ] }, "company_name": { "type": "string", "description": "Company name (enterprise only)", "maxLength": 256, "x-displayname": "Company Name.", "x-ves-example": "F5", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "f5", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_detail": { "allOf": [ { "$ref": "#/components/schemas/schemacontactGlobalSpecType" } ], "x-f5xc-description-short": "Configuration parameter for contact detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "crm_details": { "allOf": [ { "$ref": "#/components/schemas/schemaCRMInfo" } ], "x-f5xc-description-short": "Configuration parameter for crm details.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "customer_info": { "allOf": [ { "$ref": "#/components/schemas/child_tenantCustomerInfo" } ], "x-f5xc-description-short": "Configuration parameter for customer info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Text string that will be used for the subdomain of the new Child Tenant.\nThis will be where users will directly log into the new Child Tenant. Example domain.console.ves.volterra.I/O.", "minLength": 5, "maxLength": 17, "x-displayname": "Domain", "x-ves-example": "F5 Distributed Cloud.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "17", "ves.io.schema.rules.string.min_len": "5", "ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"volterra\\\",\\\"f5\\\"]", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "F5 Distributed Cloud", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "17", "ves.io.schema.rules.string.min_len": "5", "ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"F5 Distributed Cloud\\\",\\\"f5\\\"]", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Text string that will be used for the subdomain of the new Child Tenant. This will be where users will directly log into the new Child Tenant.", "x-f5xc-description-medium": "Text string that will be used for the subdomain of the new Child Tenant. This will be where users will directly log into the new Child Tenant. Example domain.console.ves.volterra.I/O.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 5, "maxLength": 17, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "status": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantFSMState" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tenant_profile": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "tenant_profile", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "GET child_tenant reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantGetSpecType", "required_fields": [ "domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain\": \"F5 Distributed Cloud\"\n}", "example_yaml": "domain: F5 Distributed Cloud" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of child_tenant", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_tenant_management_child_tenant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/tenant_managementchild_tenantListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantListResponseItem": { "type": "object", "description": "By default a summary of child_tenant is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of child_tenant", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this child_tenant.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this child_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this child_tenant.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this child_tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates child_tenant is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates child_tenant is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this child_tenant.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this child_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this child_tenant.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_managementchild_tenantStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this child_tenant.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of child_tenant is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of child_tenant is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantReplaceSpecType": { "type": "object", "description": "Replaces attributes of a child_tenant configuration.", "title": "Replace child tenant", "x-displayname": "Replace Child Tenant.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.ReplaceSpecType", "properties": { "company_name": { "type": "string", "description": "Company name (enterprise only)", "maxLength": 256, "x-displayname": "Company Name.", "x-ves-example": "F5", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "f5", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_detail": { "allOf": [ { "$ref": "#/components/schemas/schemacontactGlobalSpecType" } ], "x-f5xc-description-short": "Configuration parameter for contact detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "customer_info": { "allOf": [ { "$ref": "#/components/schemas/child_tenantCustomerInfo" } ], "x-f5xc-description-short": "Configuration parameter for customer info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Replaces attributes of a child_tenant configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenantStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "A child tenant direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenantStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsLinkRefType": { "type": "object", "description": "LinkRefType\nThis message defines a reference to hyperlink that can be accessed via web.", "x-ves-proto-message": "ves.io.schema.views.LinkRefType", "properties": { "href": { "type": "string", "description": "Referred link's location. This can be treated as equivalent of href in HTML.", "title": "HyperlinkRef", "minLength": 1, "maxLength": 512, "x-displayname": "Hyperlink reference.", "x-ves-example": "https://f5.com/link/resource_a.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "https://f5.com/link/resource_a", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Referred link's location. This can be treated as equivalent of href in HTML.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name to use for displaying above link in href.", "title": "Name", "minLength": 1, "maxLength": 256, "x-displayname": "Link Name", "x-ves-example": "Resource A.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "Resource A", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Name to use for displaying above link in href.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "LinkRefType This message defines a reference to hyperlink that can be accessed via web.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsLinkRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerCTBannerNotification": { "type": "object", "description": "CTBannerNotification.", "x-displayname": "CTBannerNotification.", "x-ves-oneof-field-content_choice": "[\"content_html\",\"content_text\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.CTBannerNotification", "properties": { "content_html": { "type": "string", "description": "Exclusive with [content_text]\nHTML content of the specific notification.", "x-displayname": "Content HTML.", "x-f5xc-description-short": "Exclusive with [content_text] HTML content of the specific notification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "content_text" ] }, "content_text": { "type": "string", "description": "Exclusive with [content_html]\nText content of the specific notification.", "x-displayname": "Content text.", "x-f5xc-description-short": "Exclusive with [content_html] Text content of the specific notification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "content_html" ] }, "time_period": { "allOf": [ { "$ref": "#/components/schemas/schemaDateRange" } ], "x-f5xc-description-short": "Configuration parameter for time period.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "title": { "type": "string", "description": "Title of the specific notification in plain text.", "x-displayname": "Title", "x-ves-example": "Maintenance.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "maintenance", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Title of the specific notification in plain text.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerCTBannerNotification", "required_fields": [ "title" ], "mutually_exclusive_groups": [], "example_json": "{\n \"title\": \"maintenance\"\n}", "example_yaml": "title: maintenance" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerCTGroupAssignmentType": { "type": "object", "description": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "title": "CTGroupAssignmentType", "x-displayname": "Group to Assign.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.CTGroupAssignmentType", "properties": { "child_tenant_groups": { "type": "array", "description": "List of group names in child tenant.\nNote - To establish access, child tenant group names must be a subset of child tenant groups configured in tenant profile.\nOnce it's setup, when user from msp tenant access child tenant, underlying roles from child tenant will be applied to user.", "title": "child_tenant_groups", "maxItems": 32, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Child Tenant User Groups.", "x-ves-example": "User-group1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "user-group1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-medium": "List of group names in child tenant. Note - To establish access, child tenant group names must be a subset of child tenant groups configured in tenant profile. Once it's setup, when user from msp tenant access child tenant, underlying roles from child tenant will be applied to user.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "group", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerCTGroupAssignmentType", "required_fields": [ "child_tenant_groups" ], "mutually_exclusive_groups": [], "example_json": "{\n \"child_tenant_groups\": [\n \"value\"\n ]\n}", "example_yaml": "child_tenant_groups:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerCTListResponseItem": { "type": "object", "description": "Child Tenant Information.", "title": "CTListResponseItem", "x-displayname": "Child Tenant List Response Item.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.CTListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this child_tenant.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this child_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this child_tenant.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this child_tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates child_tenant is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates child_tenant is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenantGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this child_tenant.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this child_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this child_tenant.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_managementchild_tenantStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this child_tenant.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerCTListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a child_tenant_manager", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerListChildTenantsByCTMResp": { "type": "object", "description": "Response to GET list of Child Tenant for a given CTM.", "title": "ListChildTenantsByCTMResp", "x-displayname": "List Child Tenants for a given CTM Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.ListChildTenantsByCTMResp", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "List of Child Tenants referring to input CTM.", "title": "Child Tenants", "items": { "$ref": "#/components/schemas/child_tenant_managerCTListResponseItem" }, "x-displayname": "Child Tenants.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of Child Tenants referring to input CTM.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to GET list of Child Tenant for a given CTM.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerListChildTenantsByCTMResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerMigrateCTMChildTenantsReq": { "type": "object", "description": "Request to migrate child tenants to a specified child tenant manager.", "title": "MigrateCTMChildTenantsReq", "x-displayname": "Migrate CTM child tenants request.", "x-ves-oneof-field-migratectmchildtenantsreqchoice": "[\"ct_list_to_target_ctm\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.MigrateCTMChildTenantsReq", "properties": { "ct_list_to_target_ctm": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementCTListToCTM" } ], "x-f5xc-description-short": "Configuration parameter for ct list to target ctm.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the child tenant manager.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to migrate child tenants to a specified child tenant manager.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerMigrateCTMChildTenantsReq", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"value\"\n}", "example_yaml": "name: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerMigrateCTMChildTenantsResp": { "type": "object", "description": "Response of migrating child tenants to a specified CTM.", "title": "MigrateCTMChildTenantsResp", "x-displayname": "Migrate CTM child tenants response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.MigrateCTMChildTenantsResp", "properties": { "child_tenant_manager": { "type": "string", "description": "Name of the child tenant manager to which all the child tenants are migrating to.", "title": "Child tenant manager", "x-displayname": "Child tenant manager.", "x-f5xc-description-short": "Name of the child tenant manager to which all the child tenants are migrating to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "errors": { "type": "array", "description": "Errors(if any) while migrating child tenants.", "title": "Errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while migrating child tenants.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "migrate_initiated_for_ct_count": { "type": "integer", "description": "This specifies the total number of child tenants for which migration has been initiated to a specified CTM.", "title": "Migrate initiated for child tenants count", "format": "int32", "x-displayname": "Migrate initiated for child tenants count.", "x-f5xc-description-short": "Specifies the total number of child tenants for which migration has been initiated to a specified CTM.", "x-f5xc-description-medium": "Specifies the total number of child tenants for which migration has been initiated to a specified CTM.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_ct_count": { "type": "integer", "description": "This specifies total number of child tenants requested to be migrated to a specified CTM.", "title": "Total child tenant count", "format": "int32", "x-displayname": "Total child tenant count requested for migration.", "x-f5xc-description-short": "Specifies total number of child tenants requested to be migrated to a specified CTM.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response of migrating child tenants to a specified CTM.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerMigrateCTMChildTenantsResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a child_tenant_manager", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "child_tenant_managerReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for child_tenant_managerReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaDateRange": { "type": "object", "description": "Date range is for selecting a date range.", "title": "DateRange", "x-displayname": "Date Range.", "x-ves-proto-message": "ves.io.schema.DateRange", "properties": { "end_date": { "type": "string", "description": "Contains end date.", "title": "end_date", "format": "date-time", "x-displayname": "End Date", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "start_date": { "type": "string", "description": "Contains start date.", "title": "start_date", "format": "date-time", "x-displayname": "Start Date.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Date range is for selecting a date range.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaDateRange", "required_fields": [ "end_date", "start_date" ], "mutually_exclusive_groups": [], "example_json": "{\n \"end_date\": \"value\",\n \"start_date\": \"value\"\n}", "example_yaml": "end_date: value\nstart_date: value" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of child_tenant_manager", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerCreateSpecType": { "type": "object", "description": "Creates a child_tenant_manager config instance. Name of the object is the name of the child tenant manager to be created.", "title": "Create child tenant manager", "x-displayname": "Child Tenant Manager.", "x-ves-displayorder": "1,4", "x-ves-oneof-field-tenant_owner_choice": "[\"tenant_owner_group\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.CreateSpecType", "properties": { "group_assignments": { "type": "array", "description": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "maxItems": 16, "items": { "$ref": "#/components/schemas/child_tenant_managerCTGroupAssignmentType" }, "x-displayname": "Group Mapping.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_owner_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "tenant_owner_group", "gated_by": { "choice": "tenant_owner_choice" }, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Creates a child_tenant_manager config instance. Name of the object is the name of the child tenant manager to be created.", "x-f5xc-description-medium": "Creates a child_tenant_manager config instance. Name of the object is the name of the child tenant manager to be created.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read child_tenant_manager", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/child_tenant_managerReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerGetSpecType": { "type": "object", "description": "GET child_tenant_manager reads a given object from storage backend for metadata.namespace.", "title": "Get child tenant manager", "x-displayname": "GET Child Tenant Manager.", "x-ves-displayorder": "1,4", "x-ves-oneof-field-tenant_owner_choice": "[\"tenant_owner_group\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.GetSpecType", "properties": { "banner_message": { "allOf": [ { "$ref": "#/components/schemas/child_tenant_managerCTBannerNotification" } ], "x-f5xc-description-short": "Configuration parameter for banner message.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_assignments": { "type": "array", "description": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "maxItems": 16, "items": { "$ref": "#/components/schemas/child_tenant_managerCTGroupAssignmentType" }, "x-displayname": "Group Mapping.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_owner_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "tenant_owner_group", "gated_by": { "choice": "tenant_owner_choice" }, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "GET child_tenant_manager reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of child_tenant_manager", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerListResponseItem": { "type": "object", "description": "By default a summary of child_tenant_manager is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of child_tenant_manager", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this child_tenant_manager.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this child_tenant_manager.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this child_tenant_manager.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this child_tenant_manager.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates child_tenant_manager is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates child_tenant_manager is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementchild_tenant_managerGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this child_tenant_manager.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this child_tenant_manager.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this child_tenant_manager.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this child_tenant_manager.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this child_tenant_manager.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of child_tenant_manager is returned in 'List'.", "x-f5xc-description-medium": "By default a summary of child_tenant_manager is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementchild_tenant_managerReplaceSpecType": { "type": "object", "description": "Replaces attributes of a child_tenant_manager configuration.", "title": "Replace child tenant manager", "x-displayname": "Replace Child Tenant Manager.", "x-ves-displayorder": "1,4", "x-ves-oneof-field-tenant_owner_choice": "[\"tenant_owner_group\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.ReplaceSpecType", "properties": { "banner_message": { "allOf": [ { "$ref": "#/components/schemas/child_tenant_managerCTBannerNotification" } ], "x-f5xc-description-short": "Configuration parameter for banner message.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_assignments": { "type": "array", "description": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "maxItems": 16, "items": { "$ref": "#/components/schemas/child_tenant_managerCTGroupAssignmentType" }, "x-displayname": "Group Mapping.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "The Group Mapping field is used to associate local user groups with user groups in child tenants.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_owner_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "tenant_owner_group", "gated_by": { "choice": "tenant_owner_choice" }, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Replaces attributes of a child_tenant_manager configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementchild_tenant_managerReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_user_accountGetOnboardedCloudNetworksResponse": { "type": "object", "description": "Response to GET onboarded cloud networks for given cloud user account.", "title": "GetOnboardedCloudNetworksResponse", "x-displayname": "GET Onboarded Cloud Network Response.", "x-ves-proto-message": "ves.io.schema.cloud_user_account.GetOnboardedCloudNetworksResponse", "properties": { "onboarded_network": { "type": "array", "description": "Onboarded networks.", "title": "Onboarded Networks", "items": { "$ref": "#/components/schemas/cloud_user_accountNetworkInfoType" }, "x-displayname": "Onboarded Networks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to GET onboarded cloud networks for given cloud user account.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_user_accountGetOnboardedCloudNetworksResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "cloud_user_accountNetworkInfoType": { "type": "object", "description": "Network Info type.", "title": "Network Info Type", "x-displayname": "Network Info Type.", "x-ves-proto-message": "ves.io.schema.cloud_user_account.NetworkInfoType", "properties": { "network_id": { "type": "string", "description": "Network ID.", "title": "Network ID", "x-displayname": "Network ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "network_management_type": { "allOf": [ { "$ref": "#/components/schemas/cloud_user_accountNetworkManagementType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_name": { "type": "string", "description": "Network Name.", "title": "Network Name", "x-displayname": "Network Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "string", "description": "Network Region.", "title": "Network Region", "x-displayname": "Network Region.", "x-f5xc-example": "us-west-2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "used_for_cloud_connects": { "type": "array", "description": "Refers list of cloud connects using this network.", "title": "Used For Cloud Connects", "maxItems": 10, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Network used for Cloud Connects.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "10" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "10" }, "x-f5xc-description-short": "Refers list of cloud connects using this network.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 10, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "used_for_securemesh_sites": { "type": "array", "description": "Refers list of securemesh sites using this network.", "title": "Used For Securemesh Sites", "maxItems": 10, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Network used for Securemesh Sites.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "10" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "10" }, "x-f5xc-description-short": "Refers list of securemesh sites using this network.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 10, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_user_accountNetworkInfoType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "cloud_user_accountNetworkManagementType": { "type": "string", "description": "Network Management Type defines the type for each network.\n\nUnknown Network Management Type\nCustomer Managed Network\nF5 Managed Network.", "title": "Network Type", "enum": [ "NETWORK_MANAGEMENT_TYPE_NONE", "CUSTOMER_MANAGED", "F5_MANAGED" ], "default": "NETWORK_MANAGEMENT_TYPE_NONE", "x-displayname": "Network Management Type.", "x-ves-proto-enum": "ves.io.schema.cloud_user_account.NetworkManagementType", "x-f5xc-description-short": "Network Management Type defines the type for each network. Unknown Network Management Type Customer Managed Network F5 Managed Network.", "x-f5xc-description-medium": "Network Management Type defines the type for each network. Unknown Network Management Type Customer Managed Network F5 Managed Network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_user_accountNetworkManagementType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NETWORK_MANAGEMENT_TYPE_NONE\"", "example_yaml": "NETWORK_MANAGEMENT_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "cloud_user_accountValidateCloudUserAccountResponse": { "type": "object", "description": "Response to validate cloud user account.", "title": "ValidateCloudUserAccountResponse", "x-displayname": "Validate Cloud User Account Response.", "x-ves-proto-message": "ves.io.schema.cloud_user_account.ValidateCloudUserAccountResponse", "properties": { "is_valid": { "type": "boolean", "description": "Indicates whether the cloud user account is valid.", "title": "Is Valid", "format": "boolean", "x-displayname": "Is Valid", "x-f5xc-description-short": "Indicates whether the cloud user account is valid.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validated_at": { "type": "string", "description": "Timestamp when the validation was performed.", "title": "Validated At", "format": "date-time", "x-displayname": "Validated At.", "x-f5xc-description-short": "Timestamp when the validation was performed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validation_errors": { "type": "array", "description": "List of validation errors encountered during validation.", "title": "Validation Errors", "items": { "$ref": "#/components/schemas/cloud_user_accountValidationError" }, "x-displayname": "Validation Errors.", "x-f5xc-description-short": "List of validation errors encountered during validation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to validate cloud user account.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_user_accountValidateCloudUserAccountResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "cloud_user_accountValidationError": { "type": "object", "description": "Validation Error.", "title": "Validation Error", "x-displayname": "Validation Error.", "x-ves-proto-message": "ves.io.schema.cloud_user_account.ValidationError", "properties": { "error_description": { "type": "string", "description": "Error Description.", "title": "Error Description", "x-displayname": "Error Description.", "x-ves-example": "Invalid credentials.", "x-f5xc-example": "invalid credentials", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "suggested_action": { "type": "string", "description": "Suggested Action.", "title": "Suggested Action", "x-displayname": "Suggested Action.", "x-ves-example": "Update account credentials.", "x-f5xc-example": "update account credentials", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_user_accountValidationError", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "contactCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of contact", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.contact.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/contactCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.contact.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/contactGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactCreateSpecType": { "type": "object", "description": "Creates a new customer's contact detail record with us, including address and phone number.", "title": "Contact", "x-displayname": "Create Contact.", "x-ves-proto-message": "ves.io.schema.contact.CreateSpecType", "properties": { "address1": { "type": "string", "description": "Network address or location", "x-displayname": "Address Line 1.", "x-ves-example": "1234 Main road.", "x-f5xc-example": "1234 Main road", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "address2": { "type": "string", "description": "Network address or location", "x-displayname": "Address Line 2.", "x-ves-example": "P.O BOX 56.", "x-f5xc-example": "P.O BOX 56", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "city": { "type": "string", "description": "Configuration parameter for city", "x-displayname": "City", "x-ves-example": "Sunnyvale", "x-f5xc-example": "Sunnyvale", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_type": { "allOf": [ { "$ref": "#/components/schemas/contactContactType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Configuration parameter for country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "county": { "type": "string", "description": "Configuration parameter for county", "x-displayname": "County", "x-ves-example": "Santa Clara.", "x-f5xc-example": "Santa Clara", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phone_number": { "type": "string", "description": "Configuration parameter for phone number", "x-displayname": "Phone Number.", "x-ves-example": "+11234567890.", "x-f5xc-example": "+11234567890", "x-f5xc-description-short": "Configuration parameter for phone number.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "Current state of the resource", "x-displayname": "State", "x-ves-example": "California.", "x-f5xc-example": "California", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state_code": { "type": "string", "description": "Configuration parameter for state code", "x-displayname": "State Code.", "x-ves-example": "CA", "x-f5xc-example": "CA", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "zip_code": { "type": "string", "description": "IP address configuration", "x-displayname": "ZIP code", "x-ves-example": "95054", "x-f5xc-example": "95054", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Creates a new customer's contact detail record with us, including address and phone number.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a contact", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.contact.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read contact", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.contact.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/contactCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/contactReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/contactGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/contactStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactGetSpecType": { "type": "object", "description": "Retrieves existing customer's contact details, including address and phone number.", "title": "Contact", "x-displayname": "GET Contact.", "x-ves-proto-message": "ves.io.schema.contact.GetSpecType", "properties": { "address1": { "type": "string", "description": "Network address or location", "x-displayname": "Address Line 1.", "x-ves-example": "1234 Main road.", "x-f5xc-example": "1234 Main road", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "address2": { "type": "string", "description": "Network address or location", "x-displayname": "Address Line 2.", "x-ves-example": "P.O BOX 56.", "x-f5xc-example": "P.O BOX 56", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "city": { "type": "string", "description": "Configuration parameter for city", "x-displayname": "City", "x-ves-example": "Sunnyvale", "x-f5xc-example": "Sunnyvale", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_type": { "allOf": [ { "$ref": "#/components/schemas/contactContactType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Configuration parameter for country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "county": { "type": "string", "description": "Configuration parameter for county", "x-displayname": "County", "x-ves-example": "Santa Clara.", "x-f5xc-example": "Santa Clara", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phone_number": { "type": "string", "description": "Configuration parameter for phone number", "x-displayname": "Phone Number.", "x-ves-example": "+11234567890.", "x-f5xc-example": "+11234567890", "x-f5xc-description-short": "Configuration parameter for phone number.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "Current state of the resource", "x-displayname": "State", "x-ves-example": "California.", "x-f5xc-example": "California", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state_code": { "type": "string", "description": "Configuration parameter for state code", "x-displayname": "State Code.", "x-ves-example": "CA", "x-f5xc-example": "CA", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "zip_code": { "type": "string", "description": "IP address configuration", "x-displayname": "ZIP code", "x-ves-example": "95054", "x-f5xc-example": "95054", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Retrieves existing customer's contact details, including address and phone number.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of contact", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.contact.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/contactListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactListResponseItem": { "type": "object", "description": "By default a summary of contact is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of contact", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.contact.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this contact.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this contact.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this contact.", "title": "description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates contact is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates contact is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/contactGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this contact.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this contact.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this contact.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/contactStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this contact.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of contact is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of contact is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a contact", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.contact.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/contactReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.contact.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactReplaceSpecType": { "type": "object", "description": "Updates existing customer's contact details, including address and phone number.", "title": "Contact", "x-displayname": "Replace Contact.", "x-ves-proto-message": "ves.io.schema.contact.ReplaceSpecType", "properties": { "address1": { "type": "string", "description": "Network address or location", "x-displayname": "Address Line 1.", "x-ves-example": "1234 Main road.", "x-f5xc-example": "1234 Main road", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "address2": { "type": "string", "description": "Network address or location", "x-displayname": "Address Line 2.", "x-ves-example": "P.O BOX 56.", "x-f5xc-example": "P.O BOX 56", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "city": { "type": "string", "description": "Configuration parameter for city", "x-displayname": "City", "x-ves-example": "Sunnyvale", "x-f5xc-example": "Sunnyvale", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_type": { "allOf": [ { "$ref": "#/components/schemas/contactContactType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Configuration parameter for country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "county": { "type": "string", "description": "Configuration parameter for county", "x-displayname": "County", "x-ves-example": "Santa Clara.", "x-f5xc-example": "Santa Clara", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phone_number": { "type": "string", "description": "Configuration parameter for phone number", "x-displayname": "Phone Number.", "x-ves-example": "+11234567890.", "x-f5xc-example": "+11234567890", "x-f5xc-description-short": "Configuration parameter for phone number.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "Current state of the resource", "x-displayname": "State", "x-ves-example": "California.", "x-f5xc-example": "California", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state_code": { "type": "string", "description": "Configuration parameter for state code", "x-displayname": "State Code.", "x-ves-example": "CA", "x-f5xc-example": "CA", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "zip_code": { "type": "string", "description": "IP address configuration", "x-displayname": "ZIP code", "x-ves-example": "95054", "x-f5xc-example": "95054", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Updates existing customer's contact details, including address and phone number.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "contactStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of a contact", "x-displayname": "Contact object status.", "x-ves-proto-message": "ves.io.schema.contact.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for contactStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "managed_tenantDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a managed_tenant", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for managed_tenantDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "managed_tenantGetManagedTenantListResp": { "type": "object", "description": "Response to GET list of managed tenant access.", "title": "GetManagedTenantListResp", "x-displayname": "GET Managed Tenant Access Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.GetManagedTenantListResp", "properties": { "access_config": { "type": "array", "description": "Allowed access configuration details for the tenant.", "title": "access_config", "items": { "$ref": "#/components/schemas/tenant_managementAccessInfo" }, "x-displayname": "Access Config.", "x-f5xc-description-short": "Allowed access configuration details for the tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "next_page": { "type": "string", "description": "NextPage contains the UUID of the first item of the next page.\nThis value can be passed back as the PageStart in the next request.\nIf this empty means current one is the last page.", "title": "next_page", "x-displayname": "NextPage", "x-f5xc-description-short": "NextPage contains the UUID of the first item of the next page. This value can be passed back as the PageStart in the next request.", "x-f5xc-description-medium": "NextPage contains the UUID of the first item of the next page. This value can be passed back as the PageStart in the next request. If this empty means current one is the last page.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_access_config_count": { "type": "integer", "description": "TotalAccessConfigCount holds total count of access config.\nThis is deprecated, use TotalCount instead.", "title": "total_access_config_count", "format": "int32", "x-displayname": "TotalAccessConfigCount.", "x-f5xc-description-short": "TotalAccessConfigCount holds total count of access config. This is deprecated, use TotalCount instead.", "x-f5xc-description-medium": "TotalAccessConfigCount holds total count of access config. This is deprecated, use TotalCount instead.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "TotalCount holds total count of access config.", "title": "total_count", "format": "int32", "x-displayname": "TotalCount.", "x-f5xc-description-short": "TotalCount holds total count of access config.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_filtered_count": { "type": "integer", "description": "TotalFilteredCount holds total count of access config after filtering.", "title": "total_filtered_count", "format": "int32", "x-displayname": "TotalFilteredCount.", "x-f5xc-description-short": "TotalFilteredCount holds total count of access config after filtering.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to GET list of managed tenant access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for managed_tenantGetManagedTenantListResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "managed_tenantListSupportTenantMTResp": { "type": "object", "description": "Response to GET list of managed tenant access.", "title": "ListSupportTenantMTResp", "x-displayname": "List Support Tenant MT Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.ListSupportTenantMTResp", "properties": { "items": { "type": "array", "description": "List support tenant MT items.", "title": "items", "items": { "$ref": "#/components/schemas/managed_tenantListSupportTenantMTRespItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "next_page": { "type": "string", "description": "NextPage contains the UUID of the first item of the next page.\nThis value can be passed back as the PageStart in the next request.\nIf this empty means current one is the last page.", "title": "next_page", "x-displayname": "NextPage", "x-f5xc-description-short": "NextPage contains the UUID of the first item of the next page. This value can be passed back as the PageStart in the next request.", "x-f5xc-description-medium": "NextPage contains the UUID of the first item of the next page. This value can be passed back as the PageStart in the next request. If this empty means current one is the last page.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "TotalCount holds total count of access config.", "title": "total_count", "format": "int32", "x-displayname": "TotalCount.", "x-f5xc-description-short": "TotalCount holds total count of access config.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_filtered_count": { "type": "integer", "description": "TotalFilteredCount holds total count of access config after filtering.", "title": "total_filtered_count", "format": "int32", "x-displayname": "TotalFilteredCount.", "x-f5xc-description-short": "TotalFilteredCount holds total count of access config after filtering.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to GET list of managed tenant access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for managed_tenantListSupportTenantMTResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "managed_tenantListSupportTenantMTRespItem": { "type": "object", "description": "List support tenant MT items.", "title": "ListSupportTenantMTRespItem", "x-displayname": "List support tenant MT items.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.ListSupportTenantMTRespItem", "properties": { "disabled": { "type": "boolean", "description": "A value of true indicates support access paused for tenant.", "title": "access_status", "format": "boolean", "x-displayname": "AccessStatus.", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates support access paused for tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "groups": { "type": "array", "description": "List of local user group association to user groups in the managed tenant.", "title": "groups", "items": { "$ref": "#/components/schemas/tenant_managementGroupAssignmentType" }, "x-displayname": "Groups", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of local user group association to user groups in the managed tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link": { "allOf": [ { "$ref": "#/components/schemas/viewsLinkRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "link", "gated_by": null, "required": false, "cardinality": "single" } ] }, "name": { "type": "string", "description": "Name of the managed tenant config object. It can be used as known identifier.", "title": "Name", "x-displayname": "Name", "x-ves-example": "L1-support.", "x-f5xc-example": "l1-support", "x-f5xc-description-short": "Name of the managed tenant config object. It can be used as known identifier.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant_status": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementTenantStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for managed_tenantListSupportTenantMTRespItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "managed_tenantReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a managed_tenant", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementmanaged_tenantReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for managed_tenantReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "managed_tenantReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for managed_tenantReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of managed_tenant", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementmanaged_tenantCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementmanaged_tenantGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantCreateSpecType": { "type": "object", "description": "Creates a managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "title": "Create Managed Tenant", "x-displayname": "Create Managed Tenant.", "x-ves-displayorder": "1,5", "x-ves-oneof-field-tenant_choice": "[\"tenant_id\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.CreateSpecType", "properties": { "groups": { "type": "array", "description": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "maxItems": 16, "items": { "$ref": "#/components/schemas/tenant_managementGroupAssignmentType" }, "x-displayname": "Group Mapping.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "x-f5xc-description-medium": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_id": { "type": "string", "description": "Exclusive with []\nSpecify the Tenant ID of the existing tenant which needs to be managed.\nUser can select Tenant ID from dropdown if managed tenant has already configured delegated access\nor manually input the Tenant ID if managed tenant configuration will happen in future.", "maxLength": 256, "x-displayname": "Managed Tenant ID.", "x-ves-example": "Company-s4543dsa.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "company-s4543dsa", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [] Specify the Tenant ID of the existing tenant which needs to be managed.", "x-f5xc-description-medium": "Exclusive with [] Specify the Tenant ID of the existing tenant which needs to be managed. User can select Tenant ID from dropdown if managed tenant has already configured delegated access or manually input the Tenant ID if managed tenant configuration will happen in future.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Creates a managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "x-f5xc-description-medium": "Creates a managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read managed_tenant", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementmanaged_tenantCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/managed_tenantReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementmanaged_tenantGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_managementmanaged_tenantStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantGetSpecType": { "type": "object", "description": "GET managed_tenant reads a given object from storage backend for metadata.namespace.", "title": "Get managed tenant", "x-displayname": "GET Managed Tenant.", "x-ves-displayorder": "2,3,4,5,8", "x-ves-oneof-field-tenant_choice": "[\"tenant_id\"]", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.GetSpecType", "properties": { "groups": { "type": "array", "description": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "maxItems": 16, "items": { "$ref": "#/components/schemas/tenant_managementGroupAssignmentType" }, "x-displayname": "Group Mapping.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "x-f5xc-description-medium": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tenant_id": { "type": "string", "description": "Exclusive with []\nSpecify the Tenant ID of the existing tenant which needs to be managed.\nUser can select Tenant ID from dropdown if managed tenant has already configured delegated access\nor manually input the Tenant ID if managed tenant configuration will happen in future.", "maxLength": 256, "x-displayname": "Managed Tenant ID.", "x-ves-example": "Company-s4543dsa.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "company-s4543dsa", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [] Specify the Tenant ID of the existing tenant which needs to be managed.", "x-f5xc-description-medium": "Exclusive with [] Specify the Tenant ID of the existing tenant which needs to be managed. User can select Tenant ID from dropdown if managed tenant has already configured delegated access or manually input the Tenant ID if managed tenant configuration will happen in future.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "GET managed_tenant reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of managed_tenant", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_tenant_management_child_tenant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/tenant_managementmanaged_tenantListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantListResponseItem": { "type": "object", "description": "By default a summary of managed_tenant is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of managed_tenant", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this managed_tenant.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this managed_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this managed_tenant.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this managed_tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates managed_tenant is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates managed_tenant is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_managementmanaged_tenantGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this managed_tenant.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this managed_tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this managed_tenant.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_managementmanaged_tenantStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this managed_tenant.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of managed_tenant is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of managed_tenant is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantReplaceSpecType": { "type": "object", "description": "Replaces attributes of a managed_tenant configuration.\nUpdate of existing tenant_choice selection is not supported but user may update existing group assignments.", "title": "Replace Managed Tenant", "x-displayname": "Replace Managed Tenant.", "x-ves-displayorder": "5", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.ReplaceSpecType", "properties": { "groups": { "type": "array", "description": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "maxItems": 16, "items": { "$ref": "#/components/schemas/tenant_managementGroupAssignmentType" }, "x-displayname": "Group Mapping.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "x-f5xc-description-medium": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Replaces attributes of a managed_tenant configuration.", "x-f5xc-description-medium": "Replaces attributes of a managed_tenant configuration. Update of existing tenant_choice selection is not supported but user may update existing group assignments.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementmanaged_tenantStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for Managed Tenant", "x-displayname": "Managed Tenant.", "x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementmanaged_tenantStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "alert_policy_setAlertPolicyStatus": { "type": "object", "x-ves-proto-message": "ves.io.schema.alert_policy_set.AlertPolicyStatus", "properties": { "policy": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "service_policy", "field_path": "policy", "gated_by": null, "required": false, "cardinality": "single" } ] }, "reason": { "type": "array", "description": "A human-readable description of why this status is in the\n\"Partially Active\" or \"Inactive\" status. The value will be empty for\n\"Active\" status.", "title": "Reason", "items": { "type": "string" }, "x-displayname": "Reason", "x-f5xc-description-short": "Human-readable description of why this status is in the \"Partially Active\" or \"Inactive\" status.", "x-f5xc-description-medium": "Human-readable description of why this status is in the \"Partially Active\" or \"Inactive\" status. The value will be empty for \"Active\" status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 43, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the alert policy.", "title": "Status", "x-displayname": "Status", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Active\\\",\\\"Inactive\\\",\\\"Partially Active\\\"]" }, "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Active\\\",\\\"Inactive\\\",\\\"Partially Active\\\"]" }, "x-f5xc-example": "active", "maxLength": 1024, "enum": [ "Active", "Inactive", "Partially Active" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policy_setAlertPolicyStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Alert policy sets are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "app_firewallAppFirewallViolationType": { "type": "string", "description": "List of all supported Violation Types\n\nVIOL_NONE\nVIOL_FILETYPE\nVIOL_METHOD\nVIOL_MANDATORY_HEADER\nVIOL_HTTP_RESPONSE_STATUS\nVIOL_REQUEST_MAX_LENGTH\nVIOL_FILE_UPLOAD\nVIOL_FILE_UPLOAD_IN_BODY\nVIOL_XML_MALFORMED\nVIOL_JSON_MALFORMED\nVIOL_ASM_COOKIE_MODIFIED\nVIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS\nVIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE\nVIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT\nVIOL_HTTP_PROTOCOL_NULL_IN_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION\nVIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START\nVIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING\nVIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS\nVIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER\nVIOL_EVASION_DIRECTORY_TRAVERSALS\nVIOL_MALFORMED_REQUEST\nVIOL_EVASION_MULTIPLE_DECODING\nVIOL_DATA_GUARD\nVIOL_EVASION_APACHE_WHITESPACE\nVIOL_COOKIE_MODIFIED\nVIOL_EVASION_IIS_UNICODE_CODEPOINTS\nVIOL_EVASION_IIS_BACKSLASHES\nVIOL_EVASION_PERCENT_U_DECODING\nVIOL_EVASION_BARE_BYTE_DECODING\nVIOL_EVASION_BAD_UNESCAPE\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING\nVIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST\nVIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS\nVIOL_ENCODING\nVIOL_COOKIE_MALFORMED\nVIOL_GRAPHQL_FORMAT\nVIOL_GRAPHQL_MALFORMED\nVIOL_GRAPHQL_INTROSPECTION_QUERY.", "title": "App Firewall Violation Type", "enum": [ "VIOL_NONE", "VIOL_FILETYPE", "VIOL_METHOD", "VIOL_MANDATORY_HEADER", "VIOL_HTTP_RESPONSE_STATUS", "VIOL_REQUEST_MAX_LENGTH", "VIOL_FILE_UPLOAD", "VIOL_FILE_UPLOAD_IN_BODY", "VIOL_XML_MALFORMED", "VIOL_JSON_MALFORMED", "VIOL_ASM_COOKIE_MODIFIED", "VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS", "VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE", "VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT", "VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST", "VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION", "VIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START", "VIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST", "VIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING", "VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS", "VIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER", "VIOL_EVASION_DIRECTORY_TRAVERSALS", "VIOL_MALFORMED_REQUEST", "VIOL_EVASION_MULTIPLE_DECODING", "VIOL_DATA_GUARD", "VIOL_EVASION_APACHE_WHITESPACE", "VIOL_COOKIE_MODIFIED", "VIOL_EVASION_IIS_UNICODE_CODEPOINTS", "VIOL_EVASION_IIS_BACKSLASHES", "VIOL_EVASION_PERCENT_U_DECODING", "VIOL_EVASION_BARE_BYTE_DECODING", "VIOL_EVASION_BAD_UNESCAPE", "VIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING", "VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST", "VIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS", "VIOL_ENCODING", "VIOL_COOKIE_MALFORMED", "VIOL_GRAPHQL_FORMAT", "VIOL_GRAPHQL_MALFORMED", "VIOL_GRAPHQL_INTROSPECTION_QUERY" ], "default": "VIOL_NONE", "x-displayname": "App Firewall Violation Type.", "x-ves-proto-enum": "ves.io.schema.app_firewall.AppFirewallViolationType", "x-f5xc-description-short": "List of all supported Violation Types VIOL_NONE VIOL_FILETYPE VIOL_METHOD VIOL_MANDATORY_HEADER VIOL_HTTP_RESPONSE_STATUS VIOL_REQUEST_MAX_LENGTH...", "x-f5xc-description-medium": "List of all supported Violation Types VIOL_NONE VIOL_FILETYPE VIOL_METHOD VIOL_MANDATORY_HEADER VIOL_HTTP_RESPONSE_STATUS VIOL_REQUEST_MAX_LENGTH VIOL_FILE_UPLOAD VIOL_FILE_UPLOAD_IN_BODY VIOL_XML_MALFORMED VIOL_JSON_MALFORMED VIOL_ASM_COOKIE_MODIFIED VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for app_firewallAppFirewallViolationType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VIOL_NONE\"", "example_yaml": "VIOL_NONE\n..." }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Security policies benefit from centralized management in shared namespace" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "namespaceAPIItemListReq": { "type": "object", "description": "A request API item list.", "title": "APIItemListReq", "x-displayname": "API Item List Req.", "x-ves-proto-message": "ves.io.schema.namespace.APIItemListReq", "properties": { "items": { "type": "array", "description": "A list of request API items.", "title": "items", "maxItems": 100, "items": { "$ref": "#/components/schemas/namespaceAPIItemReq" }, "x-displayname": "Items", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 100, "minItems": 0, "uniqueItems": false, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "list_id": { "type": "string", "description": "API item list identifier.", "title": "list_id", "x-displayname": "List ID", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAPIItemListReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAPIItemListResp": { "type": "object", "description": "A response API item list.\nResult will show combined AND output from the result of individual API items.", "title": "APIItemListResp", "x-displayname": "API Item List Resp.", "x-ves-proto-message": "ves.io.schema.namespace.APIItemListResp", "properties": { "items": { "type": "array", "description": "A list of response API item lists.", "title": "items", "items": { "$ref": "#/components/schemas/namespaceAPIItemResp" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "list_id": { "type": "string", "description": "API item list identifier.", "title": "list_id", "x-displayname": "List ID", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "result": { "type": "boolean", "description": "Combined result after evaluation of items.", "title": "result", "format": "boolean", "x-displayname": "Result", "x-f5xc-description-short": "Combined result after evaluation of items.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response API item list. Result will show combined AND output from the result of individual API items.", "x-f5xc-description-medium": "Response API item list. Result will show combined AND output from the result of individual API items.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAPIItemListResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAPIItemReq": { "type": "object", "description": "A request API item.", "title": "APIItemReq", "x-displayname": "API Item Req.", "x-ves-proto-message": "ves.io.schema.namespace.APIItemReq", "properties": { "method": { "type": "string", "description": "HTTP request method.", "title": "method", "x-displayname": "Method", "x-ves-example": "GET", "x-f5xc-example": "GET", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "description": "HTTP request URL path.", "title": "path", "x-displayname": "Path", "x-ves-example": "/API/web/namespaces.", "x-f5xc-example": "/api/web/namespaces", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAPIItemReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAPIItemResp": { "type": "object", "description": "A response API item.", "title": "APIItemResp", "x-displayname": "API Item Resp.", "x-ves-oneof-field-access_enablers": "[\"addon_services\",\"none\"]", "x-ves-proto-message": "ves.io.schema.namespace.APIItemResp", "properties": { "addon_services": { "allOf": [ { "$ref": "#/components/schemas/namespaceAccessEnablerAddonService" } ], "x-f5xc-description-short": "Configuration parameter for addon services.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "none" ] }, "method": { "type": "string", "description": "HTTP request method.", "title": "method", "x-displayname": "Method", "x-ves-example": "GET", "x-f5xc-example": "GET", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "none": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "addon_services" ] }, "path": { "type": "string", "description": "HTTP request URL path.", "title": "path", "x-displayname": "Path", "x-ves-example": "/API/web/namespaces.", "x-f5xc-example": "/api/web/namespaces", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "type": "boolean", "description": "Result after evaluation.", "title": "result", "format": "boolean", "x-displayname": "Result", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAPIItemResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAccessControlType": { "type": "string", "description": "Enum consists of different access control types.\n\n- RBAC: RBAC\n\nDefault access control, evaluates role based access control.\n- PBAC: PBAC\n\nEvaluates plan based access control\n- ALL: ALL\n\nEvaluates all access controls specified in this enum.", "title": "AccessControlType", "enum": [ "RBAC", "PBAC", "ALL" ], "default": "RBAC", "x-displayname": "Access Control Type.", "x-ves-proto-enum": "ves.io.schema.namespace.AccessControlType", "x-f5xc-description-short": "Enum consists of different access control types. - RBAC: RBAC Default access control, evaluates role based access control. - PBAC: PBAC Evaluates...", "x-f5xc-description-medium": "Enum consists of different access control types. - RBAC: RBAC Default access control, evaluates role based access control. - PBAC: PBAC Evaluates plan based access control - ALL: ALL Evaluates all access controls specified in this enum.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAccessControlType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"RBAC\"", "example_yaml": "RBAC\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAccessEnablerAddonService": { "type": "object", "description": "An addon service details schema.", "title": "AccessEnablerAddonService", "x-displayname": "Access Enabler Addon Service.", "x-ves-proto-message": "ves.io.schema.namespace.AccessEnablerAddonService", "properties": { "addon_service_names": { "type": "array", "description": "List of addon service names.", "title": "addon_service_names", "items": { "type": "string" }, "x-displayname": "Addon Service Names.", "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAccessEnablerAddonService", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAllApplicationInventoryRequest": { "type": "object", "description": "Request for inventory of application related objects.", "title": "AllApplicationInventoryRequest", "x-displayname": "All Application related objects inventory request.", "x-ves-proto-message": "ves.io.schema.namespace.AllApplicationInventoryRequest", "properties": { "bigip_virtual_server_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceBIGIPVirtualServerInventoryFilterType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cdn_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for cdn load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for http load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nginx_one_server_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceNGINXOneServerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for nginx one server filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceTCPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for tcp load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "third_party_application_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceThirdPartyApplicationFilterType" } ], "x-f5xc-description-short": "Configuration parameter for third party application filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "udp_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceUDPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for udp load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for inventory of application related objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAllApplicationInventoryRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAllApplicationInventoryWafFilterRequest": { "type": "object", "description": "Request for inventory of application related objects with WAF Filter.", "title": "AllApplicationInventoryWafFilterRequest", "x-displayname": "All Application related objects inventory request with WAF Filter.", "x-ves-oneof-field-waf_filter_choice": "[\"exclusion_signature_id\",\"exclusion_violation_type\"]", "x-ves-proto-message": "ves.io.schema.namespace.AllApplicationInventoryWafFilterRequest", "properties": { "exclusion_signature_id": { "type": "integer", "description": "Exclusive with [exclusion_violation_type]", "title": "WAF Exclusion Rule Signature Id", "format": "int64", "x-displayname": "WAF Exclusion Rule Signature ID.", "x-f5xc-description-short": "Exclusive with [exclusion_violation_type].", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "exclusion_violation_type" ] }, "exclusion_violation_type": { "allOf": [ { "$ref": "#/components/schemas/app_firewallAppFirewallViolationType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exclusion_signature_id" ] } }, "x-f5xc-description-short": "Request for inventory of application related objects with WAF Filter.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAllApplicationInventoryWafFilterRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceAllApplicationInventoryWafFilterResponse": { "type": "object", "description": "Response for inventory of application related objects.", "title": "AllApplicationInventoryWafFilterResponse", "x-displayname": "Application related objects inventory response.", "x-ves-proto-message": "ves.io.schema.namespace.AllApplicationInventoryWafFilterResponse", "properties": { "cdn_loadbalancers": { "type": "array", "description": "Application Inventory of configured CDN Loadbalancers with WAF Filters.", "title": "CDN Loadbalancer Inventory with WAF Filters", "items": { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerWafFilterResultType" }, "x-displayname": "CDN Loadbalancers with WAF Filters.", "x-f5xc-description-short": "Application Inventory of configured CDN Loadbalancers with WAF Filters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_loadbalancers": { "type": "array", "description": "Application Inventory of configured HTTP Loadbalancers with WAF Filters.", "title": "HTTP Loadbalancer Inventory with WAF Filters", "items": { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerWafFilterResultType" }, "x-displayname": "HTTP Loadbalancers with WAF Filters.", "x-f5xc-description-short": "Application Inventory of configured HTTP Loadbalancers with WAF Filters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for inventory of application related objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceAllApplicationInventoryWafFilterResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceApiEndpointsStatsAllNSReq": { "type": "object", "description": "Request shape for GET API Endpoints Stats All Namespaces.", "title": "Api Endpoints stats all namespaces request", "x-displayname": "API Endpoints Stats All Namespaces Request.", "x-ves-proto-message": "ves.io.schema.namespace.ApiEndpointsStatsAllNSReq", "properties": { "namespace": { "type": "string", "description": "Namespace of the App type for current request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Shared", "x-f5xc-example": "shared", "x-f5xc-description-short": "Namespace of the App type for current request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request shape for GET API Endpoints Stats All Namespaces.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceApiEndpointsStatsAllNSReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceApiEndpointsStatsNSReq": { "type": "object", "description": "Request shape for GET API Endpoints Stats.", "title": "Api Endpoints stats request", "x-displayname": "API Endpoints Stats Request.", "x-ves-proto-message": "ves.io.schema.namespace.ApiEndpointsStatsNSReq", "properties": { "namespace": { "type": "string", "description": "Namespace of the App type for current request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Shared", "x-f5xc-example": "shared", "x-f5xc-description-short": "Namespace of the App type for current request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "vhosts_filter": { "type": "array", "description": "List of Virtual Hosts for current request\nIf the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.", "title": "List Of Virtual Hosts Name", "items": { "type": "string" }, "x-displayname": "List Of Virtual Hosts Name.", "x-ves-example": "Blogging-app, test-app.", "x-f5xc-example": "blogging-app, test-app", "x-f5xc-description-short": "List of Virtual Hosts for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested...", "x-f5xc-description-medium": "List of Virtual Hosts for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vhosts_types_filter": { "type": "array", "description": "List of Virtual Hosts types for current request\nIf the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.", "title": "Virtual Hosts Types Filter", "items": { "$ref": "#/components/schemas/virtual_hostVirtualHostType" }, "x-displayname": "Virtual Hosts Types Filter.", "x-ves-validation-rules": { "ves.io.schema.rules.enum.in": "[1,6,7,8]", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"HTTP_LOAD_BALANCER\", \"CDN_LOAD_BALANCER\"]", "x-validation-rules": { "ves.io.schema.rules.enum.in": "[1,6,7,8]", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of Virtual Hosts types for current request If the list is empty or not provided, it will return stats for all virtual hosts under the...", "x-f5xc-description-medium": "List of Virtual Hosts types for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request shape for GET API Endpoints Stats.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceApiEndpointsStatsNSReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceApiEndpointsStatsNSRsp": { "type": "object", "description": "Response shape for GET API endpoints Stats.", "title": "Api Endpoints stats Response", "x-displayname": "API Endpoints Stats Response.", "x-ves-proto-message": "ves.io.schema.namespace.ApiEndpointsStatsNSRsp", "properties": { "discovered": { "type": "integer", "description": "Number of endpoints that categorized as discover.", "title": "number of discovered endpoints", "format": "int32", "x-displayname": "Discovered.", "x-f5xc-description-short": "Number of endpoints that categorized as discover.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inventory": { "type": "integer", "description": "Number of endpoints that categorized as inventory.", "title": "number of inventory endpoints", "format": "int32", "x-displayname": "Inventory", "x-f5xc-description-short": "Number of endpoints that categorized as inventory.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pii_detected": { "type": "integer", "description": "Number of endpoints that detected with pii.", "title": "number of pii endpoints", "format": "int32", "x-displayname": "PII Detected.", "x-f5xc-description-short": "Number of endpoints that detected with pii.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "shadow": { "type": "integer", "description": "Number of endpoints that categorized as shadow.", "title": "number of shadow endpoints", "format": "int32", "x-displayname": "Shadow", "x-f5xc-description-short": "Number of endpoints that categorized as shadow.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_endpoints": { "type": "integer", "description": "Total endpoints.", "title": "number of endpoints", "format": "int32", "x-displayname": "Total Endpoints.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response shape for GET API endpoints Stats.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceApiEndpointsStatsNSRsp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceApplicationInventoryRequest": { "type": "object", "description": "Request for inventory of application related objects from all namespaces.", "title": "ApplicationInventoryRequest", "x-displayname": "Application related objects inventory request.", "x-ves-proto-message": "ves.io.schema.namespace.ApplicationInventoryRequest", "properties": { "bigip_virtual_server_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceBIGIPVirtualServerInventoryFilterType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cdn_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for cdn load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for http load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "The name of the namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "nginx_one_server_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceNGINXOneServerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for nginx one server filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceTCPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for tcp load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "third_party_application_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceThirdPartyApplicationFilterType" } ], "x-f5xc-description-short": "Configuration parameter for third party application filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "udp_load_balancer_filter": { "allOf": [ { "$ref": "#/components/schemas/namespaceUDPLoadbalancerInventoryFilterType" } ], "x-f5xc-description-short": "Configuration parameter for udp load balancer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for inventory of application related objects from all namespaces.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceApplicationInventoryRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceApplicationInventoryResponse": { "type": "object", "description": "Response for inventory of application related objects.", "title": "ApplicationInventoryResponse", "x-displayname": "Application related objects inventory response.", "x-ves-proto-message": "ves.io.schema.namespace.ApplicationInventoryResponse", "properties": { "bigip_virtual_servers": { "allOf": [ { "$ref": "#/components/schemas/namespaceBIGIPVirtualServerInventoryType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cdn_loadbalancers": { "allOf": [ { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryType" } ], "x-f5xc-description-short": "Configuration parameter for cdn loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_loadbalancers": { "allOf": [ { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryType" } ], "x-f5xc-description-short": "Configuration parameter for http loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "loadbalancers": { "type": "integer", "description": "Number of HTTP and TCP Load Balancers configured.", "title": "Load Balancers", "format": "int64", "x-displayname": "Load Balancers.", "x-f5xc-description-short": "Number of HTTP and TCP Load Balancers configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nginx_one_servers": { "allOf": [ { "$ref": "#/components/schemas/namespaceNGINXOneServerInventoryType" } ], "x-f5xc-description-short": "Configuration parameter for nginx one servers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "origin_pools": { "type": "integer", "description": "Number of origin pools configured.", "title": "Origin Pools", "format": "int64", "x-displayname": "Origin Pools.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "services_discovered": { "type": "integer", "description": "Number of services discovered.", "title": "Services Discovered", "format": "int64", "x-displayname": "Services Discovered.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_loadbalancers": { "allOf": [ { "$ref": "#/components/schemas/namespaceTCPLoadbalancerInventoryType" } ], "x-f5xc-description-short": "Configuration parameter for tcp loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "third_party_applications": { "allOf": [ { "$ref": "#/components/schemas/namespaceThirdPartyApplicationInventoryType" } ], "x-f5xc-description-short": "Configuration parameter for third party applications.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "udp_loadbalancers": { "allOf": [ { "$ref": "#/components/schemas/namespaceUDPLoadbalancerInventoryType" } ], "x-f5xc-description-short": "Configuration parameter for udp loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for inventory of application related objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceApplicationInventoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceBIGIPVirtualServerInventoryFilterType": { "type": "object", "description": "BIG-IP Virtual Server Inventory Filter.", "title": "BIGIPVirtualServerInventoryFilterType", "x-displayname": "Filter for BIG-IP Virtual Server Inventory.", "x-ves-proto-message": "ves.io.schema.namespace.BIGIPVirtualServerInventoryFilterType", "properties": { "api_discovery": { "type": "boolean", "description": "Filter results with BIG-IP Virtual Server with API Discovery.", "title": "API Discovery", "format": "boolean", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Filter results with BIG-IP Virtual Server with API Discovery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_configured": { "type": "boolean", "description": "Filter results with BIG-IP Virtual Server with WAF configured.", "title": "WAF", "format": "boolean", "x-displayname": "WAF", "x-f5xc-description-short": "Filter results with BIG-IP Virtual Server with WAF configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceBIGIPVirtualServerInventoryFilterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceBIGIPVirtualServerInventoryType": { "type": "object", "description": "BIG-IP Virtual Server inventory.", "title": "BIGIPVirtualServerInventoryType", "x-displayname": "Inventory of BIG-IP Virtual Server.", "x-ves-proto-message": "ves.io.schema.namespace.BIGIPVirtualServerInventoryType", "properties": { "api_discovery": { "type": "integer", "description": "Number of BIG-IP Virtual Servers with API Discovery enabled.", "title": "API Discovery", "format": "int64", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Number of BIG-IP Virtual Servers with API Discovery enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bigiplb_results": { "type": "array", "description": "List of BIG-IP Virtual Server.", "title": "BIGIP Virtual Server", "items": { "$ref": "#/components/schemas/namespaceBIGIPVirtualServerResultType" }, "x-displayname": "List of BIG-IP Virtual Server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_configured": { "type": "integer", "description": "Number of BIG-IP Virtual Servers with WAF configured.", "title": "WAF", "format": "int64", "x-displayname": "WAF", "x-f5xc-description-short": "Number of BIG-IP Virtual Servers with WAF configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceBIGIPVirtualServerInventoryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceBIGIPVirtualServerResultType": { "type": "object", "description": "BIG-IP Virtual Server Inventory Results.", "title": "BIGIPVirtualServerResultType", "x-displayname": "BIG-IP Virtual Server Inventory Results.", "x-ves-proto-message": "ves.io.schema.namespace.BIGIPVirtualServerResultType", "properties": { "api_discovery_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "VS Description of BIG-IP.", "title": "BIGIP VS Description", "x-displayname": "BIG-IP VS Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "host_name": { "type": "string", "description": "Name of BIG-IP Host.", "title": "BIGIP Host Name", "x-displayname": "BIG-IP Host Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of BIG-IP Virtual Server.", "title": "BIGIP Virtual Server Name", "x-displayname": "BIG-IP Virtual Server Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of BIG-IP VS.", "title": "BIGIP VS Namespace", "x-displayname": "BIG-IP VS Namespace.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "server_name": { "type": "string", "description": "Display Name of BIG-IP VS.", "title": "BIGIP VS Display Name", "x-displayname": "BIG-IP VS Server Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Version of BIG-IP.", "title": "BIGIP Version", "x-displayname": "BIG-IP Version.", "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "waf_enforcement_mode": { "type": "string", "description": "WAF Enforcement Mode.", "title": "WAF Enforcement Mode", "x-displayname": "WAF Enforcement Mode.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_policy_name": { "type": "string", "description": "WAF Policy Name.", "title": "WAF Policy Name", "x-displayname": "WAF Policy Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "BIG-IP Virtual Server Inventory Results.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceBIGIPVirtualServerResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceCascadeDeleteItemType": { "type": "object", "description": "CascadeDeleteItemType is details of object that was handled as part of cascade DELETE\nof namespace and whether it was successfully deleted.", "title": "CascadeDeleteItemType", "x-displayname": "Cascade DELETE Item.", "x-ves-proto-message": "ves.io.schema.namespace.CascadeDeleteItemType", "properties": { "error_message": { "type": "string", "description": "A description of the error encountered (if any) in the process of cascade deletion.", "title": "error_message", "x-displayname": "Error", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Description of the error encountered (if any) in the process of cascade deletion.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_name": { "type": "string", "description": "Name of the configuration object that was deleted.", "title": "object_name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the configuration object that was deleted.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_type": { "type": "string", "description": "The type of the contained configuration object in the namespace that was deleted.", "title": "object_type", "x-displayname": "Type", "x-ves-example": "VES.I/o.schema.virtual_host.object.", "x-f5xc-example": "ves.io.schema.virtual_host.object", "x-f5xc-description-short": "The type of the contained configuration object in the namespace that was deleted.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_uid": { "type": "string", "description": "The UID identifier of the configuration object that was deleted.", "title": "object_uid", "x-displayname": "UID", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The UID identifier of the configuration object that was deleted.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CascadeDeleteItemType is details of object that was handled as part of cascade DELETE of namespace and whether it was successfully deleted.", "x-f5xc-description-medium": "CascadeDeleteItemType is details of object that was handled as part of cascade DELETE of namespace and whether it was successfully deleted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceCascadeDeleteItemType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceCascadeDeleteRequest": { "type": "object", "description": "CascadeDeleteRequest contains the name of the namespace that has to be deleted\nalong with the objects configured under the namespace.", "title": "CascadeDeleteRequest", "x-displayname": "Cascade DELETE Request.", "x-ves-proto-message": "ves.io.schema.namespace.CascadeDeleteRequest", "properties": { "name": { "type": "string", "description": "The name of the namespace.", "title": "name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "CascadeDeleteRequest contains the name of the namespace that has to be deleted along with the objects configured under the namespace.", "x-f5xc-description-medium": "CascadeDeleteRequest contains the name of the namespace that has to be deleted along with the objects configured under the namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceCascadeDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceCascadeDeleteResponse": { "type": "object", "description": "CascadeDeleteResponse contains a list of objects in the namespace that were\ndeleted (or encountered an error while deleting)", "title": "CascadeDeleteResponse", "x-displayname": "Cascade DELETE Response.", "x-ves-proto-message": "ves.io.schema.namespace.CascadeDeleteResponse", "properties": { "items": { "type": "array", "description": "The objects deleted in namespace.", "title": "items", "items": { "$ref": "#/components/schemas/namespaceCascadeDeleteItemType" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CascadeDeleteResponse contains a list of objects in the namespace that were deleted (or encountered an error while deleting).", "x-f5xc-description-medium": "CascadeDeleteResponse contains a list of objects in the namespace that were deleted (or encountered an error while deleting).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceCascadeDeleteResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of namespace", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.namespace.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemanamespaceCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Logical grouping for F5 XC resources within a tenant", "required_fields": [ "metadata.name" ], "mutually_exclusive_groups": [], "example_yaml": "apiVersion: v1\nkind: namespace\nmetadata:\n name: example-ns\nspec: {}\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example-ns\"\n },\n \"spec\": {}\n}\n" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.namespace.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemanamespaceGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceDynamicDataReq": { "type": "object", "description": "Request body of DynamicData request.", "title": "DynamicDataReq", "x-displayname": "Request for DynamicData.", "x-ves-proto-message": "ves.io.schema.namespace.DynamicDataReq", "properties": { "defaults": { "type": "boolean", "description": "The response should contain the default values for a new object.", "title": "defaults", "format": "boolean", "x-displayname": "Request Defaults.", "x-f5xc-description-short": "The response should contain the default values for a new object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "field_path": { "type": "string", "description": "JSON path of the field for which the data are being requested.", "title": "field_path", "maxLength": 1024, "x-displayname": "Field Path.", "x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-description-short": "JSON path of the field for which the data are being requested.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace in which the data is scoped.", "title": "namespace", "x-displayname": "Namespace", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "request_body": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceDynamicDataReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceDynamicDataResp": { "type": "object", "description": "Response body of DynamicData request.", "title": "DynamicDataResp", "x-displayname": "Response for DynamicData.", "x-ves-proto-message": "ves.io.schema.namespace.DynamicDataResp", "properties": { "rows": { "type": "array", "description": "List of rows of data.", "title": "item_lists", "items": { "$ref": "#/components/schemas/protobufAny" }, "x-displayname": "Rows", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceDynamicDataResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceEvaluateAPIAccessReq": { "type": "object", "description": "Request body of Evaluate API Access.", "title": "EvaluateAPIAccessReq", "x-displayname": "Evaluate API Access Req.", "x-ves-proto-message": "ves.io.schema.namespace.EvaluateAPIAccessReq", "properties": { "access_control_type": { "allOf": [ { "$ref": "#/components/schemas/namespaceAccessControlType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "item_lists": { "type": "array", "description": "A list of request API item lists.", "title": "item_lists", "maxItems": 1000, "items": { "$ref": "#/components/schemas/namespaceAPIItemListReq" }, "x-displayname": "Item Lists.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1000" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1000" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1000, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Name of the namespace under which all the URLs in APIItems will be evaluated.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the namespace under which all the URLs in APIItems will be evaluated.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceEvaluateAPIAccessReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceEvaluateAPIAccessResp": { "type": "object", "description": "Response body of Evaluate API Access.", "title": "EvaluateAPIAccessResp", "x-displayname": "Response for EvaluateAPIAccess.", "x-ves-proto-message": "ves.io.schema.namespace.EvaluateAPIAccessResp", "properties": { "item_lists": { "type": "array", "description": "A list of request API item lists.", "title": "item_lists", "items": { "$ref": "#/components/schemas/namespaceAPIItemListResp" }, "x-displayname": "Item Lists.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceEvaluateAPIAccessResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceEvaluateBatchAPIAccessReq": { "type": "object", "description": "Request body of Evaluate Batch API Access.", "title": "EvaluateBatchAPIAccessReq", "x-displayname": "Evaluate Batch API Access Req.", "x-ves-proto-message": "ves.io.schema.namespace.EvaluateBatchAPIAccessReq", "properties": { "batch_namespace_api_list": { "type": "array", "description": "List of namespaces and associated API list entries.", "title": "batch_namespace_api_list", "maxItems": 75, "items": { "$ref": "#/components/schemas/namespaceNamespaceAPIListReq" }, "x-displayname": "Batch Namespace API List.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "75" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "75" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "List of namespaces and associated API list entries.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 75, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request body of Evaluate Batch API Access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceEvaluateBatchAPIAccessReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceEvaluateBatchAPIAccessResp": { "type": "object", "description": "Response body of Evaluate Batch API Access.", "title": "EvaluateBatchAPIAccessResp", "x-displayname": "Evaluate Batch API Access Resp.", "x-ves-proto-message": "ves.io.schema.namespace.EvaluateBatchAPIAccessResp", "properties": { "batch_namespace_api_list": { "type": "array", "description": "List of namespaces and associated API list entries.", "title": "batch_namespace_api_list", "items": { "$ref": "#/components/schemas/namespaceNamespaceAPIListResp" }, "x-displayname": "Batch Namespace API List.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "List of namespaces and associated API list entries.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response body of Evaluate Batch API Access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceEvaluateBatchAPIAccessResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceGetActiveAlertPoliciesResponse": { "type": "object", "description": "GetActiveAlertPoliciesResponse is the shape of the response for GetActiveAlertPolicies.", "title": "GetActiveAlertPoliciesResponse", "x-displayname": "Response for GetActiveAlertPolicies.", "x-ves-proto-message": "ves.io.schema.namespace.GetActiveAlertPoliciesResponse", "properties": { "alert_policies": { "type": "array", "description": "A list of references to alert_policy objects.", "title": "alert_policies", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Alert Policies.", "x-f5xc-description-short": "List of references to alert_policy objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "alert_policies_status": { "type": "array", "description": "The status of alert policies.", "title": "policy_status", "items": { "$ref": "#/components/schemas/alert_policy_setAlertPolicyStatus" }, "x-displayname": "Alert Policies Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GetActiveAlertPoliciesResponse is the shape of the response for GetActiveAlertPolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceGetActiveAlertPoliciesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceGetActiveNetworkPoliciesResponse": { "type": "object", "description": "GetActiveNetworkPoliciesResponse is the shape of the response for GetActiveNetworkPolicies.", "title": "GetActiveNetworkPoliciesResponse", "x-displayname": "Response for GetActiveNetworkPolicies.", "x-ves-proto-message": "ves.io.schema.namespace.GetActiveNetworkPoliciesResponse", "properties": { "network_policies": { "type": "array", "description": "A list of references to network_policy objects.", "title": "network_policies", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Network Policies.", "x-f5xc-description-short": "List of references to network_policy objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GetActiveNetworkPoliciesResponse is the shape of the response for GetActiveNetworkPolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceGetActiveNetworkPoliciesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceGetActiveServicePoliciesResponse": { "type": "object", "description": "GetActiveServicePoliciesResponse is the shape of the response for GetActiveServicePolicies.", "title": "GetActiveServicePoliciesResponse", "x-displayname": "Response for GetActiveServicePolicies.", "x-ves-proto-message": "ves.io.schema.namespace.GetActiveServicePoliciesResponse", "properties": { "service_policies": { "type": "array", "description": "A list of references to service_policy objects.", "title": "service_policies", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Service Policies.", "x-f5xc-description-short": "List of references to service_policy objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GetActiveServicePoliciesResponse is the shape of the response for GetActiveServicePolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceGetActiveServicePoliciesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceGetFastACLsForInternetVIPsResponse": { "type": "object", "description": "GetFastACLsForInternetVIPsResponse contains list of FastACLs refs that\nare applied to the Internet VIPs.", "title": "GetFastACLsForInternetVIPsResponse", "x-displayname": "Response for GetFastACLsForInternetVIPs.", "x-ves-proto-message": "ves.io.schema.namespace.GetFastACLsForInternetVIPsResponse", "properties": { "fast_acls": { "type": "array", "description": "The list of refs of FastACLs.", "title": "fast_acls", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "FastACLs", "x-ves-example": "List of refs.", "x-f5xc-example": "list of refs", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GetFastACLsForInternetVIPsResponse contains list of FastACLs refs that are applied to the Internet VIPs.", "x-f5xc-description-medium": "GetFastACLsForInternetVIPsResponse contains list of FastACLs refs that are applied to the Internet VIPs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceGetFastACLsForInternetVIPsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read namespace", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.namespace.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/namespaceCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/namespaceReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemanamespaceGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/schemanamespaceStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceHTTPLoadbalancerInventoryFilterType": { "type": "object", "description": "HTTP Loadbalancer Inventory Filter.", "title": "HTTPLoadbalancerInventoryFilterType", "x-displayname": "Filter for HTTP Loadbalancers Inventory.", "x-ves-proto-message": "ves.io.schema.namespace.HTTPLoadbalancerInventoryFilterType", "properties": { "api_definition": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with API Definition.", "title": "API Definition", "format": "boolean", "x-displayname": "API Definition.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with API Definition.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "api_discovery": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with API Discovery.", "title": "API Discovery", "format": "boolean", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with API Discovery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "api_protection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with API Protection configured.", "title": "API Protection", "format": "boolean", "x-displayname": "API Protection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with API Protection configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "api_schema_validation": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with API Schema Validation.", "title": "API Schema Validation", "format": "boolean", "x-displayname": "API Schema Validation.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with API Schema Validation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_protection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Bot Protection configured.", "title": "Bot Protection", "format": "boolean", "x-displayname": "Bot Protection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Bot Protection configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_blocking": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Client Blocking.", "title": "Client Blocking", "format": "boolean", "x-displayname": "Client Blocking.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Client Blocking.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_side_defense": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Client Side Defense configured.", "title": "Client Side Defense", "format": "boolean", "x-displayname": "Client Side Defense.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Client Side Defense configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cookie_protection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Cookie Protection.", "title": "Cookie Protection", "format": "boolean", "x-displayname": "Cookie Protection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Cookie Protection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cors_policy": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with CORS Policy.", "title": "CORS Policy", "format": "boolean", "x-displayname": "CORS Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "csrf_protection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with CSRF Protection.", "title": "CSRF Protection", "format": "boolean", "x-displayname": "CSRF Protection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with CSRF Protection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data_guard": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Data Guard.", "title": "Data Guard", "format": "boolean", "x-displayname": "Data Guard.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Data Guard.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_auto_mitigation": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.", "title": "L7 DDoS Auto Mitigation", "format": "boolean", "x-displayname": "L7 DDoS Auto Mitigation.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_mitigation": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.", "title": "DDoS Mitigation Rules", "format": "boolean", "x-displayname": "DDoS Mitigation Rules.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_protection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with L7 DDoS detection enabled.", "title": "L7 DDoS Detection", "format": "boolean", "x-displayname": "L7 DDoS Detection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with L7 DDoS detection enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_loadbalancer": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Default Loadbalancer.", "title": "Default Loadbalancer", "format": "boolean", "x-displayname": "Default Loadbalancer.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Default Loadbalancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "graph_ql_inspection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with GraphQL Inspection.", "title": "GraphQL Inspection", "format": "boolean", "x-displayname": "GraphQL Inspection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with GraphQL Inspection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_only": { "type": "boolean", "description": "Filter results with HTTP only loadbalancers.", "title": "HTTP Only", "format": "boolean", "x-displayname": "HTTP Only", "x-f5xc-description-short": "Filter results with HTTP only loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_reputation": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with IP Reputation configured.", "title": "IP Reputation", "format": "boolean", "x-displayname": "IP Reputation.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with IP Reputation configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_user_detection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Malicious User Detection configured.", "title": "Malicious User Detection", "format": "boolean", "x-displayname": "Malicious User Detection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Malicious User Detection configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_user_mitigation": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Malicious User Mitigation.", "title": "Malicious User Mitigation", "format": "boolean", "x-displayname": "Malicious User Mitigation.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Malicious User Mitigation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malware_protection": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Malware Protection.", "title": "Malware Protection", "format": "boolean", "x-displayname": "Malware Protection.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Malware Protection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mutual_tls": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with mTLS.", "title": "mTLS", "format": "boolean", "x-displayname": "MTLS", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with mTLS.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace_service_policy": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Namespace Service Policy configured.", "title": "Namespace Service Policy", "format": "boolean", "x-displayname": "Namespace Service Policy.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "origin_server_subset": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Origin Server Subset.", "title": "Origin Server Subset", "format": "boolean", "x-displayname": "Origin Server Subset.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Origin Server Subset.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "type": "boolean", "description": "Filter results with HTTP loadbalancers advertised privately.", "title": "Private Advertisement", "format": "boolean", "x-displayname": "Private Advertisement.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers advertised privately.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "type": "boolean", "description": "Filter results with HTTP loadbalancers advertised publicly.", "title": "Public Advertisement", "format": "boolean", "x-displayname": "Public Advertisement.", "x-f5xc-wire-name": "public_advertisment", "x-f5xc-description-short": "Filter results with HTTP loadbalancers advertised publicly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "routes": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Routes.", "title": "Routes", "format": "boolean", "x-displayname": "Routes", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Service Policy configured.", "title": "Service Policy", "format": "boolean", "x-displayname": "Service Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "slow_ddos_mitigation": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Slow DDoS Mitigation.", "title": "Slow DDoS Mitigation", "format": "boolean", "x-displayname": "Slow DDoS Mitigation.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Slow DDoS Mitigation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_client": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Trusted Client.", "title": "Trusted Client", "format": "boolean", "x-displayname": "Trusted Client.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Trusted Client.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_client_ip_headers": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with Trusted Client IP Headers.", "title": "Trusted Client IP Headers", "format": "boolean", "x-displayname": "Trusted Client IP Headers.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with Trusted Client IP Headers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with WAF configured.", "title": "WAF", "format": "boolean", "x-displayname": "WAF", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with WAF configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_exclusion": { "type": "boolean", "description": "Filter results with HTTP loadbalancers with WAF Exclusion.", "title": "WAF Exclusion", "format": "boolean", "x-displayname": "WAF Exclusion.", "x-f5xc-description-short": "Filter results with HTTP loadbalancers with WAF Exclusion.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceHTTPLoadbalancerInventoryFilterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceHTTPLoadbalancerInventoryType": { "type": "object", "description": "HTTP Loadbalancer inventory.", "title": "HTTPLoadbalancerInventoryType", "x-displayname": "Inventory of HTTP Loadbalancers.", "x-ves-proto-message": "ves.io.schema.namespace.HTTPLoadbalancerInventoryType", "properties": { "api_discovery": { "type": "integer", "description": "Number of HTTP loadbalancers with API Discovery enabled.", "title": "API Discovery", "format": "int64", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Number of HTTP loadbalancers with API Discovery enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "api_protection": { "type": "integer", "description": "Number of HTTP loadbalancers with API Protection configured.", "title": "API Protection", "format": "int64", "x-displayname": "API Protection.", "x-f5xc-description-short": "Number of HTTP loadbalancers with API Protection configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_protection": { "type": "integer", "description": "Number of HTTP loadbalancers with Bot Protection configured.", "title": "Bot Protection", "format": "int64", "x-displayname": "Bot Protection.", "x-f5xc-description-short": "Number of HTTP loadbalancers with Bot Protection configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cdnlb_results": { "type": "array", "description": "List of CDN loadbalancers.", "title": "CDN Loadbalancers", "items": { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerResultType" }, "x-displayname": "List of CDN Loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_side_defense": { "type": "integer", "description": "Number of HTTP loadbalancers with Client Side Defense configured.", "title": "Client Side Defense", "format": "int64", "x-displayname": "Client Side Defense.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Number of HTTP loadbalancers with Client Side Defense configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_protection": { "type": "integer", "description": "Number of HTTP loadbalancers with L7 DDoS Detection enabled.", "title": "L7 DDoS Detection", "format": "int64", "x-displayname": "L7 DDoS Detection.", "x-f5xc-description-short": "Number of HTTP loadbalancers with L7 DDoS Detection enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_only": { "type": "integer", "description": "Number of HTTP Only loadbalancers.", "title": "HTTP Only", "format": "int64", "x-displayname": "HTTP Only", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "httplb_results": { "type": "array", "description": "List of HTTP loadbalancers.", "title": "HTTP Loadbalancers", "items": { "$ref": "#/components/schemas/namespaceHTTPLoadbalancerResultType" }, "x-displayname": "List of HTTP Loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_reputation": { "type": "integer", "description": "Number of HTTP loadbalancers with IP Reputation configured.", "title": "IP Reputation", "format": "int64", "x-displayname": "IP Reputation.", "x-f5xc-description-short": "Number of HTTP loadbalancers with IP Reputation configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_user_detection": { "type": "integer", "description": "Number of HTTP loadbalancers with Malicious User Detection configured.", "title": "Malicious User Detection", "format": "int64", "x-displayname": "Malicious User Detection.", "x-f5xc-description-short": "Number of HTTP loadbalancers with Malicious User Detection configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malware_protection": { "type": "integer", "description": "Number of HTTP loadbalancers with Malware Protection configured.", "title": "Malware Protection", "format": "int64", "x-displayname": "Malware Protection.", "x-f5xc-description-short": "Number of HTTP loadbalancers with Malware Protection configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace_service_policy": { "type": "integer", "description": "Number of HTTP loadbalancers with Namespace Service Policy configured.", "title": "Namespace Service Policy", "format": "int64", "x-displayname": "Namespace Service Policy.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "type": "integer", "description": "Number of HTTP loadbalancers advertised privately.", "title": "Private Advertisement", "format": "int64", "x-displayname": "Private Advertisement.", "x-f5xc-description-short": "Number of HTTP loadbalancers advertised privately.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "type": "integer", "description": "Number of HTTP loadbalancers advertised publicly.", "title": "Public Advertisement", "format": "int64", "x-displayname": "Public Advertisement.", "x-f5xc-wire-name": "public_advertisment", "x-f5xc-description-short": "Number of HTTP loadbalancers advertised publicly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "type": "integer", "description": "Number of HTTP loadbalancers with Service Policy configured.", "title": "Service Policy", "format": "int64", "x-displayname": "Service Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf": { "type": "integer", "description": "Number of HTTP loadbalancers with WAF configured.", "title": "WAF", "format": "int64", "x-displayname": "WAF", "x-f5xc-description-short": "Number of HTTP loadbalancers with WAF configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceHTTPLoadbalancerInventoryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceHTTPLoadbalancerResultType": { "type": "object", "description": "HTTP Loadbalancer Inventory Results.", "title": "HTTPLoadbalancerResultType", "x-displayname": "HTTP Loadbalancer Inventory Results.", "x-ves-proto-message": "ves.io.schema.namespace.HTTPLoadbalancerResultType", "properties": { "api_definition_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "api_discovery_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "api_protection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "api_schema_validation_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_protection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "certification_expiration_date": { "type": "string", "description": "Certification Expiration Date.", "title": "Certification Expiration Date", "format": "date-time", "x-displayname": "Certification Expiration Date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "certification_status": { "type": "string", "description": "Certification Status.", "title": "Certification Status", "x-displayname": "Certification Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_blocking_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_side_defense_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connection_idle_timeout": { "type": "integer", "description": "Connection Idle Timeout.", "title": "Connection Idle Timeout", "format": "int64", "x-displayname": "Connection Idle Timeout.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "cookie_protection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cors_policy_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "csrf_protection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data_guard_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_auto_mitigation_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_mitigation_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_protection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_loadbalancer_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_info": { "type": "string", "description": "DNS Info", "title": "DNS Info", "x-displayname": "DNS Info", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domains": { "type": "array", "description": "Domains", "title": "Domains", "items": { "type": "string" }, "x-displayname": "Domains", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "graph_ql_inspection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_listen_port_choice": { "type": "string", "description": "HTTP Listen Port Choice.", "title": "HTTP Listen Port Choice", "x-displayname": "HTTP Listen Port Choice.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "idle_timeout": { "type": "integer", "description": "Idle Timeout.", "title": "Idle Timeout", "format": "int64", "x-displayname": "Idle Timeout.", "x-f5xc-example": "30s", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_reputation_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "loadbalancer_algorithm": { "type": "string", "description": "Loadbalancer Algorithm configured.", "title": "Loadbalancer Algorithm", "x-displayname": "Loadbalancer Algorithm.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_user_detection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_user_mitigation_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malware_protection_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mutual_tls_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of HTTP LB.", "title": "HTTP LB Name", "x-displayname": "HTTP LB Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of HTTP LB.", "title": "HTTP LB Namespace", "x-displayname": "HTTP LB Namespace.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_service_policy_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "origin_server_subset_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-wire-name": "public_advertisment_enabled", "description": "Enable or disable functionality flag", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rate_limit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"requests_per_second\": 100}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "routes_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "slow_ddos_mitigation_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tls_security_level": { "type": "string", "description": "TLS Security Level.", "title": "TLS Security Level", "x-displayname": "TLS Security Level.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_client_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_client_ip_headers_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip_type": { "type": "string", "description": "VIP Type", "title": "VIP Type", "x-displayname": "VIP Type", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_enforcement_mode": { "type": "string", "description": "WAF Enforcement Mode.", "title": "WAF Enforcement Mode", "x-displayname": "WAF Enforcement Mode.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_exclusion_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_policy_ref": { "type": "array", "description": "Reference to the WAF policy (if applicable)", "title": "WAF Policy Reference", "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "WAF Policy Reference.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Reference to the WAF policy (if applicable).", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceHTTPLoadbalancerResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceHTTPLoadbalancerWafFilterResultType": { "type": "object", "description": "HTTP Loadbalancer WAF Filter Inventory Results.", "title": "HTTPLoadbalancerWafFilterResultType", "x-displayname": "HTTP Loadbalancer Inventory Results.", "x-ves-proto-message": "ves.io.schema.namespace.HTTPLoadbalancerWafFilterResultType", "properties": { "name": { "type": "string", "description": "Name of HTTP LB.", "title": "HTTP LB Name", "x-displayname": "HTTP LB Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of HTTP LB.", "title": "HTTP LB Namespace", "x-displayname": "HTTP LB Namespace.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "HTTP Loadbalancer WAF Filter Inventory Results.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceHTTPLoadbalancerWafFilterResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of namespace", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.namespace.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/namespaceListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceListResponseItem": { "type": "object", "description": "By default a summary of namespace is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of namespace", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.namespace.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this namespace.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this namespace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this namespace.", "title": "description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates namespace is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates namespace is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemanamespaceGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this namespace.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this namespace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this namespace.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/schemanamespaceStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this namespace.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of namespace is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of namespace is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceLookupUserRolesReq": { "type": "object", "description": "Request body of LookupUserRoles request.", "title": "LookupUserRolesReq", "x-displayname": "Request for LookupUserRoles.", "x-ves-proto-message": "ves.io.schema.namespace.LookupUserRolesReq", "properties": { "namespace": { "type": "string", "description": "Name of the namespace to lookup user roles.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the namespace to lookup user roles.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request body of LookupUserRoles request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceLookupUserRolesReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceLookupUserRolesResp": { "type": "object", "description": "Response body of LookupUserRoles request.", "title": "LookupUserRolesResp", "x-displayname": "Response for LookupUserRoles.", "x-ves-proto-message": "ves.io.schema.namespace.LookupUserRolesResp", "properties": { "roles": { "type": "array", "description": "List of user roles.", "title": "roles", "items": { "type": "string" }, "x-displayname": "Roles", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response body of LookupUserRoles request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceLookupUserRolesResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceNGINXOneServerInventoryFilterType": { "type": "object", "description": "NGINX One Server Inventory Filter.", "title": "NGINXOneServerInventoryFilterType", "x-displayname": "Filter for NGINX One Server Inventory.", "x-ves-proto-message": "ves.io.schema.namespace.NGINXOneServerInventoryFilterType", "properties": { "api_discovery": { "type": "boolean", "description": "Filter results with NGINX One Server with specified API Discovery enablement state.", "title": "API Discovery", "format": "boolean", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Filter results with NGINX One Server with specified API Discovery enablement state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_configured": { "type": "boolean", "description": "Filter results with NGINX One Server with specified WAF enablement state.", "title": "WAF", "format": "boolean", "x-displayname": "WAF", "x-f5xc-description-short": "Filter results with NGINX One Server with specified WAF enablement state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceNGINXOneServerInventoryFilterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceNGINXOneServerInventoryType": { "type": "object", "description": "Inventory of configured NGINX One Servers.", "title": "NGINX One Server Inventory", "x-displayname": "NGINX One Servers.", "x-ves-proto-message": "ves.io.schema.namespace.NGINXOneServerInventoryType", "properties": { "api_discovery_enabled_server_count": { "type": "integer", "description": "Number of NGINX One Servers with API Discovery enabled.", "title": "API Discovery", "format": "int64", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Number of NGINX One Servers with API Discovery enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nginx_server_results": { "type": "array", "description": "List of NGINX One Server.", "title": "NGINX One Servers", "items": { "$ref": "#/components/schemas/namespaceNGINXOneServerResultType" }, "x-displayname": "List of NGINX One Server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_enabled_server_count": { "type": "integer", "description": "Number of NGINX One Servers with WAF configured.", "title": "WAF", "format": "int64", "x-displayname": "WAF", "x-f5xc-description-short": "Number of NGINX One Servers with WAF configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Inventory of configured NGINX One Servers.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceNGINXOneServerInventoryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceNGINXOneServerResultType": { "type": "object", "x-ves-proto-message": "ves.io.schema.namespace.NGINXOneServerResultType", "properties": { "api_discovery_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domains": { "type": "array", "description": "Domains of NGINX One Server.", "title": "Nginx One Server Domains", "items": { "type": "string" }, "x-displayname": "NGINX One Server Domains.", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Uniqueness identifier for NGINX One Server.", "title": "Name", "x-displayname": "Server Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Uniqueness identifier for NGINX One Server.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "nginx_one_object_id": { "type": "string", "description": "Instance or Config Sync Group ID.", "title": "NGINX One Object Id", "x-displayname": "Instance or Config Sync Group Object ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "nginx_one_object_name": { "type": "string", "description": "Hostname value set for Instance or Name for a Config Sync Group\nin NGINX One.", "title": "NGINX One Object Name", "x-displayname": "Instance or Config Sync Group Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname value set for Instance or Name for a Config Sync Group in NGINX One.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nginx_one_server_name": { "type": "string", "description": "Server name specified as ${server_name} in NGINX config plus port.", "title": "Nginx One Server Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Server name specified as ${server_name} in NGINX config plus port.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_routes": { "type": "integer", "description": "Total locations configured in the NGINX Server.", "title": "Total locations configured in the NGINX Server", "format": "int64", "x-displayname": "Routes", "x-f5xc-description-short": "Total locations configured in the NGINX Server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_enforcement_mode": { "type": "string", "description": "WAF Enforcement Mode.", "title": "WAF Enforcement Mode", "x-displayname": "WAF Enforcement Mode.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_policy_file_name": { "type": "string", "description": "Policy file name for WAF.", "title": "Waf Policy File Names", "x-displayname": "WAF Policy File Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_policy_management_platform": { "type": "string", "description": "Specifies the platform that manages related WAF policies.", "title": "WAF policy_management_platform", "x-displayname": "WAF Policy Management Platform.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Specifies the platform that manages related WAF policies.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "waf_policy_name": { "type": "string", "description": "Policy name configured for WAF.", "title": "Waf Policy Name", "x-displayname": "WAF Policy Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_security_log_enabled": { "type": "boolean", "description": "Specifies if security logging is enabled.", "title": "security_log_enabled", "format": "boolean", "x-displayname": "WAF Log Enabled.", "x-f5xc-description-short": "Specifies if security logging is enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waf_security_log_file_names": { "type": "array", "description": "WAF Security File Names.", "title": "WAF Security File Names", "items": { "type": "string" }, "x-displayname": "WAF Security File Names.", "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceNGINXOneServerResultType", "required_fields": [ "waf_policy_management_platform" ], "mutually_exclusive_groups": [], "example_json": "{\n \"waf_policy_management_platform\": \"value\"\n}", "example_yaml": "waf_policy_management_platform: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceNamespaceAPIListReq": { "type": "object", "description": "NamespaceAPIListReq holds the namespace and its associated APIs.", "title": "NamespaceAPIListReq", "x-displayname": "Namespace API List.", "x-ves-proto-message": "ves.io.schema.namespace.NamespaceAPIListReq", "properties": { "item_lists": { "type": "array", "description": "A list of request API item lists.", "title": "item_lists", "maxItems": 15, "items": { "$ref": "#/components/schemas/namespaceAPIItemListReq" }, "x-displayname": "Item Lists.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "15" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "15" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 15, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Name of the namespace under which all the URLs in APIItems will be evaluated.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the namespace under which all the URLs in APIItems will be evaluated.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "NamespaceAPIListReq holds the namespace and its associated APIs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceNamespaceAPIListReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceNamespaceAPIListResp": { "type": "object", "description": "NamespaceAPIListResp holds the namespace and its associated APIs.", "title": "NamespaceAPIListResp", "x-displayname": "Namespace API List Resp.", "x-ves-proto-message": "ves.io.schema.namespace.NamespaceAPIListResp", "properties": { "item_lists": { "type": "array", "description": "A list of response API item lists.", "title": "item_lists", "items": { "$ref": "#/components/schemas/namespaceAPIItemListResp" }, "x-displayname": "Item Lists.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Name of the namespace under which all the URLs in item lists were evaluated.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the namespace under which all the URLs in item lists were evaluated.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "NamespaceAPIListResp holds the namespace and its associated APIs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceNamespaceAPIListResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceNetworkingInventoryRequest": { "type": "object", "description": "Request for inventory of networking related objects.", "title": "NetworkingInventoryRequest", "x-displayname": "Networking related objects inventory request.", "x-ves-proto-message": "ves.io.schema.namespace.NetworkingInventoryRequest", "x-f5xc-description-short": "Request for inventory of networking related objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceNetworkingInventoryRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceNetworkingInventoryResponse": { "type": "object", "description": "Response for inventory of networking related objects.", "title": "NetworkingInventoryResponse", "x-displayname": "Networking related objects inventory response.", "x-ves-proto-message": "ves.io.schema.namespace.NetworkingInventoryResponse", "properties": { "cloud_links": { "type": "integer", "description": "Number of CloudLinks.", "title": "CloudLinks", "format": "int64", "x-displayname": "CloudLinks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dc_cluster_groups": { "type": "integer", "description": "Number of DC cluster groups configured.", "title": "DC Cluster Groups", "format": "int64", "x-displayname": "DC Cluster Groups.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "global_networks": { "type": "integer", "description": "Number of global networks configured.", "title": "Global Networks", "format": "int64", "x-displayname": "Global Networks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segments": { "type": "integer", "description": "Number of Segments.", "title": "Segments", "format": "int64", "x-displayname": "Segments", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_mesh_groups": { "type": "integer", "description": "Number of site mesh groups configured.", "title": "Site Mesh Groups", "format": "int64", "x-displayname": "Site Mesh Groups.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sites": { "type": "integer", "description": "Number of sites configured.", "title": "Sites", "format": "int64", "x-displayname": "Sites", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for inventory of networking related objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceNetworkingInventoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespacePublicAdvertiseChoice": { "type": "string", "description": "Enum for advertisement choice on public.\n\nInherit tenant's default.\nEnable enables advertisement on public.\nDisable disables advertisement on public.", "title": "PublicAdvertiseChoice", "enum": [ "Default", "Enable", "Disable" ], "default": "Default", "x-displayname": "PublicAdvertiseChoice.", "x-ves-proto-enum": "ves.io.schema.namespace.PublicAdvertiseChoice", "x-f5xc-description-short": "Enum for advertisement choice on public. Inherit tenant's default.", "x-f5xc-description-medium": "Enum for advertisement choice on public. Inherit tenant's default. Enable enables advertisement on public. Disable disables advertisement on public.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespacePublicAdvertiseChoice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"Default\"", "example_yaml": "Default\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a namespace", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.namespace.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemanamespaceReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Logical grouping for F5 XC resources within a tenant", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.namespace.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetActiveAlertPoliciesRequest": { "type": "object", "description": "SetActiveAlertPoliciesRequest is the shape of the request for SetActiveAlertPolicies.", "title": "SetActiveAlertPoliciesRequest", "x-displayname": "Request for SetActiveAlertPolicies.", "x-ves-proto-message": "ves.io.schema.namespace.SetActiveAlertPoliciesRequest", "properties": { "alert_policies": { "type": "array", "description": "A list of references to alert_policy objects.", "title": "alert_policies", "maxItems": 32, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Alert Policies.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-f5xc-description-short": "List of references to alert_policy objects.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "The name of the namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "SetActiveAlertPoliciesRequest is the shape of the request for SetActiveAlertPolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetActiveAlertPoliciesRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetActiveAlertPoliciesResponse": { "type": "object", "description": "SetActiveAlertPoliciesResponse is the shape of the response for SetActiveAlertPolicies.", "title": "SetActiveAlertPoliciesResponse", "x-displayname": "Response for SetActiveAlertPolicies.", "x-ves-proto-message": "ves.io.schema.namespace.SetActiveAlertPoliciesResponse", "x-f5xc-description-short": "SetActiveAlertPoliciesResponse is the shape of the response for SetActiveAlertPolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetActiveAlertPoliciesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetActiveNetworkPoliciesRequest": { "type": "object", "description": "SetActiveNetworkPoliciesRequest is the shape of the request for SetActiveNetworkPolicies.", "title": "SetActiveNetworkPoliciesRequest", "x-displayname": "Request for SetActiveNetworkPolicies.", "x-ves-proto-message": "ves.io.schema.namespace.SetActiveNetworkPoliciesRequest", "properties": { "namespace": { "type": "string", "description": "The name of the namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "network_policies": { "type": "array", "description": "A list of references to network_policy objects.", "title": "network_policies", "maxItems": 32, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Network Policies.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-f5xc-description-short": "List of references to network_policy objects.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SetActiveNetworkPoliciesRequest is the shape of the request for SetActiveNetworkPolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetActiveNetworkPoliciesRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetActiveNetworkPoliciesResponse": { "type": "object", "description": "SetActiveNetworkPoliciesResponse is the shape of the response for SetActiveNetworkPolicies.", "title": "SetActiveNetworkPoliciesResponse", "x-displayname": "Response for SetActiveNetworkPolicies.", "x-ves-proto-message": "ves.io.schema.namespace.SetActiveNetworkPoliciesResponse", "x-f5xc-description-short": "SetActiveNetworkPoliciesResponse is the shape of the response for SetActiveNetworkPolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetActiveNetworkPoliciesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetActiveServicePoliciesRequest": { "type": "object", "description": "SetActiveServicePoliciesRequest is the shape of the request for SetActiveServicePolicies.", "title": "SetActiveServicePoliciesRequest", "x-displayname": "Request for SetActiveServicePolicies.", "x-ves-proto-message": "ves.io.schema.namespace.SetActiveServicePoliciesRequest", "properties": { "namespace": { "type": "string", "description": "The name of the namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "service_policies": { "type": "array", "description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.", "title": "service_policies", "maxItems": 32, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Service Policies.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-f5xc-description-short": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other.", "x-f5xc-description-medium": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the correct order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result. For each request, its...", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SetActiveServicePoliciesRequest is the shape of the request for SetActiveServicePolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetActiveServicePoliciesRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetActiveServicePoliciesResponse": { "type": "object", "description": "SetActiveServicePoliciesResponse is the shape of the response for SetActiveServicePolicies.", "title": "SetActiveServicePoliciesResponse", "x-displayname": "Response for SetActiveServicePolicies.", "x-ves-proto-message": "ves.io.schema.namespace.SetActiveServicePoliciesResponse", "x-f5xc-description-short": "SetActiveServicePoliciesResponse is the shape of the response for SetActiveServicePolicies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetActiveServicePoliciesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetFastACLsForInternetVIPsRequest": { "type": "object", "description": "SetFastACLsForInternetVIPsRequest contains list of FastACLs refs that\nshould be applied to the Internet VIPs.", "title": "SetFastACLsForInternetVIPsRequest", "x-displayname": "Request for SetFastACLsForInternetVIP.", "x-ves-proto-message": "ves.io.schema.namespace.SetFastACLsForInternetVIPsRequest", "properties": { "fast_acls": { "type": "array", "description": "The list of refs of FastACLs.", "title": "fast_acls", "maxItems": 128, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "FastACLs", "x-ves-example": "List of refs.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-f5xc-example": "list of refs", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "The name of the namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "SetFastACLsForInternetVIPsRequest contains list of FastACLs refs that should be applied to the Internet VIPs.", "x-f5xc-description-medium": "SetFastACLsForInternetVIPsRequest contains list of FastACLs refs that should be applied to the Internet VIPs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetFastACLsForInternetVIPsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSetFastACLsForInternetVIPsResponse": { "type": "object", "description": "SetFastACLsForInternetVIPsResponse is empty.", "title": "SetFastACLsForInternetVIPsResponse", "x-displayname": "Response for SetFastACLsForInternetVIPs.", "x-ves-proto-message": "ves.io.schema.namespace.SetFastACLsForInternetVIPsResponse", "x-f5xc-description-short": "SetFastACLsForInternetVIPsResponse is empty.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSetFastACLsForInternetVIPsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSeverity": { "type": "string", "description": "List of all supported severities\n\nERROR\nINFO\nWARNING\nSUCCESS.", "title": "Severity", "enum": [ "ERROR", "INFO", "WARNING", "SUCCESS" ], "default": "ERROR", "x-displayname": "Severity of message.", "x-ves-proto-enum": "ves.io.schema.namespace.Severity", "x-f5xc-description-short": "List of all supported severities ERROR INFO WARNING SUCCESS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSeverity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ERROR\"", "example_yaml": "ERROR\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSuggestValuesReq": { "type": "object", "description": "Request body of SuggestValues request.", "title": "SuggestValuesReq", "x-displayname": "Request for SuggestValues.", "x-ves-proto-message": "ves.io.schema.namespace.SuggestValuesReq", "properties": { "field_path": { "type": "string", "description": "JSON path of the field for which the suggested values are being requested.", "title": "field_path", "maxLength": 1024, "x-displayname": "Field Path.", "x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "match_value": { "type": "string", "description": "A substring that must be present in either the value or description of each SuggestedItem in the response.", "title": "match_value", "maxLength": 256, "x-displayname": "Match Value.", "x-ves-example": "Some-substring.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "some-substring", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.", "x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace in which the suggestions are scoped.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Foobar", "x-f5xc-example": "foobar", "x-f5xc-description-short": "Namespace in which the suggestions are scoped.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "request_body": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSuggestValuesReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceTCPLoadbalancerInventoryFilterType": { "type": "object", "description": "TCP Loadbalancer inventory Filter.", "title": "TCPLoadbalancerInventoryFilterType", "x-displayname": "Filter for Inventory of TCP Loadbalancers.", "x-ves-proto-message": "ves.io.schema.namespace.TCPLoadbalancerInventoryFilterType", "properties": { "namespace_service_policy": { "type": "boolean", "description": "Filter results with TCP loadbalancers with Namespace Service Policy configured.", "title": "Namespace Service Policy", "format": "boolean", "x-displayname": "Namespace Service Policy.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "type": "boolean", "description": "Filter results with TCP loadbalancers advertised privately.", "title": "Private Advertisement", "format": "boolean", "x-displayname": "Private Advertisement.", "x-f5xc-description-short": "Filter results with TCP loadbalancers advertised privately.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "type": "boolean", "description": "Filter results with TCP loadbalancers advertised publicly.", "title": "Public Advertisement", "format": "boolean", "x-displayname": "Public Advertisement.", "x-f5xc-wire-name": "public_advertisment", "x-f5xc-description-short": "Filter results with TCP loadbalancers advertised publicly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "type": "boolean", "description": "Filter results with TCP loadbalancers with Service Policy configured.", "title": "Service Policy", "format": "boolean", "x-displayname": "Service Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tls_encryption": { "type": "boolean", "description": "Filter results with TCP loadbalancers with TLS Encryption configured.", "title": "TLS Encryption", "format": "boolean", "x-displayname": "TLS Encryption.", "x-f5xc-description-short": "Filter results with TCP loadbalancers with TLS Encryption configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceTCPLoadbalancerInventoryFilterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceTCPLoadbalancerInventoryType": { "type": "object", "description": "TCP Loadbalancer inventory.", "title": "TCPLoadbalancerInventoryType", "x-displayname": "Inventory of TCP Loadbalancers.", "x-ves-proto-message": "ves.io.schema.namespace.TCPLoadbalancerInventoryType", "properties": { "namespace_service_policy": { "type": "integer", "description": "Number of TCP loadbalancers with Namespace Service Policy configured.", "title": "Namespace Service Policy", "format": "int64", "x-displayname": "Namespace Service Policy.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "type": "integer", "description": "Number of TCP loadbalancers advertised privately.", "title": "Private Advertisement", "format": "int64", "x-displayname": "Private Advertisement.", "x-f5xc-description-short": "Number of TCP loadbalancers advertised privately.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "type": "integer", "description": "Number of TCP loadbalancers advertised publicly.", "title": "Public Advertisement", "format": "int64", "x-displayname": "Public Advertisement.", "x-f5xc-wire-name": "public_advertisment", "x-f5xc-description-short": "Number of TCP loadbalancers advertised publicly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "type": "integer", "description": "Number of TCP loadbalancers with Service Policy configured.", "title": "Service Policy", "format": "int64", "x-displayname": "Service Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcplb_results": { "type": "array", "description": "List of TCP loadbalancers.", "title": "TCP Loadbalancers", "items": { "$ref": "#/components/schemas/namespaceTCPLoadbalancerResultType" }, "x-displayname": "List of TCP Loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tls_encryption": { "type": "integer", "description": "Number of TCP loadbalancers with TLS Encryption configured.", "title": "TLS Encryption", "format": "int64", "x-displayname": "TLS Encryption.", "x-f5xc-description-short": "Number of TCP loadbalancers with TLS Encryption configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceTCPLoadbalancerInventoryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceTCPLoadbalancerResultType": { "type": "object", "description": "TCP Loadbalancer Inventory Results.", "title": "TCPLoadbalancerResultType", "x-displayname": "TCP Loadbalancer Inventory Results.", "x-ves-proto-message": "ves.io.schema.namespace.TCPLoadbalancerResultType", "properties": { "name": { "type": "string", "description": "Name of TCP LB.", "title": "TCP LB Name", "x-displayname": "TCP LB Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of TCP LB.", "title": "TCP LB Namespace", "x-displayname": "TCP LB Namespace.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_service_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for private advertisement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-wire-name": "public_advertisment", "description": "Configuration parameter for public advertisement", "x-f5xc-description-short": "Configuration parameter for public advertisement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rate_limit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"requests_per_second\": 100}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tls_encryption": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for tls encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceTCPLoadbalancerResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceThirdPartyApplicationFilterType": { "type": "object", "description": "Third Party Application Inventory Filter.", "title": "ThirdPartyApplicationFilterType", "x-displayname": "Filter for Third Party ApplicationInventory.", "x-ves-proto-message": "ves.io.schema.namespace.ThirdPartyApplicationFilterType", "properties": { "api_discovery": { "type": "boolean", "description": "Filter results with Third Party Application with API Discovery.", "title": "API Discovery", "format": "boolean", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Filter results with Third Party Application with API Discovery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Third Party Application Inventory Filter.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceThirdPartyApplicationFilterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceThirdPartyApplicationInventoryType": { "type": "object", "description": "Third Party Application inventory.", "title": "ThirdPartyApplicationInventoryType", "x-displayname": "Inventory of Third Party Application.", "x-ves-proto-message": "ves.io.schema.namespace.ThirdPartyApplicationInventoryType", "properties": { "api_discovery": { "type": "integer", "description": "Number of Third Party Application with API Discovery enabled.", "title": "API Discovery", "format": "int64", "x-displayname": "API Discovery.", "x-f5xc-description-short": "Number of Third Party Application with API Discovery enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "third_party_application_results": { "type": "array", "description": "List of Third Party Applications.", "title": "ThirdPartyApplicationType", "items": { "$ref": "#/components/schemas/namespaceThirdPartyApplicationResultType" }, "x-displayname": "List of Third Party Applications.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceThirdPartyApplicationInventoryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceThirdPartyApplicationResultType": { "type": "object", "description": "Third Party Application Inventory Results.", "title": "ThirdPartyApplicationType", "x-displayname": "Third Party Application Inventory Results.", "x-ves-proto-message": "ves.io.schema.namespace.ThirdPartyApplicationResultType", "properties": { "api_discovery_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of Third Party Application.", "title": "Third Party Application Name", "x-displayname": "Third Party Application Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Third Party Application Inventory Results.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceThirdPartyApplicationResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceUDPLoadbalancerInventoryFilterType": { "type": "object", "description": "UDP Loadbalancer inventory Filter.", "title": "UDPLoadbalancerInventoryFilterType", "x-displayname": "Filter for Inventory of UDP Loadbalancers.", "x-ves-proto-message": "ves.io.schema.namespace.UDPLoadbalancerInventoryFilterType", "properties": { "namespace_service_policy": { "type": "boolean", "description": "Filter results with UDP loadbalancers with Namespace Service Policy configured.", "title": "Namespace Service Policy", "format": "boolean", "x-displayname": "Namespace Service Policy.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "type": "boolean", "description": "Filter results with UDP loadbalancers advertised privately.", "title": "Private Advertisement", "format": "boolean", "x-displayname": "Private Advertisement.", "x-f5xc-description-short": "Filter results with UDP loadbalancers advertised privately.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "type": "boolean", "description": "Filter results with UDP loadbalancers advertised publicly.", "title": "Public Advertisement", "format": "boolean", "x-displayname": "Public Advertisement.", "x-f5xc-wire-name": "public_advertisment", "x-f5xc-description-short": "Filter results with UDP loadbalancers advertised publicly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "type": "boolean", "description": "Filter results with UDP loadbalancers with Service Policy configured.", "title": "Service Policy", "format": "boolean", "x-displayname": "Service Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceUDPLoadbalancerInventoryFilterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceUDPLoadbalancerInventoryType": { "type": "object", "description": "UDP Loadbalancer inventory.", "title": "UDPLoadbalancerInventoryType", "x-displayname": "Inventory of UDP Loadbalancers.", "x-ves-proto-message": "ves.io.schema.namespace.UDPLoadbalancerInventoryType", "properties": { "namespace_service_policy": { "type": "integer", "description": "Number of UDP loadbalancers with Namespace Service Policy configured.", "title": "Namespace Service Policy", "format": "int64", "x-displayname": "Namespace Service Policy.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "type": "integer", "description": "Number of UDP loadbalancers advertised privately.", "title": "Private Advertisement", "format": "int64", "x-displayname": "Private Advertisement.", "x-f5xc-description-short": "Number of UDP loadbalancers advertised privately.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "type": "integer", "description": "Number of UDP loadbalancers advertised publicly.", "title": "Public Advertisement", "format": "int64", "x-displayname": "Public Advertisement.", "x-f5xc-wire-name": "public_advertisment", "x-f5xc-description-short": "Number of UDP loadbalancers advertised publicly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "type": "integer", "description": "Number of UDP loadbalancers with Service Policy configured.", "title": "Service Policy", "format": "int64", "x-displayname": "Service Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "udplb_results": { "type": "array", "description": "List of UDP loadbalancers.", "title": "UDP Loadbalancers", "items": { "$ref": "#/components/schemas/namespaceUDPLoadbalancerResultType" }, "x-displayname": "List of UDP Loadbalancers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceUDPLoadbalancerInventoryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceUDPLoadbalancerResultType": { "type": "object", "description": "UDP Loadbalancer Inventory Results.", "title": "UDPLoadbalancerResultType", "x-displayname": "UDP Loadbalancer Inventory Results.", "x-ves-proto-message": "ves.io.schema.namespace.UDPLoadbalancerResultType", "properties": { "name": { "type": "string", "description": "Name of UDP LB.", "title": "UDP LB Name", "x-displayname": "UDP LB Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of UDP LB.", "title": "UDP LB Namespace", "x-displayname": "UDP LB Namespace.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_service_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_advertisement": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for private advertisement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_advertisement": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-wire-name": "public_advertisment", "description": "Configuration parameter for public advertisement", "x-f5xc-description-short": "Configuration parameter for public advertisement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceUDPLoadbalancerResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceUpdateAllowAdvertiseOnPublicReq": { "type": "object", "description": "Request body of UpdateAllowAdvertiseOnPublic request.", "title": "UpdateAllowAdvertiseOnPublicReq", "x-displayname": "Request for UpdateAllowAdvertiseOnPublic.", "x-ves-proto-message": "ves.io.schema.namespace.UpdateAllowAdvertiseOnPublicReq", "properties": { "allow_advertise_on_public": { "allOf": [ { "$ref": "#/components/schemas/namespacePublicAdvertiseChoice" } ], "x-f5xc-description-short": "Configuration parameter for allow advertise on public.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Name of the namespace under which all the URLs in APIItems will be evaluated.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the namespace under which all the URLs in APIItems will be evaluated.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request body of UpdateAllowAdvertiseOnPublic request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceUpdateAllowAdvertiseOnPublicReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceUpdateAllowAdvertiseOnPublicResp": { "type": "object", "description": "Response body of UpdateAllowAdvertiseOnPublic request.", "title": "UpdateAllowAdvertiseOnPublicResp", "x-displayname": "Response for UpdateAllowAdvertiseOnPublic.", "x-ves-proto-message": "ves.io.schema.namespace.UpdateAllowAdvertiseOnPublicResp", "properties": { "result": { "type": "boolean", "description": "API result.", "title": "result", "format": "boolean", "x-displayname": "Result", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response body of UpdateAllowAdvertiseOnPublic request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceUpdateAllowAdvertiseOnPublicResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceValidateRulesReq": { "type": "object", "description": "Request body of ValidateRulesReq request.", "title": "ValidateRulesReq", "x-displayname": "Request for validating according to rules specified in the validator_evaluation.", "x-ves-proto-message": "ves.io.schema.namespace.ValidateRulesReq", "properties": { "namespace": { "type": "string", "description": "The name of the namespace which will be system in this case.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "x-f5xc-description-short": "The name of the namespace which will be system in this case.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "validator_evaluation": { "type": "object", "description": "Map contains validators which needs to be evaluated.", "title": "validator evaluation", "x-displayname": "Validator evaluation.", "x-ves-example": "The map key would be the validator type e.g. XStringRegex and the map value is the validator value e.g. True.", "x-f5xc-example": "The map key would be the validator type e.g. XStringRegex and the map value is the validator value e.g. true", "x-f5xc-description-short": "Map contains validators which needs to be evaluated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "The value to be validated.", "title": "value", "x-displayname": "Value", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Request body of ValidateRulesReq request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceValidateRulesReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceValidateRulesResponse": { "type": "object", "description": "Response body of ValidateRulesReq request.", "title": "ValidateRulesResponse", "x-displayname": "Response for ValidateRulesReq.", "x-ves-proto-message": "ves.io.schema.namespace.ValidateRulesResponse", "properties": { "error": { "type": "string", "description": "Error returned in case the value does not match the validator rules.", "title": "error", "x-displayname": "Error", "x-f5xc-description-short": "Error returned in case the value does not match the validator rules.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "success": { "type": "boolean", "description": "This will set true if validation is successful on value.", "title": "success", "format": "boolean", "x-displayname": "Success", "x-f5xc-description-short": "Will set true if validation is successful on value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validation_results": { "type": "array", "description": "This will return a list of validation results based on validators passed as input.", "title": "Validation Results", "items": { "$ref": "#/components/schemas/namespaceValidationResult" }, "x-displayname": "Validation Results.", "x-f5xc-description-short": "Will return a list of validation results based on validators passed as input.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response body of ValidateRulesReq request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceValidateRulesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceValidationResult": { "type": "object", "x-ves-proto-message": "ves.io.schema.namespace.ValidationResult", "properties": { "message": { "type": "string", "description": "Information message will be returned for inline notification and error messages for validation rules.", "title": "Messsge", "x-displayname": "Message", "x-f5xc-description-short": "Information message will be returned for inline notification and error messages for validation rules.", "x-f5xc-description-medium": "Information message will be returned for inline notification and error messages for validation rules.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "severity": { "allOf": [ { "$ref": "#/components/schemas/namespaceSeverity" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceValidationResult", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemanamespaceCreateSpecType": { "type": "object", "description": "Creates a new namespace. Name of the object is name of the name space.", "title": "Create namespace", "x-displayname": "Create Namespace.", "x-ves-proto-message": "ves.io.schema.namespace.CreateSpecType", "x-f5xc-description-short": "Creates a new namespace. Name of the object is name of the name space.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanamespaceCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemanamespaceGetSpecType": { "type": "object", "description": "This is the read representation of the namespace object.", "title": "Get namespace", "x-displayname": "GET Namespace.", "x-ves-proto-message": "ves.io.schema.namespace.GetSpecType", "x-f5xc-description-short": "Read representation of the namespace object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanamespaceGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemanamespaceReplaceSpecType": { "type": "object", "description": "Replaces attributes of a namespace including its metadata like labels, description etc.", "title": "Replace namespace", "x-displayname": "Replace Namespace.", "x-ves-proto-message": "ves.io.schema.namespace.ReplaceSpecType", "x-f5xc-description-short": "Replaces attributes of a namespace including its metadata like labels, description etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanamespaceReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemanamespaceStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.namespace.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "Conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "object", "description": "It specifies programming information of all the finalizers.", "title": "Finalizers", "x-displayname": "Finalizers.", "x-f5xc-description-short": "It specifies programming information of all the finalizers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "type": "object", "description": "It specifies programming information of all the initializers.", "title": "Initializers", "x-displayname": "Initializers.", "x-f5xc-description-short": "It specifies programming information of all the initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "A namespace direct reference.", "title": "ObjectRefs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanamespaceStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemanamespaceSuggestValuesResp": { "type": "object", "description": "Response body of SuggestValues request.", "title": "SuggestValuesResp", "x-displayname": "Response for SuggestValues.", "x-ves-proto-message": "ves.io.schema.namespace.SuggestValuesResp", "properties": { "items": { "type": "array", "description": "List of suggested items.", "title": "item_lists", "items": { "$ref": "#/components/schemas/schemanamespaceSuggestedItem" }, "x-displayname": "Suggested Items.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanamespaceSuggestValuesResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemanamespaceSuggestedItem": { "type": "object", "description": "A tuple with a suggested value and it's description.", "title": "SuggestedItem", "x-displayname": "Suggested Item.", "x-ves-oneof-field-value_choice": "[\"ref_value\",\"str_value\"]", "x-ves-proto-message": "ves.io.schema.namespace.SuggestedItem", "properties": { "description": { "type": "string", "description": "Optional description for the suggested value.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "Optional description for the suggested value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ref_value": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "str_value" ], "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "ref_value", "gated_by": { "choice": "value_choice" }, "required": false, "cardinality": "single" } ] }, "str_value": { "type": "string", "description": "Exclusive with [ref_value]", "title": "str_value", "x-displayname": "String", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ref_value" ] }, "title": { "type": "string", "description": "Optional title to be displayed instead of the actual value.\nUsed when pure value doesn't contain all the needed information to be displayed,\nor when display titles should be customized.", "title": "title", "x-displayname": "Title", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Optional title to be displayed instead of the actual value.", "x-f5xc-description-medium": "Optional title to be displayed instead of the actual value. Used when pure value doesn't contain all the needed information to be displayed, or when display titles should be customized.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "value": { "type": "string", "description": "Suggested value for the field.\nShould use value_choice.str_value instead.", "title": "value", "x-displayname": "Value", "x-f5xc-description-short": "Suggested value for the field. Should use value_choice.str_value instead.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Tuple with a suggested value and it's description.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanamespaceSuggestedItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "virtual_hostVirtualHostType": { "type": "string", "description": "VirtualHostType tells the type of virtual_host. Functionally, all types are same,\nthis is mainly used for categorizing metrics.\n\n- VIRTUAL_SERVICE: VirtualService\n\nVirtual Host used Virtual Service\n- HTTP_LOAD_BALANCER: HTTP LoadBalancer\n\nVirtual Host used as Load Balancer\n- API_GATEWAY: APIGateway\n\nVirtual Host used API Gateway\n- TCP_LOAD_BALANCER: TCP LoadBalancer\n\nVirtual Host used as Load Balancer\n- PROXY: Proxy\n\nVirtual Host used as Proxy\n- LOCAL_K8S_API_GATEWAY: LOCAL_K8S_API_GATEWAY\n\nInternal use only, used for K8s cluster API gateway on the site.\n- CDN_LOAD_BALANCER: CDN LoadBalancer\n\nVirtual Host used as Load Balancer\n- NGINX_SERVER: NGINX Server\n\nVirtual Host representing an NGINX Server block\n- BIGIP_VIRTUAL_SERVER: BIG-IP Virtual Server\n\nVirtual Host representing a BIG-IP Virtual Server\n- UDP_LOAD_BALANCER: UDP LoadBalancer\n\nVirtual Host used as Load Balancer\n- TMM_PROXY: TMM Proxy\n\nVirtual Host for TMM Proxy\n- THIRD_PARTY_APPLICATION: THIRD PARTY Virtual Server\n\nVirtual Host representing a Third Party Application.", "title": "VirtualHostType", "enum": [ "VIRTUAL_SERVICE", "HTTP_LOAD_BALANCER", "API_GATEWAY", "TCP_LOAD_BALANCER", "PROXY", "CDN_LOAD_BALANCER", "NGINX_SERVER", "UDP_LOAD_BALANCER" ], "default": "VIRTUAL_SERVICE", "x-displayname": "Virtual Host Type.", "x-ves-proto-enum": "ves.io.schema.virtual_host.VirtualHostType", "x-f5xc-description-short": "VirtualHostType tells the type of virtual_host.", "x-f5xc-description-medium": "VirtualHostType tells the type of virtual_host. Functionally, all types are same, this is mainly used for categorizing metrics. - VIRTUAL_SERVICE: VirtualService Virtual Host used Virtual Service - HTTP_LOAD_BALANCER: HTTP LoadBalancer Virtual Host used as Load Balancer - API_GATEWAY: APIGateway...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_hostVirtualHostType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VIRTUAL_SERVICE\"", "example_yaml": "VIRTUAL_SERVICE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual host configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "namespace_roleGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read namespace_role", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.namespace_role.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/namespace_roleGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/namespace_roleStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespace_roleGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "identity", "multi_tenant_pattern": "per-tenant" } } }, "namespace_roleGetSpecType": { "type": "object", "description": "Allows listing a role of a user in a namespace.", "title": "Get Namespace role", "x-displayname": "GET Namespace Role.", "x-ves-proto-message": "ves.io.schema.namespace_role.GetSpecType", "properties": { "namespace": { "type": "string", "description": "Namespace the user has the role defined in Role field.", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace the user has the role defined in Role field.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "role": { "type": "array", "description": "Reference to role.", "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Role", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "user": { "type": "array", "description": "Reference to user.", "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "User", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "0" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "0" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "minItems": 0, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Allows listing a role of a user in a namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespace_roleGetSpecType", "required_fields": [ "namespace", "role", "user" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"system\",\n \"role\": [\n {}\n ],\n \"user\": [\n {}\n ]\n}", "example_yaml": "namespace: system\nrole:\n- {}\nuser:\n- {}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "identity", "multi_tenant_pattern": "per-tenant" } } }, "namespace_roleListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of namespace_role", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.namespace_role.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/namespace_roleListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespace_roleListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "identity", "multi_tenant_pattern": "per-tenant" } } }, "namespace_roleListResponseItem": { "type": "object", "description": "By default a summary of namespace_role is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of namespace_role", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.namespace_role.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this namespace_role.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this namespace_role.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this namespace_role.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this namespace_role.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates namespace_role is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates namespace_role is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/namespace_roleGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this namespace_role.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this namespace_role.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this namespace_role.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/namespace_roleStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this namespace_role.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of namespace_role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of namespace_role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespace_roleListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "identity", "multi_tenant_pattern": "per-tenant" } } }, "namespace_roleStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Namespace role object status", "x-displayname": "Namespace role status.", "x-ves-proto-message": "ves.io.schema.namespace_role.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespace_roleStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "identity", "multi_tenant_pattern": "per-tenant" } } }, "rbac_policyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read rbac_policy", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.rbac_policy.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemarbac_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/rbac_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for rbac_policyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "rbac_policyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of rbac_policy", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.rbac_policy.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/rbac_policyListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for rbac_policyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "rbac_policyListResponseItem": { "type": "object", "description": "By default a summary of rbac_policy is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of rbac_policy", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.rbac_policy.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this rbac_policy.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this rbac_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this rbac_policy.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this rbac_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates rbac_policy is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates rbac_policy is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemarbac_policyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this rbac_policy.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this rbac_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this rbac_policy.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/rbac_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this rbac_policy.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of rbac_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of rbac_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for rbac_policyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "rbac_policyRBACPolicyRuleType": { "type": "object", "description": "Shape of rules of rbac_policy in the storage backend.", "title": "RBACPolicyRuleType", "x-displayname": "RBAC Rule Specification.", "x-ves-proto-message": "ves.io.schema.rbac_policy.RBACPolicyRuleType", "properties": { "api_group": { "type": "string", "description": "API version or group", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of rules of rbac_policy in the storage backend.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for rbac_policyRBACPolicyRuleType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "rbac_policyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of rbac Policy", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.rbac_policy.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for rbac_policyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemarbac_policyGetSpecType": { "type": "object", "description": "GET rbac_policy reads a given object from storage backend for metadata.namespace.", "title": "Get rbac policy", "x-displayname": "GET RBAC Policy.", "x-ves-displayorder": "1", "x-ves-proto-message": "ves.io.schema.rbac_policy.GetSpecType", "properties": { "rules": { "type": "array", "description": "A list of references to RBACPolicyRuleType objects.\nEach rule consist of an API group name.", "maxItems": 256, "items": { "$ref": "#/components/schemas/rbac_policyRBACPolicyRuleType" }, "x-displayname": "Rules", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "256" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "256" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of references to RBACPolicyRuleType objects. Each rule consist of an API group name.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 256, "minItems": 0, "uniqueItems": false, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GET rbac_policy reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemarbac_policyGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "roleCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of role", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.role.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/roleCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.role.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/roleGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleCreateSpecType": { "type": "object", "description": "Creates a role.", "title": "Role", "x-displayname": "Create Role.", "x-ves-proto-message": "ves.io.schema.role.CreateSpecType", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleCustomCreateRequest": { "type": "object", "description": "Custom request to create role object and rbac_policy object.", "title": "CustomCreateRequest", "x-displayname": "Custom Create Request.", "x-ves-proto-message": "ves.io.schema.role.CustomCreateRequest", "properties": { "api_groups": { "type": "array", "description": "API Groups the role has access to.", "title": "API Groups", "minItems": 1, "items": { "type": "string" }, "x-displayname": "ApiGroups", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/roleCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Custom request to create role object and rbac_policy object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleCustomCreateRequest", "required_fields": [ "api_groups" ], "mutually_exclusive_groups": [], "example_json": "{\n \"api_groups\": [\n \"value\"\n ]\n}", "example_yaml": "api_groups:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleCustomGetResponse": { "type": "object", "description": "Response for CustomGet API.", "title": "CustomGetResponse", "x-displayname": "Custom GET Response.", "x-ves-proto-message": "ves.io.schema.role.CustomGetResponse", "properties": { "api_groups": { "type": "array", "description": "The API groups that the role can access.", "title": "API Group", "items": { "type": "string" }, "x-displayname": "API Groups.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The API groups that the role can access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object": { "allOf": [ { "$ref": "#/components/schemas/roleObject" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleCustomGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleCustomListResponse": { "type": "object", "description": "Response for CustomList API.", "title": "CustomListResponse", "x-displayname": "Custom List Response.", "x-ves-proto-message": "ves.io.schema.role.CustomListResponse", "properties": { "items": { "type": "array", "description": "The list of the roles for specific request.", "title": "Role", "items": { "$ref": "#/components/schemas/roleRole" }, "x-displayname": "Role", "x-ves-example": "[{role_object}]", "x-f5xc-example": "[{role_object}]", "x-f5xc-description-short": "The list of the roles for specific request.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleCustomListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleCustomReplaceRequest": { "type": "object", "description": "Custom request to update a role object.", "title": "CustomeReplaceRequest", "x-displayname": "Custom Replace Request.", "x-ves-proto-message": "ves.io.schema.role.CustomReplaceRequest", "properties": { "api_groups": { "type": "array", "description": "API Groups the role has access to.", "title": "API Groups", "minItems": 1, "items": { "type": "string" }, "x-displayname": "ApiGroups", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the role.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/roleReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleCustomReplaceRequest", "required_fields": [ "api_groups" ], "mutually_exclusive_groups": [], "example_json": "{\n \"api_groups\": [\n \"value\"\n ]\n}", "example_yaml": "api_groups:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a role", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.role.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read role", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.role.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/roleCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/roleReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/roleGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/roleStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleGetSpecType": { "type": "object", "description": "Reads a role.", "title": "Role", "x-displayname": "GET Role", "x-ves-proto-message": "ves.io.schema.role.GetSpecType", "properties": { "rbac_policy": { "type": "array", "description": "Reference to rabc_policy object which has rules defined for access on list of API Groups.", "title": "RBAC Policy", "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "RBAC Policy.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleGetSpecType", "required_fields": [ "rbac_policy" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rbac_policy\": [\n {}\n ]\n}", "example_yaml": "rbac_policy:\n- {}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleGlobalSpecType": { "type": "object", "description": "Role internally uses name (like admin) and namespace (shared) and tenant (VES-I/O) for global roles\nroles can also be tenant specific living under their respective tenant.", "title": "Role", "x-displayname": "Role", "x-ves-proto-message": "ves.io.schema.role.GlobalSpecType", "properties": { "rbac_policy": { "type": "array", "description": "Reference to rabc_policy object which has rules defined for access on list of API Groups.", "title": "RBAC Policy", "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "RBAC Policy.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Role internally uses name (like admin) and namespace (shared) and tenant (VES-I/O) for global roles roles can also be tenant specific living under...", "x-f5xc-description-medium": "Role internally uses name (like admin) and namespace (shared) and tenant (VES-I/O) for global roles roles can also be tenant specific living under their respective tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleGlobalSpecType", "required_fields": [ "rbac_policy" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rbac_policy\": [\n {}\n ]\n}", "example_yaml": "rbac_policy:\n- {}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of role", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.role.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/roleListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleListResponseItem": { "type": "object", "description": "By default a summary of role is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of role", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.role.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this role.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this role.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this role.", "title": "description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates role is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates role is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/roleGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this role.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this role.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/roleStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this role.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleObject": { "type": "object", "description": "Role object.", "title": "Role", "x-displayname": "Role", "x-ves-proto-message": "ves.io.schema.role.Object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/roleSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectMetaType__ves_io_schema_api_credential" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a role", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.role.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/roleReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.role.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleReplaceSpecType": { "type": "object", "description": "Amends a role.", "title": "Role", "x-displayname": "Replace Role.", "x-ves-proto-message": "ves.io.schema.role.ReplaceSpecType", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleRole": { "type": "object", "description": "Role entity.", "title": "Role", "x-displayname": "Role", "x-ves-proto-message": "ves.io.schema.role.Role", "properties": { "api_groups": { "type": "array", "description": "The API groups that the role can access.", "title": "API Group", "items": { "type": "string" }, "x-displayname": "API Groups.", "x-ves-example": "[f5xc-billing]", "x-f5xc-example": "[f5xc-billing]", "x-f5xc-description-short": "The API groups that the role can access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled": { "type": "boolean", "description": "Representation if role is disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "false", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/roleGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this role.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this role.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleRole", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleSpecType": { "type": "object", "description": "Shape of the role specification.", "title": "Role specification", "x-displayname": "Role specification.", "x-ves-proto-message": "ves.io.schema.role.SpecType", "properties": { "gc_spec": { "allOf": [ { "$ref": "#/components/schemas/roleGlobalSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "roleStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Role status", "x-displayname": "Role status.", "x-ves-proto-message": "ves.io.schema.role.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for roleStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Role definitions are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "schemaObjectMetaType": { "type": "object", "description": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.\nThe information in this type can be specified by user during create and replace APIs.", "title": "ObjectMetaType", "x-displayname": "Metadata", "x-ves-proto-message": "ves.io.schema.ObjectMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotations.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "additionalProperties": { "type": "string" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "additionalProperties": { "type": "string" }, "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. Object create will fail if\nprovided by the client and the value exists in the system. Typically generated by the\nserver on successful creation of an object and is not allowed to change once populated.\nShadowed by SystemObjectMeta's uid field.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system. Typically generated by the server on successful creation of an object and is not allowed to change once populated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.", "x-f5xc-description-medium": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have. The information in this type can be specified by user during create and replace APIs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaSystemObjectMetaType__ves_io_schema_api_credential": { "type": "object", "description": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.", "title": "SystemObjectMetaType", "x-displayname": "System Metadata.", "x-ves-proto-message": "ves.io.schema.SystemObjectMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.", "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "A value identifying the class of the user or service which created this configuration object.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only" }, "creator_cookie": { "type": "string", "description": "This can used by the creator of the object for later audit for e.g. By storing the\nversion identifying information of the object so at future it can be determined if\nversion present at remote end is current or stale.", "title": "creator_cookie", "x-displayname": "Creator Cookie.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Can used by the creator of the object for later audit for e.g.", "x-f5xc-description-medium": "Can used by the creator of the object for later audit for e.g. By storing the version identifying information of the object so at future it can be determined if version present at remote end is current or stale.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "A value identifying the exact user or service that created this configuration object.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only" }, "deletion_timestamp": { "type": "string", "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.", "title": "deletion_timestamp", "format": "date-time", "x-displayname": "Deletion Timestamp.", "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.", "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "direct_ref_hash": { "type": "string", "description": "A hash of the UIDs of direct references on this object. This can be used to determine if\nthis object hash has had references become resolved/unresolved.", "title": "direct_ref_hash", "x-displayname": "Direct Reference Hash.", "x-f5xc-description-short": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.", "x-f5xc-description-medium": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.", "title": "finalizers", "items": { "type": "string" }, "x-displayname": "Finalizers.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.", "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "allOf": [ { "$ref": "#/components/schemas/schemaInitializersType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-description-short": "Configuration parameter for initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the operator or software. Values here can be interpreted\nby software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "title": "labels", "x-displayname": "Labels", "x-ves-example": "'VES.I/O/soft-deleted': 'true'", "x-f5xc-example": "'F5 XC/soft-deleted''true'", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this object was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only" }, "namespace": { "type": "array", "description": "The namespace this object belongs to. This is populated by the service based on the\nmetadata.namespace field when an object is created.", "title": "namespace", "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Namespace Reference.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.", "x-f5xc-description-medium": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 6, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "object_index": { "type": "integer", "description": "Unique index for the object. Some objects need a unique integer index to be allocated\nfor each object type. This field will be populated for all objects that need it and will\nbe zero otherwise.", "title": "object_index", "format": "int64", "x-displayname": "Object Index.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.", "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "revision": { "type": "string", "description": "A revision number which always increases with each modification of the object in storage\nThis doesn't necessarily increase sequentially, but should always increase.\nThis will be 0 when first created, and before any modifications.", "title": "revision", "format": "int64", "x-displayname": "Revision", "x-f5xc-description-short": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should...", "x-f5xc-description-medium": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should always increase. This will be 0 when first created, and before any modifications.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sre_disable": { "type": "boolean", "description": "This should be set to true If F5XC/SRE operator wants to suppress an object from being\npresented to business-logic of a daemon(e.g. Due to bad-form/issue-causing Object).\nThis is meant only to be used in temporary situations for operational continuity till\na fix is rolled out in business-logic.", "title": "sre_disable", "format": "boolean", "x-displayname": "SRE Disable.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g.", "x-f5xc-description-medium": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g. Due to bad-form/issue-causing Object). This is meant only to be used in temporary situations for operational continuity till a fix is rolled out in business-logic.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "Tenant to which this configuration object belongs to. The value for this is found from\npresented credentials.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "trace_info": { "type": "string", "description": "Trace_info holds information(::) of the request doing\nthe object modification. This can be used on the watch side to create subsequent spans.\nThis information can be used to co-relate activities across services (modulo state compression)\nfor a synchronous API.", "title": "trace_info", "x-displayname": "Trace Info.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Trace_info holds information(::) of the request doing the object modification.", "x-f5xc-description-medium": "Trace_info holds information(::) of the request doing the object modification. This can be used on the watch side to create subsequent spans. This information can be used to co-relate activities across services (modulo state compression) for a synchronous API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. It is generated by\nthe server on successful creation of an object and is not allowed to change on Replace\nAPI. The value of is taken from uid field of ObjectMetaType, if provided.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vtrp_id": { "type": "string", "description": "Indicate origin of this object.", "title": "vtrp_id", "x-displayname": "VTRP ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vtrp_stale": { "type": "boolean", "description": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "title": "vtrp_stale", "format": "boolean", "x-displayname": "VTRP Stale.", "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-description-medium": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSystemObjectMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "api_credentialRecreateScimTokenRequest": { "type": "object", "description": "RecreateScimTokenRequest is the request format for generating SCIM API credential.", "title": "Recreate SCIM Token Request", "x-displayname": "Recreate SCIM Token Request.", "x-ves-proto-message": "ves.io.schema.api_credential.RecreateScimTokenRequest", "properties": { "expiration_days": { "type": "integer", "description": "Qty of days of service credential expiration. Default value is 180.\nExpiration days value can range between 1 and 730.", "title": "Expiry in days", "format": "int64", "x-displayname": "Expiry in days.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "730" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "730" }, "x-f5xc-description-short": "Qty of days of service credential expiration. Default value is 180.", "x-f5xc-description-medium": "Qty of days of service credential expiration. Default value is 180. Expiration days value can range between 1 and 730.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 730, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Value of namespace is always \"system\".", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "RecreateScimTokenRequest is the request format for generating SCIM API credential.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for api_credentialRecreateScimTokenRequest", "required_fields": [ "expiration_days" ], "mutually_exclusive_groups": [], "example_json": "{\n \"expiration_days\": 1\n}", "example_yaml": "expiration_days: 1" }, "x-f5xc-cli-domain": "api", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "API credentials are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "oidc_providerAzureOIDCSpecType": { "type": "object", "description": "AzureOIDCSpecType specifies the attributes required to configure Azure provider.", "title": "AzureOIDCSpecType", "x-displayname": "Azure OIDC Spec Type.", "x-ves-displayorder": "1,2,3,4,5,6,7,8,9,10", "x-ves-proto-message": "ves.io.schema.oidc_provider.AzureOIDCSpecType", "properties": { "authorization_url": { "type": "string", "description": "The authorization URL of your OIDC application.", "title": "authorization url", "x-displayname": "Authorization URL.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The authorization URL of your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "backchannel_logout": { "type": "boolean", "description": "Does the external IDP support backchannel logout?", "title": "backchannel logout", "format": "boolean", "x-displayname": "Backchannel Logout.", "x-f5xc-description-short": "Does the external IDP support backchannel logout?", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_id": { "type": "string", "description": "Client ID of the OIDC application registered with Azure provider.\nREQUIRED field.", "title": "client ID", "x-displayname": "Client ID", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Client ID of the OIDC application registered with Azure provider. REQUIRED field.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "client_secret": { "type": "string", "description": "Secret of the OIDC application registered with Azure provider.", "title": "client secret", "x-displayname": "Client Secret.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Secret of the OIDC application registered with Azure provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "default_scopes": { "type": "string", "description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.", "title": "default scopes", "maxLength": 256, "x-displayname": "Default Scopes.", "x-ves-example": "Openid profile email.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "openid profile email", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes.", "x-f5xc-description-medium": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "issuer": { "type": "string", "description": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "title": "issuer", "x-displayname": "Issuer", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "x-f5xc-description-medium": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "jwks_url": { "type": "string", "description": "URL where identity provider keys in JWK format are stored.", "title": "JWKS URL", "x-displayname": "JWKS URL", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "URL where identity provider keys in JWK format are stored.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "logout_url": { "type": "string", "description": "Logout URL specified in your OIDC application.", "title": "logout url", "x-displayname": "Logout URL.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Logout URL specified in your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prompt": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerPromptType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "token_url": { "type": "string", "description": "The token URL of your OIDC application.", "title": "token url", "x-displayname": "Token URL", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "user_info_url": { "type": "string", "description": "The User Info URL specified in your OIDC application.", "title": "user info url", "x-displayname": "User Info URL.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The User Info URL specified in your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AzureOIDCSpecType specifies the attributes required to configure Azure provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerAzureOIDCSpecType", "required_fields": [ "authorization_url", "client_id", "client_secret", "token_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"authorization_url\": \"value\",\n \"client_id\": \"value\",\n \"client_secret\": \"example\",\n \"token_url\": \"example\"\n}", "example_yaml": "authorization_url: value\nclient_id: value\nclient_secret: example\ntoken_url: example" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerDeleteResponse": { "type": "object", "description": "Shape of DELETE response for OIDC provider DELETE request.", "title": "Delete Response", "x-displayname": "DELETE Response.", "x-ves-proto-message": "ves.io.schema.oidc_provider.DeleteResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of DELETE response for OIDC provider DELETE request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerDeleteResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerGoogleOIDCSpecType": { "type": "object", "description": "GoogleOIDCSpecType specifies the attributes required to configure google provider.", "title": "GoogleOIDCSpecType", "x-displayname": "Google OIDC Spec Type.", "x-ves-displayorder": "1,2,3", "x-ves-proto-message": "ves.io.schema.oidc_provider.GoogleOIDCSpecType", "properties": { "client_id": { "type": "string", "description": "Client ID of the OIDC application registered with google provider.\nREQUIRED field.", "title": "client ID", "x-displayname": "Client ID", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Client ID of the OIDC application registered with google provider. REQUIRED field.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "client_secret": { "type": "string", "description": "Secret of the OIDC application registered with google provider.", "title": "client secret", "x-displayname": "Client Secret.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Secret of the OIDC application registered with google provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "hosted_domain": { "type": "string", "description": "Set hosted domain to restrict user input on login form to use email address from this email domain.\nFor example, setting value company.com will enforce user email input to have only dana@example.com\nleave empty if no restriction is required for email address. Ie for example allow dana@example.com and dana@example.com.", "title": "hosted domain", "x-displayname": "Hosted Domain.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Set hosted domain to restrict user input on login form to use email address from this email domain.", "x-f5xc-description-medium": "Set hosted domain to restrict user input on login form to use email address from this email domain. For example, setting value company.com will enforce user email input to have only dana@example.com leave empty if no restriction is required for email address. Ie for example allow...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GoogleOIDCSpecType specifies the attributes required to configure google provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerGoogleOIDCSpecType", "required_fields": [ "client_id", "client_secret" ], "mutually_exclusive_groups": [], "example_json": "{\n \"client_id\": \"value\",\n \"client_secret\": \"example\"\n}", "example_yaml": "client_id: value\nclient_secret: example" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerOIDCMappers": { "type": "object", "description": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right\nattributes for user object. Use this mapper to map values from authentication token to user attributes.", "title": "OIDC Mappers", "x-displayname": "OIDC Mappers.", "x-ves-proto-message": "ves.io.schema.oidc_provider.OIDCMappers", "properties": { "email": { "type": "string", "description": "Set authentication token field name to be used by F5XC for identifying user's email.\nPlease ensure the field name using here is set as part of authentication token from corresponding\nprovider's authentication application.", "title": "Email", "x-displayname": "Email", "x-ves-example": "Upn", "x-f5xc-example": "upn", "x-f5xc-description-short": "Set authentication token field name to be used by F5XC for identifying user's email.", "x-f5xc-description-medium": "Set authentication token field name to be used by F5XC for identifying user's email. Please ensure the field name using here is set as part of authentication token from corresponding provider's authentication application.", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right attributes for user object.", "x-f5xc-description-medium": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right attributes for user object. Use this mapper to map values from authentication token to user attributes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerOIDCMappers", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerOIDCV10SpecType": { "type": "object", "description": "OIDCV10SpecType specifies the attributes required to configure OIDC provider.", "title": "OIDCV10SpecType", "x-displayname": "OpenID Connect v1.0 Spec Type.", "x-ves-displayorder": "1,11,12,3,6,4,5,7,8,9,10,13,19,14,15,16,17,18", "x-ves-proto-message": "ves.io.schema.oidc_provider.OIDCV10SpecType", "properties": { "allowed_clock_skew": { "type": "string", "description": "Clock skew in seconds that is tolerated when validating identity provider tokens. Default value is zero.", "title": "allowed clock skew", "format": "int64", "x-displayname": "Allowed Clock Skew.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Clock skew in seconds that is tolerated when validating identity provider tokens.", "x-f5xc-description-medium": "Clock skew in seconds that is tolerated when validating identity provider tokens. Default value is zero.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "authorization_url": { "type": "string", "description": "The authorization URL of your OIDC application.", "title": "authorization url", "x-displayname": "Authorization URL.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The authorization URL of your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "backchannel_logout": { "type": "boolean", "description": "Does the external IDP support backchannel logout?", "title": "backchannel logout", "format": "boolean", "x-displayname": "Backchannel Logout.", "x-f5xc-description-short": "Does the external IDP support backchannel logout?", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_id": { "type": "string", "description": "Client ID of the OIDC application registered with your identity/OIDC provider.", "title": "client ID", "x-displayname": "Client ID", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Client ID of the OIDC application registered with your identity/OIDC provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "client_secret": { "type": "string", "description": "Secret of the OIDC application registered with your identity/OIDC provider.", "title": "client secret", "x-displayname": "Client Secret.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Secret of the OIDC application registered with your identity/OIDC provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "default_scopes": { "type": "string", "description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.", "title": "default scopes", "maxLength": 256, "x-displayname": "Default Scopes.", "x-ves-example": "Openid profile email.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "openid profile email", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes.", "x-f5xc-description-medium": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disable_user_info": { "type": "boolean", "description": "Disable fetching of user info information.", "title": "disable user info", "format": "boolean", "x-displayname": "Disable User Info.", "x-f5xc-description-short": "Disable fetching of user info information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "display_name": { "type": "string", "description": "Friendly name for identity provider.", "title": "display name", "x-displayname": "Display Name.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "display", "maxLength": 1024, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "forwarded_query_parameters": { "type": "string", "description": "Non OpenID Connect/OAuth standard query parameters to be forwarded to external IDP from the initial application request\nto Authorization Endpoint. Multiple parameters can be entered, separated by comma (,).", "title": "forwarded query parameters", "x-displayname": "Forwarded Query Parameters.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Non OpenID Connect/OAuth standard query parameters to be forwarded to external IDP from the initial application request to Authorization Endpoint.", "x-f5xc-description-medium": "Non OpenID Connect/OAuth standard query parameters to be forwarded to external IDP from the initial application request to Authorization Endpoint. Multiple parameters can be entered, separated by comma (,).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "issuer": { "type": "string", "description": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "title": "issuer", "x-displayname": "Issuer", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "x-f5xc-description-medium": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "jwks_url": { "type": "string", "description": "URL where identity provider keys in JWK format are stored.", "title": "JWKS URL", "x-displayname": "JWKS URL", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "URL where identity provider keys in JWK format are stored.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "logout_url": { "type": "string", "description": "Logout URL specified in your OIDC application.", "title": "logout url", "x-displayname": "Logout URL.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Logout URL specified in your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pass_current_locale": { "type": "boolean", "description": "Pass the current locale to the identity provider.", "title": "pass current locale", "format": "boolean", "x-displayname": "Pass Current Locale.", "x-f5xc-description-short": "Pass the current locale to the identity provider.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pass_login_hint": { "type": "boolean", "description": "Pass login_hint to identity provider.", "title": "pass login hint", "format": "boolean", "x-displayname": "Pass Login Hint.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prompt": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerPromptType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "token_url": { "type": "string", "description": "The token URL of your OIDC application.", "title": "token url", "x-displayname": "Token URL", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "user_info_url": { "type": "string", "description": "The User Info URL specified in your OIDC application.", "title": "user info url", "x-displayname": "User Info URL.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The User Info URL specified in your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validate_signatures": { "type": "boolean", "description": "Enable/disable signature validation of external IDP signatures.", "title": "validate signatures", "format": "boolean", "x-displayname": "Validate Signatures.", "x-f5xc-description-short": "Enable/disable signature validation of external IDP signatures.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "OIDCV10SpecType specifies the attributes required to configure OIDC provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerOIDCV10SpecType", "required_fields": [ "authorization_url", "client_id", "client_secret", "token_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"authorization_url\": \"value\",\n \"client_id\": \"value\",\n \"client_secret\": \"example\",\n \"token_url\": \"example\"\n}", "example_yaml": "authorization_url: value\nclient_id: value\nclient_secret: example\ntoken_url: example" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerOKTAOIDCSpecType": { "type": "object", "description": "OKTAOIDCSpecType specifies the attributes required to configure okta OIDC provider.", "title": "OKTAOIDCSpecType", "x-displayname": "Okta OpenID Connect Spec Type.", "x-ves-displayorder": "1,2,3,4,5,6,7,8,10,11", "x-ves-proto-message": "ves.io.schema.oidc_provider.OKTAOIDCSpecType", "properties": { "authorization_url": { "type": "string", "description": "The authorization URL of your OIDC application.", "title": "authorization url", "x-displayname": "Authorization URL.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The authorization URL of your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "backchannel_logout": { "type": "boolean", "description": "Does the external IDP support backchannel logout?", "title": "backchannel logout", "format": "boolean", "x-displayname": "Backchannel Logout.", "x-f5xc-description-short": "Does the external IDP support backchannel logout?", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_id": { "type": "string", "description": "Client ID of the OIDC application registered with Azure provider.", "title": "client ID", "x-displayname": "Client ID", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Client ID of the OIDC application registered with Azure provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "client_secret": { "type": "string", "description": "Secret of the OIDC application registered with Azure provider.", "title": "client secret", "x-displayname": "Client Secret.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Secret of the OIDC application registered with Azure provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "default_scopes": { "type": "string", "description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.", "title": "default scopes", "maxLength": 256, "x-displayname": "Default Scopes.", "x-ves-example": "Openid profile email.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "openid profile email", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes.", "x-f5xc-description-medium": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "issuer": { "type": "string", "description": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "title": "issuer", "x-displayname": "Issuer", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "x-f5xc-description-medium": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "jwks_url": { "type": "string", "description": "URL where identity provider keys in JWK format are stored.", "title": "JWKS URL", "x-displayname": "JWKS URL", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "URL where identity provider keys in JWK format are stored.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "logout_url": { "type": "string", "description": "Logout URL specified in your OIDC application.", "title": "logout url", "x-displayname": "Logout URL.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Logout URL specified in your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prompt": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerPromptType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "token_url": { "type": "string", "description": "The token URL of your OIDC application.", "title": "token url", "x-displayname": "Token URL", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "user_info_url": { "type": "string", "description": "The User Info URL specified in your OIDC application.", "title": "user info url", "x-displayname": "User Info URL.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The User Info URL specified in your OIDC application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "OKTAOIDCSpecType specifies the attributes required to configure okta OIDC provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerOKTAOIDCSpecType", "required_fields": [ "authorization_url", "client_id", "client_secret", "token_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"authorization_url\": \"value\",\n \"client_id\": \"value\",\n \"client_secret\": \"example\",\n \"token_url\": \"example\"\n}", "example_yaml": "authorization_url: value\nclient_id: value\nclient_secret: example\ntoken_url: example" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerPromptType": { "type": "string", "description": "Type of prompt authorization server for end-user reauthentication and consent\n\ndefault value for no prompt. When this is set, no prompt parameter will be set on authorization request.\nThe Authorization Server will not display any authentication or consent user interface page.\nThe Authorization Server prompts the End-User for consent before returning information to the Client\nThe Authorization Server prompts the End-User for reauthentication.\nThe Authorization Server prompts the End-User to select a user account.\nThis enables an End-User who has multiple accounts at the Authorization Server to select amongst\nthe multiple accounts that they might have current sessions for.", "title": "PromptType", "enum": [ "UNSPECIFIED", "NONE", "CONSENT", "LOGIN", "SELECT_ACCOUNT" ], "default": "UNSPECIFIED", "x-displayname": "Prompt Type.", "x-ves-proto-enum": "ves.io.schema.oidc_provider.PromptType", "x-f5xc-description-short": "Type of prompt authorization server for end-user reauthentication and consent default value for no prompt.", "x-f5xc-description-medium": "Type of prompt authorization server for end-user reauthentication and consent default value for no prompt. When this is set, no prompt parameter will be set on authorization request. The Authorization Server will not display any authentication or consent user interface page.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerPromptType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNSPECIFIED\"", "example_yaml": "UNSPECIFIED\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerProviderType": { "type": "string", "description": "Types of OIDC providers\n\nDefault provider. Use this for standard OpenIDConnect v1.0\nAuthenticate with Google OIDC\nAuthenticate with Azure OIDC\nAuthenticate with Okta OIDC.", "title": "ProviderType", "enum": [ "DEFAULT", "GOOGLE", "AZURE", "OKTA" ], "default": "DEFAULT", "x-displayname": "Provider Type.", "x-ves-proto-enum": "ves.io.schema.oidc_provider.ProviderType", "x-f5xc-description-short": "Types of OIDC providers Default provider.", "x-f5xc-description-medium": "Types of OIDC providers Default provider. Use this for standard OpenIDConnect v1.0 Authenticate with Google OIDC Authenticate with Azure OIDC Authenticate with Okta OIDC.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DEFAULT\"", "example_yaml": "DEFAULT\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerReplaceRequest": { "type": "object", "description": "ReplaceRequest is the request format for replacing an OIDC provider in IAM.", "title": "Replace Request", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.oidc_provider.ReplaceRequest", "properties": { "name": { "type": "string", "description": "Name of the oidc_provider object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Google", "x-f5xc-example": "google", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Supports only system namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerCustomCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ReplaceRequest is the request format for replacing an OIDC provider in IAM.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerReplaceResponse": { "type": "object", "description": "ReplaceResponse is the response format for replacing an OIDC provider in IAM.\nResponse body is empty.", "title": "Replace Response", "x-displayname": "Replace Response.", "x-ves-proto-message": "ves.io.schema.oidc_provider.ReplaceResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ReplaceResponse is the response format for replacing an OIDC provider in IAM. Response body is empty.", "x-f5xc-description-medium": "ReplaceResponse is the response format for replacing an OIDC provider in IAM. Response body is empty.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerScimSpecType": { "type": "object", "title": "ScimSpecType", "x-displayname": "Scim Specification.", "x-ves-proto-message": "ves.io.schema.oidc_provider.ScimSpecType", "properties": { "scim_client_uri": { "type": "string", "description": "SCIM Client URI.", "title": "SCIMClientUri", "x-displayname": "SCIM Client URI.", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scim_enabled": { "type": "boolean", "description": "If true, SCIM integration is enabled for the tenant.", "title": "scim_enabled", "format": "boolean", "x-displayname": "SCIM enabled.", "x-f5xc-description-short": "If true, SCIM integration is enabled for the tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerScimSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerUpdateOIDCMappersRequest": { "type": "object", "description": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right\nattributes for user object. Use this mapper to map values from authentication token to user attributes.", "title": "UpdateOIDCMappersRequest", "x-displayname": "UpdateOIDCMappersRequest.", "x-ves-proto-message": "ves.io.schema.oidc_provider.UpdateOIDCMappersRequest", "properties": { "name": { "type": "string", "description": "Name contains name/alias of underlying OIDC provider.", "title": "OIDC provider name", "x-displayname": "OIDC provider name.", "x-ves-example": "[OIDC, google, Azure-OIDC]", "x-f5xc-example": "[oidc, google, azure-oidc]", "x-f5xc-description-short": "Name contains name/alias of underlying OIDC provider.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace contains namespace of OIDC provider. Namespace should be system.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-description-short": "Namespace contains namespace of OIDC provider. Namespace should be system.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "oidc_mappers": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerOIDCMappers" } ], "x-f5xc-description-short": "Configuration parameter for oidc mappers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right attributes for user object.", "x-f5xc-description-medium": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right attributes for user object. Use this mapper to map values from authentication token to user attributes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerUpdateOIDCMappersRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerUpdateScimIntegrationRequest": { "type": "object", "description": "Request for updating the SCIM integration status for an OIDC provider.", "title": "UpdateScimIntegrationRequest", "x-displayname": "Update SCIM Integration Request.", "x-ves-proto-message": "ves.io.schema.oidc_provider.UpdateScimIntegrationRequest", "properties": { "name": { "type": "string", "description": "Name of OIDC provider object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Supports only system namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "scim_enabled": { "type": "boolean", "description": "Update the SCIM integration, either enables/disables for the OIDC provider on the basis of the provided value.", "title": "scim_enabled", "format": "boolean", "x-displayname": "SCIM enabled.", "x-f5xc-description-short": "Update the SCIM integration, either enables/disables for the OIDC provider on the basis of the provided value.", "x-f5xc-description-medium": "Update the SCIM integration, either enables/disables for the OIDC provider on the basis of the provided value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scim_token_meta": { "allOf": [ { "$ref": "#/components/schemas/api_credentialRecreateScimTokenRequest" } ], "x-f5xc-description-short": "Configuration parameter for scim token meta.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for updating the SCIM integration status for an OIDC provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerUpdateScimIntegrationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "oidc_providerUpdateScimIntegrationResponse": { "type": "object", "description": "Response for the SCIM enablement request for an OIDC provider.", "title": "UpdateScimIntegrationResponse", "x-displayname": "Update Scim Integration Response.", "x-ves-proto-message": "ves.io.schema.oidc_provider.UpdateScimIntegrationResponse", "properties": { "error": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_tenant_management_child_tenant" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scim_enabled": { "type": "boolean", "description": "This is for representing the status of scim integration.", "title": "scim_enabled", "format": "boolean", "x-displayname": "SCIM Enabled.", "x-f5xc-example": "true", "x-f5xc-description-short": "For representing the status of scim integration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scim_token": { "allOf": [ { "$ref": "#/components/schemas/schemaapi_credentialCreateResponse" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "This is the root URL that needs to be used in the external identity providers SCIM client which will be used for all API requests.\nAs an example, if root URL is https://customer.domain/API/scim/namespaces/system/v2/ actual API request client will need make for user resource is via endpoint https://customer.domain/API/scim/namespaces/system/v2/Users.", "title": "url", "x-displayname": "URL", "x-ves-example": "https://customer.domain/API/scim/namespaces/system/v2/.", "x-f5xc-example": "https://customer.domain/api/scim/namespaces/system/v2/", "x-f5xc-description-short": "Root URL that needs to be used in the external identity providers SCIM client which will be used for all API requests.", "x-f5xc-description-medium": "Root URL that needs to be used in the external identity providers SCIM client which will be used for all API requests. As an example, if root URL is https://customer.domain/API/scim/namespaces/system/v2/ actual API request client will need make for user resource is via endpoint...", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for the SCIM enablement request for an OIDC provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for oidc_providerUpdateScimIntegrationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaapi_credentialCreateResponse": { "type": "object", "description": "CreateResponse is the response format for the credential's create request.", "title": "Create response", "x-displayname": "Create Response.", "x-ves-displayorder": "1", "x-ves-proto-message": "ves.io.schema.api_credential.CreateResponse", "properties": { "active": { "type": "boolean", "format": "boolean", "description": "Indicates if the resource is active", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "type": "string", "description": "Data is the response format based on the API credential type.\nIn case of API_CERTIFICATES, the response is the base64 encoded value of\ncertificate in PKCS12 format.\nIn case of KUBE_CONFIG, the response is the base64 encoded value of the K8s kubeconfig file\nwith contents as requested - cluster,namespace and base64 encoded certificate, key and CA.", "title": "Credentials", "x-displayname": "Credentials.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Data is the response format based on the API credential type.", "x-f5xc-description-medium": "Data is the response format based on the API credential type. In case of API_CERTIFICATES, the response is the base64 encoded value of certificate in PKCS12 format. In case of KUBE_CONFIG, the response is the base64 encoded value of the K8s kubeconfig file with contents as requested ...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expiration_timestamp": { "type": "string", "format": "date-time", "description": "Configuration parameter for expiration timestamp", "x-f5xc-description-short": "Configuration parameter for expiration timestamp.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "CreateResponse is the response format for the credential's create request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaapi_credentialCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "api", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "API credentials are platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerCreateRequest": { "type": "object", "description": "Create request shape for creating an OIDC provider in IAM.", "title": "Create Request", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.oidc_provider.CreateRequest", "properties": { "namespace": { "type": "string", "description": "Supports only system namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerCustomCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Create request shape for creating an OIDC provider in IAM.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerCreateResponse": { "type": "object", "description": "Create response is the response format for the response of request to create an OIDC provider in IAM.", "title": "Create Response", "x-displayname": "Create Response.", "x-ves-proto-message": "ves.io.schema.oidc_provider.CreateResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "post_logout_redirect_uri": { "type": "string", "description": "X-displayName : \"Logout Redirect URI\"\nAfter successful logout, OIDC application may require redirect URI to be white-listed. Configure this URI in your\nOIDC app so user logout is correctly sent back our identity which will then redirect back to console app's redirect.", "title": "Post logout redirect URI", "x-f5xc-description-short": "X-displayName : \"Logout Redirect URI\" After successful logout, OIDC application may require redirect URI to be white-listed.", "x-f5xc-description-medium": "X-displayName : \"Logout Redirect URI\" After successful logout, OIDC application may require redirect URI to be white-listed. Configure this URI in your OIDC app so user logout is correctly sent back our identity which will then redirect back to console app's redirect.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "redirect_uri": { "type": "string", "description": "Upon successful creation of OIDC provider object, User needs to whitelist/allow value of this redirect\nURI in their OIDC application's allowed redirect URLs.\nThis is required as part of the OIDC authentication process, F5XC identity will be brokering the\nrequest for authentication and will be sending authentication request with URL set in the redirect_uri.\nPOST successful authentication of client browser and your identity provider, identity provider sends response\nback to F5 Distributed Cloud identity as per this redirect URI. So its a must that user has updated their OIDC application\nwith this redirect URL as valid for authentication to go through.", "title": "redirect uri", "x-displayname": "Redirect URI.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Upon successful creation of OIDC provider object, User needs to whitelist/allow value of this redirect URI in their OIDC application's allowed...", "x-f5xc-description-medium": "Upon successful creation of OIDC provider object, User needs to whitelist/allow value of this redirect URI in their OIDC application's allowed redirect URLs. This is required as part of the OIDC authentication process, F5XC identity will be brokering the request for authentication and will be...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Create response is the response format for the response of request to create an OIDC provider in IAM.", "x-f5xc-description-medium": "Create response is the response format for the response of request to create an OIDC provider in IAM.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerCustomCreateSpecType": { "type": "object", "description": "CustomCreateSpecType is the spec to create OIDC provider.", "title": "Custom Create Spec", "x-displayname": "Create OIDC Provider.", "x-ves-oneof-field-oidcproviderspec": "[\"azure_oidc_spec_type\",\"google_oidc_spec_type\",\"oidc_v10_spec_type\",\"okta_oidc_spec_type\"]", "x-ves-proto-message": "ves.io.schema.oidc_provider.CustomCreateSpecType", "properties": { "azure_oidc_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerAzureOIDCSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "google_oidc_spec_type", "oidc_v10_spec_type", "okta_oidc_spec_type" ] }, "google_oidc_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerGoogleOIDCSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_oidc_spec_type", "oidc_v10_spec_type", "okta_oidc_spec_type" ] }, "oidc_v10_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerOIDCV10SpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_oidc_spec_type", "google_oidc_spec_type", "okta_oidc_spec_type" ] }, "okta_oidc_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerOKTAOIDCSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_oidc_spec_type", "google_oidc_spec_type", "oidc_v10_spec_type" ] }, "provider_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CustomCreateSpecType is the spec to create OIDC provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerCustomCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerDeleteRequest": { "type": "object", "description": "DeleteRequest is the request payload for deleting an OIDC provider/SSO configuration.", "title": "Delete Request", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.oidc_provider.DeleteRequest", "properties": { "name": { "type": "string", "description": "Name of OIDC provider object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Supports only system namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "DeleteRequest is the request payload for deleting an OIDC provider/SSO configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerErrorCode": { "type": "string", "description": "ErrorCode is used to know the outcome of the specific CRUD operation for OIDC provider.", "title": "error code", "enum": [ "EUNKNOWN", "EOK", "EEXISTS", "EFAILED", "ENOTFOUND" ], "default": "EUNKNOWN", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.oidc_provider.ErrorCode", "x-f5xc-description-short": "ErrorCode is used to know the outcome of the specific CRUD operation for OIDC provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EUNKNOWN\"", "example_yaml": "EUNKNOWN\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerGetResponse": { "type": "object", "description": "GetResponse is the response format for fetching OIDC provider information.", "title": "Get Response", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.oidc_provider.GetResponse", "properties": { "object": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerObject" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GetResponse is the response format for fetching OIDC provider information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerGlobalSpecType": { "type": "object", "description": "GlobalSpecType has specification field and values about the OIDC provider.", "title": "Global Spec Type", "x-displayname": "Global Specification Type.", "x-ves-oneof-field-oidcproviderspec": "[\"azure_oidc_spec_type\",\"google_oidc_spec_type\",\"oidc_v10_spec_type\",\"okta_oidc_spec_type\"]", "x-ves-proto-message": "ves.io.schema.oidc_provider.GlobalSpecType", "properties": { "azure_oidc_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerAzureOIDCSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "google_oidc_spec_type", "oidc_v10_spec_type", "okta_oidc_spec_type" ] }, "google_oidc_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerGoogleOIDCSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_oidc_spec_type", "oidc_v10_spec_type", "okta_oidc_spec_type" ] }, "oidc_v10_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerOIDCV10SpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_oidc_spec_type", "google_oidc_spec_type", "okta_oidc_spec_type" ] }, "okta_oidc_spec_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerOKTAOIDCSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_oidc_spec_type", "google_oidc_spec_type", "oidc_v10_spec_type" ] }, "provider_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "redirect_uri": { "type": "string", "description": "Redirect URI.", "title": "RedirectUri", "x-displayname": "Redirect URI.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scim_spec": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerScimSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GlobalSpecType has specification field and values about the OIDC provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerGlobalSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerListResponse": { "type": "object", "description": "Format of the response body to list OIDC providers configured for the tenant under a namespace.", "title": "ListResponse", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.oidc_provider.ListResponse", "properties": { "items": { "type": "array", "description": "List of OIDC providers.", "title": "items", "items": { "$ref": "#/components/schemas/schemaoidc_providerListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Format of the response body to list OIDC providers configured for the tenant under a namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerListResponseItem": { "type": "object", "description": "Shape of the OIDC provider object in a list request's response body.", "title": "List response item", "x-displayname": "List Response Item.", "x-ves-proto-message": "ves.io.schema.oidc_provider.ListResponseItem", "properties": { "create_timestamp": { "type": "string", "description": "Create timestamp of the OIDC provider object.", "title": "create timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "Create timestamp of the OIDC provider object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of OIDC provider.", "title": "name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of OIDC provider object.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "provider_type": { "allOf": [ { "$ref": "#/components/schemas/oidc_providerProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uid": { "type": "string", "description": "UID of OIDC provider object.", "title": "uid", "x-displayname": "UID", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Shape of the OIDC provider object in a list request's response body.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerObject": { "type": "object", "description": "OIDC Provider object.", "title": "OIDC provider", "x-displayname": "OIDC Provider.", "x-ves-proto-message": "ves.io.schema.oidc_provider.Object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectMetaType__ves_io_schema_api_credential" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaoidc_providerSpecType": { "type": "object", "description": "Shape of the OIDC provider specification.", "title": "Specification for OIDC provider", "x-displayname": "Specification.", "x-ves-proto-message": "ves.io.schema.oidc_provider.SpecType", "properties": { "gc_spec": { "allOf": [ { "$ref": "#/components/schemas/schemaoidc_providerGlobalSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the OIDC provider specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaoidc_providerSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "infraprotect_informationPolicer": { "type": "object", "description": "Policer config for bandwidth restrictions.", "title": "Policer Config", "x-displayname": "Policer Config.", "x-ves-proto-message": "ves.io.schema.infraprotect_information.Policer", "properties": { "bandwidth_max_mb": { "type": "integer", "description": "Bandwidth max allowed for a customer defined by contract.", "title": "Bandwidth Max", "format": "int64", "x-displayname": "Bandwidth Max in MB.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "9999" }, "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "9999" }, "x-f5xc-description-short": "Bandwidth max allowed for a customer defined by contract.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 9999, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Policer config for bandwidth restrictions.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotect_informationPolicer", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "rate_limiting", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaSyncMode": { "type": "string", "description": "Sync mode is to specify where the user details are being synced from.\n\n- SELF: Self\nSystem managed user.\n- SCIM: SCIM\nSCIM synced user. Full user life cycle is managed by the SCIM provider.", "title": "Sync Mode", "enum": [ "SELF", "SCIM" ], "default": "SELF", "x-displayname": "Sync Mode", "x-ves-proto-enum": "ves.io.schema.SyncMode", "x-f5xc-description-short": "Sync mode is to specify where the user details are being synced from. - SELF: Self System managed user. - SCIM: SCIM SCIM synced user.", "x-f5xc-description-medium": "Sync mode is to specify where the user details are being synced from. - SELF: Self System managed user. - SCIM: SCIM SCIM synced user. Full user life cycle is managed by the SCIM provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSyncMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SELF\"", "example_yaml": "SELF\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaTaxExemptionType": { "type": "string", "description": "TaxExemptionType holds possible tax exemption option.\n\nUNKNOWN indicates the field not being set\nTAX_REGULAR indicates customers that are required to pay taxes\nTAX_EXEMPT indicates customers exempt from paying taxes - their status needs to be verified once signup is completed.\nTAX_EXEMPT indicates customers exempt from paying taxes - their status has been verified and the customer is not being taxed by us.\nTAX_EXEMPT_VERIFICATION_FAILED indicates customers that the tax exempt verification process failed - they can contact F5XC to GET more details\nTAX_EXEMPT_VERIFICATION_PENDING indicates customers that the tax exempt verification process is ongoing.", "title": "TaxExemptionType", "enum": [ "TAX_UNKNOWN", "TAX_REGULAR", "TAX_EXEMPT_UNVERIFIED", "TAX_EXEMPT_VERIFIED", "TAX_EXEMPT_VERIFICATION_FAILED", "TAX_EXEMPT_VERIFICATION_PENDING" ], "default": "TAX_UNKNOWN", "x-displayname": "Tax Exemption.", "x-ves-proto-enum": "ves.io.schema.TaxExemptionType", "x-f5xc-description-short": "TaxExemptionType holds possible tax exemption option.", "x-f5xc-description-medium": "TaxExemptionType holds possible tax exemption option. UNKNOWN indicates the field not being set TAX_REGULAR indicates customers that are required to pay taxes TAX_EXEMPT indicates customers exempt from paying taxes - their status needs to be verified once signup is completed. TAX_EXEMPT...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTaxExemptionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TAX_UNKNOWN\"", "example_yaml": "TAX_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaTenantType": { "type": "string", "description": "TenantType is the type of the customer\n\nUNKNOWN indicates the field not being set\nFREEMIUM are customer that don't have their domain\nENTERPRiISE customer have their domain.", "title": "TenantType", "enum": [ "UNKNOWN", "FREEMIUM", "ENTERPRISE" ], "default": "UNKNOWN", "x-displayname": "Tenant type.", "x-ves-proto-enum": "ves.io.schema.TenantType", "x-f5xc-description-short": "TenantType is the type of the customer UNKNOWN indicates the field not being set FREEMIUM are customer that don't have their domain ENTERPRiISE...", "x-f5xc-description-medium": "TenantType is the type of the customer UNKNOWN indicates the field not being set FREEMIUM are customer that don't have their domain ENTERPRiISE customer have their domain.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTenantType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNKNOWN\"", "example_yaml": "UNKNOWN\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemainfraprotect_informationGlobalSpecType": { "type": "object", "description": "Organisation information.", "title": "Information", "x-displayname": "Information.", "x-ves-oneof-field-as_path_choice": "[\"as_path_choice_full\",\"as_path_choice_none\",\"as_path_choice_origin\"]", "x-ves-oneof-field-default_tunnel_bgp_secret_choice": "[\"default_tunnel_bgp_secret\",\"default_tunnel_bgp_secret_none\"]", "x-ves-oneof-field-proxy_network_export_choice": "[\"proxy_network_export_disabled\",\"proxy_network_export_enabled\"]", "x-ves-oneof-field-route_advertisement_management_choice": "[\"route_advertisement_mgmt_not_specified\",\"route_advertisement_mgmt_not_using_f5xc\",\"route_advertisement_mgmt_using_f5xc\"]", "x-ves-oneof-field-routed_network_export_choice": "[\"routed_network_export_disabled\",\"routed_network_export_enabled\"]", "x-ves-oneof-field-tunnel_f5_ip_usage_choice": "[\"reuse_ips\",\"use_dedicated_ips\"]", "x-ves-proto-message": "ves.io.schema.infraprotect_information.GlobalSpecType", "properties": { "arbor_cid": { "type": "string", "description": "L3/L4 provider customer ID.", "title": "L3/L4 CID", "x-displayname": "L3/L4 CID", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "as_path_choice_full": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "as_path_choice_none", "as_path_choice_origin" ] }, "as_path_choice_none": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "as_path_choice_full", "as_path_choice_origin" ] }, "as_path_choice_origin": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "as_path_choice_full", "as_path_choice_none" ] }, "asn": { "type": "integer", "description": "AS Number", "title": "asn", "format": "int32", "x-displayname": "ASN", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_tunnel_bgp_secret": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_tunnel_bgp_secret_none" ] }, "default_tunnel_bgp_secret_none": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_tunnel_bgp_secret" ] }, "policer": { "allOf": [ { "$ref": "#/components/schemas/infraprotect_informationPolicer" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefixes": { "type": "array", "description": "List of tenant 'super' prefixes noted in CIDR.", "title": "prefixes", "items": { "type": "string" }, "x-displayname": "Super prefixes.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "List of tenant 'super' prefixes noted in CIDR.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "primary_network_name": { "type": "string", "description": "Name of the default customer network.", "title": "Primary Network Name", "x-displayname": "Primary network name.", "x-ves-example": "Defensenet_local.", "x-f5xc-example": "defensenet_local", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "proxy_network_export_disabled": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "proxy_network_export_enabled" ] }, "proxy_network_export_enabled": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "proxy_network_export_disabled" ] }, "reuse_ips": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_dedicated_ips" ] }, "route_advertisement_mgmt_not_specified": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "route_advertisement_mgmt_not_using_f5xc", "route_advertisement_mgmt_using_f5xc" ] }, "route_advertisement_mgmt_not_using_f5xc": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for route advertisement mgmt not using f5xc.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "route_advertisement_mgmt_not_specified", "route_advertisement_mgmt_using_f5xc" ] }, "route_advertisement_mgmt_using_f5xc": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for route advertisement mgmt using f5xc.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "route_advertisement_mgmt_not_specified", "route_advertisement_mgmt_not_using_f5xc" ] }, "routed_network_export_disabled": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "routed_network_export_enabled" ] }, "routed_network_export_enabled": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "routed_network_export_disabled" ] }, "use_dedicated_ips": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "reuse_ips" ] }, "uuid": { "type": "string", "description": "Organisation UUID.", "title": "uuid", "x-displayname": "UUID", "x-ves-example": "Value", "x-f5xc-example": "value", "format": "uuid", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "format": "uuid", "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "formatDescription": "RFC 4122 UUID format (e.g., 550e8400-e29b-41d4-a716-446655440000)", "validation": { "rfc": "RFC 4122" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemainfraprotect_informationGlobalSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemasignupErrorCode": { "type": "string", "description": "ErrorCode is used to know the specific reason for signup registration failures\n\n- ETOKEN_OK: token related codes go here\n- EUSER_OK: user related codes go here\n- ECONTACT_VALIDATE_OK: contact validation codes go here\nValidation is ok\n- ECONTACT_EMPTY_COUNTRY: Empty country during validation of a contact\n- ECONTACT_EMPTY_ZIP_CODE: Empty zip code during validation of a contact\n- ECONTACT_UNKNOWN_COUNTRY: A given country is not present in the configured list of country-zipCodeRegexp\n- ECONTACT_INVALID_ZIP: A given zip doesn't match a configured regexp for a given country\n- EOK: EOK indicates no error\n- ENO_STATES: ENO_STATES indicates no states in a country\n- ENO_CITIES: ENO_CITIES indicates no cities in country/state.", "title": "error code", "enum": [ "EUNKNOWN", "ETOKEN_OK", "ETOKEN_FAILED", "ETOKEN_NOTFOUND", "ETOKEN_USED", "ETOKEN_EXPIRED", "EUSER_OK", "EUSER_EXISTS", "EUSER_FAILED", "ECONTACT_VALIDATE_OK", "ECONTACT_EMPTY_COUNTRY", "ECONTACT_EMPTY_ZIP_CODE", "ECONTACT_UNKNOWN_COUNTRY", "ECONTACT_INVALID_ZIP", "EOK", "ENO_STATES", "ENO_CITIES" ], "default": "EUNKNOWN", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.signup.ErrorCode", "x-f5xc-description-short": "ErrorCode is used to know the specific reason for signup registration failures - ETOKEN_OK: token related codes go here - EUSER_OK: user related...", "x-f5xc-description-medium": "ErrorCode is used to know the specific reason for signup registration failures - ETOKEN_OK: token related codes go here - EUSER_OK: user related codes go here - ECONTACT_VALIDATE_OK: contact validation codes go here Validation is ok - ECONTACT_EMPTY_COUNTRY: Empty country during validation of a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasignupErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EUNKNOWN\"", "example_yaml": "EUNKNOWN\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemasignupGlobalSpecType": { "type": "object", "description": "Desired state of Signup.", "title": "Signup specification", "x-displayname": "Signup", "x-ves-proto-message": "ves.io.schema.signup.GlobalSpecType", "properties": { "billing_address": { "allOf": [ { "$ref": "#/components/schemas/schemacontactGlobalSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "billing_provider_account_id": { "type": "string", "description": "ID of the billing provider account created to verify the billing info provided with this object.\nThe ID is then used to ensure no more duplicate billing account is created.", "title": "billing_provider_account_id", "x-displayname": "Billing provider account ID.", "x-f5xc-description-short": "ID of the billing provider account created to verify the billing info provided with this object.", "x-f5xc-description-medium": "ID of the billing provider account created to verify the billing info provided with this object. The ID is then used to ensure no more duplicate billing account is created.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "company": { "allOf": [ { "$ref": "#/components/schemas/schemauserGlobalSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "company_contact": { "allOf": [ { "$ref": "#/components/schemas/schemacontactGlobalSpecType" } ], "x-f5xc-description-short": "Configuration parameter for company contact.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "company_name": { "type": "string", "description": "Company name (enterprise only)", "title": "company name", "x-displayname": "Company Name.", "x-ves-example": "Example Corp.", "x-f5xc-example": "Example Corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "contact_number": { "type": "string", "description": "Phone contact number\nobsolete.", "title": "contact_number", "x-displayname": "Contact Number.", "x-ves-example": "+11234567890.", "x-f5xc-example": "+11234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "crm_details": { "allOf": [ { "$ref": "#/components/schemas/schemaCRMInfo" } ], "x-f5xc-description-short": "Configuration parameter for crm details.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "currency": { "type": "string", "description": "Preferred currency on the tenant level - individual billing accounts may\noverride this.", "title": "currency", "x-displayname": "Currency", "x-ves-example": "USD", "x-f5xc-example": "USD", "x-f5xc-description-short": "Preferred currency on the tenant level - individual billing accounts may override this.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "customer": { "allOf": [ { "$ref": "#/components/schemas/schemauserGlobalSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "customer_contact": { "allOf": [ { "$ref": "#/components/schemas/schemacontactGlobalSpecType" } ], "x-f5xc-description-short": "Configuration parameter for customer contact.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Domain the customer chose to use - enterprise customers only.", "title": "domain", "x-displayname": "Domain", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Domain the customer chose to use - enterprise customers only.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "email": { "type": "string", "description": "Email of the customer (ideally someone who's responsible for the company\naccount)\nobsolete.", "title": "email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Email of the customer (ideally someone who's responsible for the company account) obsolete.", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_name": { "type": "string", "description": "First name of the customer\nobsolete.", "title": "first_name", "x-displayname": "First Name.", "x-ves-example": "John", "x-f5xc-example": "John", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "infraprotect_info": { "allOf": [ { "$ref": "#/components/schemas/schemainfraprotect_informationGlobalSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "Last name of the customer (the superuser)\nobsolete.", "title": "last_name", "x-displayname": "Last Name", "x-ves-example": "Doe", "x-f5xc-example": "Doe", "x-f5xc-description-short": "Last name of the customer (the superuser) obsolete.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locale": { "type": "string", "description": "Locale of this sign up.", "title": "locale", "x-displayname": "Locale", "x-ves-example": "En-us", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "en-us", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "payment_provider_token": { "type": "string", "description": "Payment provider token (for credit card details)", "title": "payment_provider_token", "x-displayname": "Payment Provider Token.", "x-ves-example": "Tok_1234567890.", "x-f5xc-example": "example", "x-f5xc-description-short": "Payment provider token (for credit card details).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "support_plan_name": { "type": "string", "description": "What sort of support plan the customer will be on.", "title": "support_plan_name", "x-displayname": "Support Plan Name.", "x-ves-example": "Xxxx-yyyy-zzzz-1111.", "x-f5xc-example": "xxxx-yyyy-zzzz-1111", "x-f5xc-description-short": "What sort of support plan the customer will be on.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tax_exempt": { "allOf": [ { "$ref": "#/components/schemas/schemaTaxExemptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "token": { "type": "string", "description": "Token of the user requesting for.\nValid tokens are internally generated in the system and shared with respective customers.\nOnboarding of new customers will proceed only when a valid token along with the email is provided during the signup process.", "title": "token of the user", "x-displayname": "Token", "x-ves-example": "Tok_1234567890.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Token of the user requesting for. Valid tokens are internally generated in the system and shared with respective customers.", "x-f5xc-description-medium": "Token of the user requesting for. Valid tokens are internally generated in the system and shared with respective customers. Onboarding of new customers will proceed only when a valid token along with the email is provided during the signup process.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "security", "maxLength": 1024, "minLength": 20, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "tos_accepted": { "type": "string", "description": "T&c accepted date as millis from 01/01/1970 UTC.", "title": "tos_accepted", "format": "int64", "x-displayname": "TOS Accepted.", "x-ves-example": "1569926163000.", "x-f5xc-example": "1569926163000", "x-f5xc-description-short": "T&c accepted date as millis from 01/01/1970 UTC.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted_at": { "type": "string", "description": "Tos accepted timestamp.", "title": "tos_accepted_at", "format": "date-time", "x-displayname": "TosAcceptedAt.", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_version": { "type": "string", "description": "Indicates the version of ToS customer approved during signup. Any new version will require the customer to RE-approve during login.", "title": "version of terms of services the customer accepted", "x-displayname": "TOS version.", "x-ves-example": "V1.2", "x-f5xc-example": "v1.2", "x-f5xc-description-short": "Indicates the version of ToS customer approved during signup. Any new version will require the customer to RE-approve during login.", "x-f5xc-description-medium": "Indicates the version of ToS customer approved during signup. Any new version will require the customer to RE-approve during login.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/schemaTenantType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "usage_plan_name": { "type": "string", "description": "What sort of usage plan the customer will be on.", "title": "usage_plan_name", "x-displayname": "Usage Plan Name.", "x-ves-example": "Xxxx-yyyy-zzzz-1111.", "x-f5xc-example": "xxxx-yyyy-zzzz-1111", "x-f5xc-description-short": "What sort of usage plan the customer will be on.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasignupGlobalSpecType", "required_fields": [ "locale", "token" ], "mutually_exclusive_groups": [], "example_json": "{\n \"locale\": \"en-us\",\n \"token\": \"example\"\n}", "example_yaml": "locale: en-us\ntoken: example" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemauserGlobalSpecType": { "type": "object", "title": "GlobalSpecType", "x-displayname": "Global Specification.", "x-ves-proto-message": "ves.io.schema.user.GlobalSpecType", "properties": { "contacts": { "type": "array", "description": "Contact information for user.", "title": "contacts", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Contact", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_owner": { "type": "boolean", "description": "Domain owner is the first user who registered or signed up the associated Tenant.\nUser created via signup flow will have this value set to true.\nFew restrictions apply to this user w.r.t role update and deletion.", "title": "Domain Owner", "format": "boolean", "x-displayname": "Domain Owner.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Domain owner is the first user who registered or signed up the associated Tenant.", "x-f5xc-description-medium": "Domain owner is the first user who registered or signed up the associated Tenant. User created via signup flow will have this value set to true. Few restrictions apply to this user w.r.t role update and deletion.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "email": { "type": "string", "description": "User's email.", "title": "email", "x-displayname": "Email", "x-ves-example": "Value", "x-f5xc-example": "value", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_name": { "type": "string", "description": "User's first name.", "title": "first_name", "x-displayname": "First Name.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "groups": { "type": "array", "description": "Reference to the user groups.", "title": "Groups", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Groups", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "idm_type": { "allOf": [ { "$ref": "#/components/schemas/userIdmType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_login_timestamp": { "type": "string", "description": "Last successful login timestamp of the user.", "title": "last_login_timestamp", "format": "date-time", "x-displayname": "Last Login Timestamp.", "x-f5xc-description-short": "Last successful login timestamp of the user.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "User's last name.", "title": "last_name", "x-displayname": "Last Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locale": { "type": "string", "description": "Locale of the user (defaults to English)", "title": "locale", "x-displayname": "Locale", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Locale of the user (defaults to English).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/userFSMState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaSyncMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted": { "type": "string", "description": "Tos accepted version, this field is deprecated refer the fields `tos_accepted_at` and `tos_version` instead.", "title": "tos_accepted", "x-displayname": "TOS Accepted.", "x-ves-example": "1.0", "x-f5xc-example": "1.0", "x-f5xc-description-short": "Tos accepted version, this field is deprecated refer the fields and instead.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted_at": { "type": "string", "description": "Tos accepted timestamp.", "title": "tos_accepted_at", "format": "date-time", "x-displayname": "TOS Accepted Timestamp.", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_version": { "type": "string", "description": "Tos accepted version.", "title": "tos_version", "x-displayname": "TOS version.", "x-ves-example": "V1.0", "x-f5xc-example": "v1.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/userUserType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemauserGlobalSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "signupCityItem": { "type": "object", "description": "CityItem contains a single element of city list response.", "title": "City item", "x-displayname": "City item", "x-ves-proto-message": "ves.io.schema.signup.CityItem", "properties": { "additional_info": { "type": "object", "description": "Any additional information related to the city.", "title": "additional information", "x-displayname": "Additional information.", "x-ves-example": "[alternative_name:Madras]", "x-f5xc-example": "[alternative_name:Madras]", "x-f5xc-description-short": "Any additional information related to the city.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "city_name": { "type": "string", "description": "Name of the city in the human readable form (can be used as a description)", "title": "city name", "x-displayname": "City", "x-ves-example": "Chennai", "x-f5xc-example": "Chennai", "x-f5xc-description-short": "Name of the city in the human readable form (can be used as a description).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CityItem contains a single element of city list response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupCityItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupCountryItem": { "type": "object", "description": "CountryItem contains a single element of country list response.", "title": "Country item", "x-displayname": "Country item.", "x-ves-proto-message": "ves.io.schema.signup.CountryItem", "properties": { "additional_info": { "type": "object", "description": "Any additional information related to the country.", "title": "additional information", "x-displayname": "Additional information.", "x-ves-example": "[zip_code_validation:^.{2,}$]", "x-f5xc-example": "[zip_code_validation:^.{2,}$]", "x-f5xc-description-short": "Any additional information related to the country.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country_code": { "type": "string", "description": "X-displayName : \"Country code\"\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`", "title": "country code", "x-ves-example": "US", "x-f5xc-example": "US", "x-f5xc-description-short": "X-displayName : \"Country code\" 2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column.", "x-f5xc-description-medium": "X-displayName : \"Country code\" 2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country_name": { "type": "string", "description": "Name of the country in the human readable form (can be used as a description)", "title": "country name", "x-displayname": "Country name.", "x-ves-example": "USA", "x-f5xc-example": "USA", "x-f5xc-description-short": "Name of the country in the human readable form (can be used as a description).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CountryItem contains a single element of country list response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupCountryItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupGetResponse": { "type": "object", "description": "Signup object including its status. Use it when you want to see the progress of the signup flow.", "title": "Get response", "x-displayname": "Signup GET Response.", "x-ves-proto-message": "ves.io.schema.signup.GetResponse", "properties": { "object": { "allOf": [ { "$ref": "#/components/schemas/signupObject" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "Signup object status, including any failures.", "title": "Signup status object", "items": { "$ref": "#/components/schemas/signupStatusObject" }, "x-displayname": "Signup Status Object.", "x-f5xc-example": "active", "x-f5xc-description-short": "Signup object status, including any failures.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Signup object including its status. Use it when you want to see the progress of the signup flow.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupListCitiesResponse": { "type": "object", "description": "ListCitiesResponse contains a list of cities (for a country) supported by the platform.", "title": "City list response", "x-displayname": "City response.", "x-ves-proto-message": "ves.io.schema.signup.ListCitiesResponse", "properties": { "cities": { "type": "array", "description": "List of all cities in.", "title": "available cities in the country", "items": { "$ref": "#/components/schemas/signupCityItem" }, "x-displayname": "Cities", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_code": { "allOf": [ { "$ref": "#/components/schemas/schemasignupErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ListCitiesResponse contains a list of cities (for a country) supported by the platform.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupListCitiesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupListCountriesResponse": { "type": "object", "description": "ListCountriesResponse contains a list of countries supported by the platform.", "title": "Country list response", "x-displayname": "Country response.", "x-ves-proto-message": "ves.io.schema.signup.ListCountriesResponse", "properties": { "countries": { "type": "array", "description": "List of all countries supported by the platform.", "title": "available countries", "items": { "$ref": "#/components/schemas/signupCountryItem" }, "x-displayname": "Countries", "x-f5xc-description-short": "List of all countries supported by the platform.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ListCountriesResponse contains a list of countries supported by the platform.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupListCountriesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupListStatesResponse": { "type": "object", "description": "ListStatesResponse contains a list of states supported by the platform.", "title": "Country list response", "x-displayname": "Country response.", "x-ves-proto-message": "ves.io.schema.signup.ListStatesResponse", "properties": { "error_code": { "allOf": [ { "$ref": "#/components/schemas/schemasignupErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "states": { "type": "array", "description": "List of all states of a country supported by the platform.", "title": "available states in a country", "items": { "$ref": "#/components/schemas/signupStateItem" }, "x-displayname": "States", "x-f5xc-description-short": "List of all states of a country supported by the platform.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ListStatesResponse contains a list of states supported by the platform.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupListStatesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupObject": { "type": "object", "description": "Signup object.", "title": "Signup", "x-displayname": "Signup", "x-ves-proto-message": "ves.io.schema.signup.Object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/signupSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectMetaType__ves_io_schema_api_credential" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupSendPasswordEmailRequest": { "type": "object", "description": "SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer.", "title": "Request to resend password email", "x-displayname": "Signup Resend Password Email Request.", "x-ves-proto-message": "ves.io.schema.signup.SendPasswordEmailRequest", "properties": { "cname": { "type": "string", "description": "Domain under which the tenant belongs to.", "title": "cname", "x-displayname": "Domain Name.", "x-ves-example": "F5 Distributed Cloud.", "x-f5xc-example": "F5 Distributed Cloud", "x-f5xc-description-short": "Domain under which the tenant belongs to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "email": { "type": "string", "description": "Email of the user requesting for.", "title": "email of the user", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer.", "x-f5xc-description-medium": "SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupSendPasswordEmailRequest", "required_fields": [ "email" ], "mutually_exclusive_groups": [], "example_json": "{\n \"email\": \"dana@example.com\"\n}", "example_yaml": "email: dana@example.com" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupSendPasswordEmailResponse": { "type": "object", "description": "SendPasswordEmailResponse is an empty response after an email had been sent..", "title": "Send password email response", "x-displayname": "Send Password Email Response.", "x-ves-proto-message": "ves.io.schema.signup.SendPasswordEmailResponse", "x-f5xc-description-short": "SendPasswordEmailResponse is an empty response after an email had been sent..", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupSendPasswordEmailResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupSpecType": { "type": "object", "description": "Shape of the signup specification.", "title": "Signup specification", "x-displayname": "Signup object specification.", "x-ves-proto-message": "ves.io.schema.signup.SpecType", "properties": { "gc_spec": { "allOf": [ { "$ref": "#/components/schemas/schemasignupGlobalSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupStateItem": { "type": "object", "description": "CountryItem contains a single element of country list response.", "title": "Country item", "x-displayname": "Country item.", "x-ves-proto-message": "ves.io.schema.signup.StateItem", "properties": { "additional_info": { "type": "object", "description": "Any additional information related to the state.", "title": "additional information", "x-displayname": "Additional information.", "x-ves-example": "[zip_code_validation:^.{2,}$]", "x-f5xc-example": "[zip_code_validation:^.{2,}$]", "x-f5xc-description-short": "Any additional information related to the state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state_code": { "type": "string", "description": "2 characters state code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column `code` (excluding the leading country code)", "title": "state code", "x-displayname": "State code.", "x-ves-example": "TN", "x-f5xc-example": "TN", "x-f5xc-description-short": "2 characters state code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column (excluding the leading country code).", "x-f5xc-description-medium": "2 characters state code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column (excluding the leading country code).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state_name": { "type": "string", "description": "Name of the state in the human readable form (can be used as a description)", "title": "state name", "x-displayname": "State name.", "x-ves-example": "Tamil Nadu.", "x-f5xc-example": "Tamil Nadu", "x-f5xc-description-short": "Name of the state in the human readable form (can be used as a description).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CountryItem contains a single element of country list response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupStateItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupStatusObject": { "type": "object", "description": "Most recently observed status of signup object.", "title": "Signup status", "x-displayname": "Signup object status.", "x-ves-proto-message": "ves.io.schema.signup.StatusObject", "properties": { "billingAccount": { "type": "array", "title": "Billing account reference", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "description": "Number of items or occurrences", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "array", "title": "Tenant reference", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "description": "Tenant identifier for multi-tenancy", "x-f5xc-example": "customer-123", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "maxLength": 12, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "user": { "type": "array", "title": "User reference", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "description": "Configuration parameter for user", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of signup object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupValidateContactRequest": { "type": "object", "description": "Validate contacts request.", "title": "Request to validate contact", "x-displayname": "Validate contact request.", "x-ves-proto-message": "ves.io.schema.signup.ValidateContactRequest", "properties": { "name": { "type": "string", "description": "The name of the configuration object to be fetched. Is not used for now.", "title": "name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The name of the configuration object to be fetched. Is not used for now.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace in which the configuration object is present. Is not used for now.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The namespace in which the configuration object is present. Is not used for now.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemacontactGlobalSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupValidateContactRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupValidateContactResponse": { "type": "object", "description": "ValidateRegistrationResponse is the response that indicates if the contact is valid or not.\nIf the contact is not valid, a corresponding error code is returned.\nA list of supported validation is provided under Validate rpc call documentation.", "title": "Response to validate contact", "x-displayname": "Validate contact response.", "x-ves-proto-message": "ves.io.schema.signup.ValidateContactResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemasignupErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "is_valid": { "type": "boolean", "description": "Flag indicates if the contact is valid.", "title": "Is a valid contact", "format": "boolean", "x-displayname": "Is Contact Valid.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validation_errors": { "type": "array", "description": "X-displayName : \"Validation errors\"\ncollection of validation errors.", "title": "validation errors", "items": { "$ref": "#/components/schemas/signupValidationErrorField" }, "x-f5xc-description-short": "X-displayName : \"Validation errors\" collection of validation errors.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ValidateRegistrationResponse is the response that indicates if the contact is valid or not.", "x-f5xc-description-medium": "ValidateRegistrationResponse is the response that indicates if the contact is valid or not. If the contact is not valid, a corresponding error code is returned. A list of supported validation is provided under Validate rpc call documentation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupValidateContactResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupValidateRegistrationRequest": { "type": "object", "description": "ValidateRegistrationRequest is the request body parameeters required to validate the registration.", "title": "Request to validate registration", "x-displayname": "Request to Validate Registration.", "x-ves-proto-message": "ves.io.schema.signup.ValidateRegistrationRequest", "properties": { "email": { "type": "string", "description": "Email of the user requesting for.", "title": "email of the user", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "tenant_type": { "allOf": [ { "$ref": "#/components/schemas/schemaTenantType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "token": { "type": "string", "description": "Token of the user requesting for.", "title": "token of the user", "x-displayname": "Token", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "security", "maxLength": 1024, "minLength": 20, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "ValidateRegistrationRequest is the request body parameeters required to validate the registration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupValidateRegistrationRequest", "required_fields": [ "email", "token" ], "mutually_exclusive_groups": [], "example_json": "{\n \"email\": \"dana@example.com\",\n \"token\": \"example\"\n}", "example_yaml": "email: dana@example.com\ntoken: example" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupValidateRegistrationResponse": { "type": "object", "description": "ValidateRegistrationResponse is the response that indicates if the registration is valid or not.\nFor a brand new registration, the valid_registration is set to true that indicates that signup flow can flow through.\nIn case of an existing user, the valid_registration is set to false.", "title": "Response to validate registration", "x-displayname": "Response to Validate Resistration.", "x-ves-proto-message": "ves.io.schema.signup.ValidateRegistrationResponse", "properties": { "err": { "allOf": [ { "$ref": "#/components/schemas/schemasignupErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "valid_registration": { "type": "boolean", "description": "Valid registration flag indicates if the registration is valid.", "title": "Valid registration", "format": "boolean", "x-displayname": "Valid Registration.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Valid registration flag indicates if the registration is valid.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ValidateRegistrationResponse is the response that indicates if the registration is valid or not.", "x-f5xc-description-medium": "ValidateRegistrationResponse is the response that indicates if the registration is valid or not. For a brand new registration, the valid_registration is set to true that indicates that signup flow can flow through. In case of an existing user, the valid_registration is set to false.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupValidateRegistrationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "signupValidationErrorField": { "type": "object", "description": "Contains information on a single validation error.", "title": "Validation error field", "x-displayname": "Validation error field.", "x-ves-proto-message": "ves.io.schema.signup.ValidationErrorField", "properties": { "error_field": { "type": "string", "description": "Path indicates the field that is not valid.", "title": "Error field", "x-displayname": "Error field.", "x-ves-example": "Zip_code", "x-f5xc-example": "zip_code", "x-f5xc-description-short": "Path indicates the field that is not valid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_message": { "type": "string", "description": "More descriptive error message.", "title": "Error message", "x-displayname": "Error message.", "x-ves-example": "Zip code should be a 000-00000 format.", "x-f5xc-example": "Zip code should be a 000-00000 format", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains information on a single validation error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for signupValidationErrorField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "userFSMState": { "type": "string", "description": "States describes possible states for user.\n\n- StateUndefined: StateUndefined\n\nUser state when it was created without any state.\n- StateCreating: StateCreating\n\nUser state during initial creation. It includes registering in IDM, creating user-settings object, etc...\n- StateCreateFailed: StateCreateFailed\n\nUser state when initial creation was failed by some reason and must be retried\nafter issue is solved.\n- StateActive: StateActive\n\nUser state of completely created and available to use user.\n- StateDisabled: StateDisabled\n\nUser is currently disabled, login is not possible for this user, but it may become active again in the future.", "title": "States", "enum": [ "StateUndefined", "StateCreating", "StateCreateFailed", "StateActive", "StateDisabled" ], "default": "StateUndefined", "x-displayname": "States", "x-ves-proto-enum": "ves.io.schema.user.FSMState", "x-f5xc-description-short": "States describes possible states for user. - StateUndefined: StateUndefined User state when it was created without any state. - StateCreating...", "x-f5xc-description-medium": "States describes possible states for user. - StateUndefined: StateUndefined User state when it was created without any state. - StateCreating: StateCreating User state during initial creation. It includes registering in IDM, creating user-settings object, etc... - StateCreateFailed...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userFSMState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"StateUndefined\"", "example_yaml": "StateUndefined\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userIdmType": { "type": "string", "description": "IdmType is to identify who is managing the user.\n\n- SSO: SSO User\nExternally managed Single Sign On based user imported into UAM.\n- VOLTERRA_MANAGED: F5XC Managed Local user\nF5XC managed local user. Full user life cycle is managed by F5 Distributed Cloud UAM and Identity.\n- UNDEFINED: Undefined\nUndefined IDM type.", "title": "IDM Type", "enum": [ "SSO", "VOLTERRA_MANAGED", "UNDEFINED" ], "default": "SSO", "x-displayname": "Identity Management Type.", "x-ves-proto-enum": "ves.io.schema.user.IdmType", "x-f5xc-description-short": "IdmType is to identify who is managing the user. - SSO: SSO User Externally managed Single Sign On based user imported into UAM. ...", "x-f5xc-description-medium": "IdmType is to identify who is managing the user. - SSO: SSO User Externally managed Single Sign On based user imported into UAM. - VOLTERRA_MANAGED: F5XC Managed Local user F5XC managed local user. Full user life cycle is managed by F5 Distributed Cloud UAM and Identity. - UNDEFINED: Undefined...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userIdmType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SSO\"", "example_yaml": "SSO\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userUserType": { "type": "string", "description": "UserType is to identify the type of user\n\n- USER: User\nRegular User\n- SERVICE: Service User\nUser for accessing only APIs/services\n- DEBUG: Debug\nUser which was created by tenant admin for F5 Distributed Cloud-support team.", "title": "UserType", "enum": [ "USER", "SERVICE", "DEBUG" ], "default": "USER", "x-displayname": "User Type", "x-ves-proto-enum": "ves.io.schema.user.UserType", "x-f5xc-description-short": "UserType is to identify the type of user - USER: User Regular User - SERVICE: Service User User for accessing only APIs/services - DEBUG: Debug...", "x-f5xc-description-medium": "UserType is to identify the type of user - USER: User Regular User - SERVICE: Service User User for accessing only APIs/services - DEBUG: Debug User which was created by tenant admin for F5 Distributed Cloud-support team.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userUserType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"USER\"", "example_yaml": "USER\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "scimCreateGroupRequest": { "type": "object", "description": "Request for creating group.", "title": "CreateGroupRequest", "x-displayname": "CreateGroupRequest.", "x-ves-proto-message": "ves.io.schema.scim.CreateGroupRequest", "properties": { "displayName": { "type": "string", "description": "Group display name.", "title": "displayName", "x-displayname": "DisplayName.", "x-ves-example": "Display name.", "x-f5xc-example": "display name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "display", "maxLength": 1024, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalId": { "type": "string", "description": "External ID for the group.", "title": "ExternalId", "x-displayname": "ExternalId.", "x-ves-example": "External ID.", "x-f5xc-example": "external Id", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "Defines ID of the obj.", "title": "Id", "x-displayname": "ID", "x-ves-example": "ID of object in external identity provider.", "x-f5xc-example": "id of object in external identity provider", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "members": { "type": "array", "description": "List of group members reference.", "title": "members", "items": { "$ref": "#/components/schemas/scimGroupMembers" }, "x-displayname": "Members", "x-ves-example": "List group members i.e users.", "x-f5xc-example": "List group members i.e users", "x-f5xc-constraints": { "constraintType": "array", "category": "identity", "minItems": 0, "maxItems": 200, "uniqueItems": true, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "meta": { "allOf": [ { "$ref": "#/components/schemas/scimMeta" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schemas defined as per scim spec.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Scim spec defined schemas.", "x-f5xc-example": "scim spec defined schemas", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimCreateGroupRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimCreateUserRequest": { "type": "object", "description": "CreateUserRequest is the request for creating a user.", "title": "CreateUserRequest", "x-displayname": "CreateUserRequest.", "x-ves-proto-message": "ves.io.schema.scim.CreateUserRequest", "properties": { "active": { "type": "boolean", "description": "Active is boolean representing if user is active or not.", "title": "active", "format": "boolean", "x-displayname": "Active", "x-ves-example": "True/false.", "x-f5xc-example": "true/false", "x-f5xc-description-short": "Active is boolean representing if user is active or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "displayName": { "type": "string", "description": "DisplayName refers to the name to be displayed for the user. Default is name.", "title": "displayName", "x-displayname": "DisplayName.", "x-ves-example": "Rod Rob", "x-f5xc-example": "Rod Rob", "x-f5xc-description-short": "DisplayName refers to the name to be displayed for the user. Default is name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "display", "maxLength": 1024, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "emails": { "type": "array", "description": "Emails can be list of emails to be used by user work, personal etc.", "title": "emails", "items": { "$ref": "#/components/schemas/scimEmail" }, "x-displayname": "Emails", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Emails can be list of emails to be used by user work, personal etc.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalId": { "type": "string", "description": "ExternalId refers to the ID for user represented in the external system like Azure etc.", "title": "externalId", "x-displayname": "ExternalId.", "x-ves-example": "Rod_123", "x-f5xc-example": "rod_123", "x-f5xc-description-short": "ExternalId refers to the ID for user represented in the external system like Azure etc.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "groups": { "type": "array", "description": "Groups to which user belongs to.", "title": "groups", "items": { "$ref": "#/components/schemas/scimUserGroup" }, "x-displayname": "Groups", "x-ves-example": "Groupid", "x-f5xc-example": "groupid", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "meta": { "allOf": [ { "$ref": "#/components/schemas/scimMeta" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "allOf": [ { "$ref": "#/components/schemas/scimName" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "roles": { "type": "array", "description": "Roles defined for the user.", "title": "roles", "items": { "type": "string" }, "x-displayname": "Roles", "x-ves-example": "Roles", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "roles", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schemas represent the schema from scim spec to be used for creating the user.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Urn:ietf:params:scim:schemas:core:2.0:User.", "x-f5xc-example": "urn:ietf:params:scim:schemas:core:2.0:User", "x-f5xc-description-short": "Schemas represent the schema from scim spec to be used for creating the user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "userName": { "type": "string", "description": "UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.", "title": "userName", "x-displayname": "UserName", "x-ves-example": "Rod_123", "x-f5xc-example": "rod_123", "x-f5xc-description-short": "UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.", "x-f5xc-description-medium": "UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "userType": { "allOf": [ { "$ref": "#/components/schemas/userUserType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CreateUserRequest is the request for creating a user.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimCreateUserRequest", "required_fields": [ "roles" ], "mutually_exclusive_groups": [], "example_json": "{\n \"roles\": [\n \"value\"\n ]\n}", "example_yaml": "roles:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimEmail": { "type": "object", "description": "Email for user can be primary or secondary.", "title": "Email", "x-displayname": "Email", "x-ves-proto-message": "ves.io.schema.scim.Email", "properties": { "primary": { "type": "boolean", "description": "Primary boolean describing whether it is primary or not.", "title": "primary", "format": "boolean", "x-displayname": "Primary", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Primary boolean describing whether it is primary or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Type of email describing whether it is work or personal.", "title": "type", "x-displayname": "Type", "x-ves-example": "Work", "x-f5xc-example": "work", "x-f5xc-description-short": "Type of email describing whether it is work or personal.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Value.", "title": "value", "x-displayname": "Value", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Email for user can be primary or secondary.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimEmail", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimFilter": { "type": "object", "description": "Filter.", "title": "Filter", "x-displayname": "Filter", "x-ves-proto-message": "ves.io.schema.scim.Filter", "properties": { "maxResults": { "type": "string", "description": "Maximum results to be displayed.", "title": "maxResults", "format": "uint64", "x-displayname": "Schemas", "x-ves-example": "5", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "5", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "supported": { "type": "boolean", "description": "Is filtering supported.", "title": "supported", "format": "boolean", "x-displayname": "Supported", "x-ves-example": "True/false.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "true/false", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimFilter", "required_fields": [ "maxResults", "supported" ], "mutually_exclusive_groups": [], "example_json": "{\n \"maxResults\": \"5\",\n \"supported\": false\n}", "example_yaml": "maxResults: '5'\nsupported: false" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimGroup": { "type": "object", "description": "Group.", "title": "Group", "x-displayname": "Group", "x-ves-proto-message": "ves.io.schema.scim.Group", "properties": { "displayName": { "type": "string", "description": "Display name for the group.", "title": "displayName", "x-displayname": "DisplayName.", "x-ves-example": "Group display name.", "x-f5xc-example": "group display name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "display", "maxLength": 1024, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalId": { "type": "string", "description": "External ID for the group.", "title": "ExternalId", "x-displayname": "ExternalId.", "x-ves-example": "External ID.", "x-f5xc-example": "external Id", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "Unique ID for the group.", "title": "id", "x-displayname": "ID", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "members": { "type": "array", "description": "Users with unique ID.", "title": "GroupMembers", "items": { "$ref": "#/components/schemas/scimGroupMembers" }, "x-displayname": "GroupMembers.", "x-ves-example": "Users with unique ID.", "x-f5xc-example": "Users with unique Id", "x-f5xc-constraints": { "constraintType": "array", "category": "identity", "minItems": 0, "maxItems": 200, "uniqueItems": true, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "meta": { "allOf": [ { "$ref": "#/components/schemas/scimMeta" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Display name for the group.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Group name.", "x-f5xc-example": "group name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "schemas": { "type": "array", "description": "Schemas per scim spec.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Schema per scim spec.", "x-f5xc-example": "schema per scim spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimGroup", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimGroupMembers": { "type": "object", "description": "GroupMembers.", "title": "GroupMembers", "x-displayname": "GroupMembers.", "x-ves-proto-message": "ves.io.schema.scim.GroupMembers", "properties": { "ref": { "type": "string", "description": "URL of the users or groups.", "title": "$ref", "x-displayname": "$ref", "x-ves-example": "$ref", "x-f5xc-example": "$ref", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Unique ID of the users or groups.", "title": "value", "x-displayname": "Value", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimGroupMembers", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimListGroupResources": { "type": "object", "description": "List group objects.", "title": "ListGroup;resources", "x-displayname": "ListGroupResources.", "x-ves-proto-message": "ves.io.schema.scim.ListGroupResources", "properties": { "Resources": { "type": "array", "description": "List of available groups.", "title": "groups", "items": { "$ref": "#/components/schemas/scimGroup" }, "x-displayname": "Groups", "x-ves-example": "List of groups.", "x-f5xc-example": "list of groups", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "itemsPerPage": { "type": "string", "description": "ItemsPerPage The number of resources returned in a list response page.", "title": "itemsPerPage", "format": "uint64", "x-displayname": "ItemsPerPage.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "ItemsPerPage The number of resources returned in a list response page.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schema defined as per scim spec.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Scim spec referred schema.", "x-f5xc-example": "scim spec referred schema", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startIndex": { "type": "string", "description": "StartIndex The 1-based index of the first result in the current set of list results.", "title": "startIndex", "format": "uint64", "x-displayname": "StartIndex.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "StartIndex The 1-based index of the first result in the current set of list results.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "totalResults": { "type": "string", "description": "TotalGroup objects available.", "title": "id", "format": "uint64", "x-displayname": "TotalResults.", "x-ves-example": "10 15", "x-f5xc-example": "10 15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimListGroupResources", "required_fields": [ "itemsPerPage", "startIndex" ], "mutually_exclusive_groups": [], "example_json": "{\n \"itemsPerPage\": \"value\",\n \"startIndex\": \"value\"\n}", "example_yaml": "itemsPerPage: value\nstartIndex: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimListUserResponse": { "type": "object", "description": "ListUserResources list all the user objects.", "title": "ListUserResources", "x-displayname": "ListUserResources.", "x-ves-proto-message": "ves.io.schema.scim.ListUserResponse", "properties": { "Resources": { "type": "array", "description": "Resources representing all the user objects.", "title": "Resources", "items": { "$ref": "#/components/schemas/scimUser" }, "x-displayname": "Resources", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Resources representing all the user objects.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemsPerPage": { "type": "string", "description": "ItemsPerPage The number of resources returned in a list response page.", "title": "itemsPerPage", "format": "uint64", "x-displayname": "ItemsPerPage.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "ItemsPerPage The number of resources returned in a list response page.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schemas for listing the user.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "startIndex": { "type": "string", "description": "StartIndex The 1-based index of the first result in the current set of list results.", "title": "startIndex", "format": "uint64", "x-displayname": "StartIndex.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "StartIndex The 1-based index of the first result in the current set of list results.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "totalResults": { "type": "string", "description": "TotalResults for the search criteria.", "title": "totalResults", "format": "uint64", "x-displayname": "TotalResults.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "ListUserResources list all the user objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimListUserResponse", "required_fields": [ "Resources", "itemsPerPage", "schemas", "startIndex", "totalResults" ], "mutually_exclusive_groups": [], "example_json": "{\n \"Resources\": [\n {\n \"externalId\": \"rod_1234\",\n \"groups\": [\n {}\n ],\n \"id\": \"123-456-789012\",\n \"roles\": [\n \"value\"\n ],\n \"schemas\": [\n \"value\"\n ],\n \"userName\": \"rod_1234\"\n }\n ],\n \"itemsPerPage\": \"value\",\n \"schemas\": [\n \"value\"\n ],\n \"startIndex\": \"value\",\n \"totalResults\": \"value\"\n}", "example_yaml": "Resources:\n- externalId: rod_1234\n groups:\n - {}\n id: 123-456-789012\n roles:\n - value\n schemas:\n - value\n userName: rod_1234\nitemsPerPage: value\nschemas:\n- value\nstartIndex: value\ntotalResults: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimMeta": { "type": "object", "description": "X-required\nResource meta information..", "title": "Meta", "x-displayname": "Meta", "x-ves-proto-message": "ves.io.schema.scim.Meta", "properties": { "created": { "type": "string", "description": "Create date.", "title": "created", "x-displayname": "Created", "x-ves-example": "2011-08-08T04:56:22Z.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "2011-08-08T04:56:22Z", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "lastModified": { "type": "string", "description": "Last modification date and time.", "title": "lastModified", "x-displayname": "LastModified.", "x-ves-example": "2011-08-08T08:00:12Z.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "2011-08-08T08:00:12Z", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "location": { "type": "string", "description": "[x-required]\nlocation for resource.", "title": "location", "x-displayname": "Location", "x-ves-example": "/ResourceType/Users.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "/ResourceType/Users", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "resourceType": { "type": "string", "description": "Type of resource.", "title": "resourceType", "x-displayname": "Schemas", "x-ves-example": "User", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "User", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "version": { "type": "string", "description": "Version for resource type.", "title": "version", "x-displayname": "Version", "x-ves-example": "2.0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "2.0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-example": "Meta", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimMeta", "required_fields": [ "created", "lastModified", "location", "resourceType", "version" ], "mutually_exclusive_groups": [], "example_json": "{\n \"created\": \"2011-08-08T04:56:22Z\",\n \"lastModified\": \"2011-08-08T08:00:12Z\",\n \"location\": \"/ResourceType/Users\",\n \"resourceType\": \"User\",\n \"version\": \"2.0\"\n}", "example_yaml": "created: '2011-08-08T04:56:22Z'\nlastModified: '2011-08-08T08:00:12Z'\nlocation: /ResourceType/Users\nresourceType: User\nversion: '2.0'" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimName": { "type": "object", "description": "Name is the name of user.", "title": "Name", "x-displayname": "Name", "x-ves-proto-message": "ves.io.schema.scim.Name", "properties": { "familyName": { "type": "string", "description": "Family name.", "title": "familyName", "x-displayname": "FamilyName.", "x-ves-example": "Downey", "x-f5xc-example": "Downey", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "formatted": { "type": "string", "description": "Formatted name is detailed name of person.", "title": "formatted", "x-displayname": "Formatted", "x-ves-example": "R Downey Jr.", "x-f5xc-example": "R Downey Jr", "x-f5xc-description-short": "Formatted name is detailed name of person.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "givenName": { "type": "string", "description": "Given name of the person.", "title": "givenName", "x-displayname": "GivenName", "x-ves-example": "Robert J Downey Jr.", "x-f5xc-example": "Robert J Downey Jr", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "honorificPrefix": { "type": "string", "description": "Prefix for the name. Mr Ms. Etc.", "title": "honorificPrefix", "x-displayname": "HonorificPrefix.", "x-ves-example": "Mr", "x-f5xc-example": "Mr", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "honorificSuffix": { "type": "string", "description": "Suffix for the name like Jr Sr I II III etc.", "title": "honorificSuffix", "x-displayname": "HonorificSuffix.", "x-ves-example": "IV", "x-f5xc-example": "IV", "x-f5xc-description-short": "Suffix for the name like Jr Sr I II III etc.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "middleName": { "type": "string", "description": "Middle name of the person.", "title": "middleName", "x-displayname": "MiddleName.", "x-ves-example": "K", "x-f5xc-example": "K", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimName", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimPatchGroupRequest": { "type": "object", "description": "PATCH operation to modify group.", "title": "PatchGroupOperation", "x-displayname": "PatchGroupOperation.", "x-ves-proto-message": "ves.io.schema.scim.PatchGroupRequest", "properties": { "Operations": { "type": "array", "description": "Operations to modify or DELETE group.", "title": "Operations", "items": { "$ref": "#/components/schemas/scimPatchOperation" }, "x-displayname": "Operations.", "x-ves-example": "Add, remove, replace, DELETE.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "add, remove, replace, delete", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "id": { "type": "string", "description": "Unique ID for the group.", "title": "id", "x-displayname": "ID", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schemas as per scim spec.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Schemas per scim spec.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "schemas per scim spec", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimPatchGroupRequest", "required_fields": [ "Operations", "id", "schemas" ], "mutually_exclusive_groups": [], "example_json": "{\n \"Operations\": [\n {}\n ],\n \"id\": \"value\",\n \"schemas\": [\n \"value\"\n ]\n}", "example_yaml": "Operations:\n- {}\nid: value\nschemas:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimPatchOperation": { "type": "object", "description": "PatchOperation is the PATCH operation where user can be updated replaced or remove..\nSupported op types are add, remove, replace\nremove is remove a specific entry.", "title": "PatchOperation", "x-displayname": "PATCH Operation.", "x-ves-proto-message": "ves.io.schema.scim.PatchOperation", "properties": { "op": { "type": "string", "description": "Op \"add\", \"replace\", \"remove\", \"DELETE\"", "title": "op", "x-displayname": "Op", "x-ves-example": "\"op\": \"add\"", "x-f5xc-example": "\"\"op\"\"add\"\"", "x-f5xc-description-short": "Op \"add\", \"replace\", \"remove\", \"DELETE\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "description": "Path to the field where the change needs to happen.", "title": "path", "x-displayname": "Path", "x-ves-example": "\"path\": \"name.formatted\"", "x-f5xc-example": "\"\"path\"\"name.formatted\"\"", "x-f5xc-description-short": "Path to the field where the change needs to happen.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "object", "description": "Value to be used for modifying the object. In case of DELETE nothing needs to be specified.", "title": "value", "x-displayname": "Value", "x-ves-example": "\"value\": \"New Formatted Name\"", "x-f5xc-example": "\"\"value\"\"New Formatted Name\"\"", "x-f5xc-description-short": "Value to be used for modifying the object. In case of DELETE nothing needs to be specified.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "PatchOperation is the PATCH operation where user can be updated replaced or remove..", "x-f5xc-description-medium": "PatchOperation is the PATCH operation where user can be updated replaced or remove.. Supported op types are add, remove, replace remove is remove a specific entry.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimPatchOperation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimPatchUserRequest": { "type": "object", "description": "X-example: {\n\"schemas\": [\n\"urn:ietf:params:scim:API:messages:2.0:PatchOp\"\n],\noperation\": [{\n\"op\": \"add\",\n\"path\": \"name.preferredname\",\n\"value\": \"New preferred Name\"\n}]\n},\n\"ID\": \"1234-5678-901234\"\n\n}\nPatchUserRequest patches the user object or deletes it.", "title": "PatchUserRequest", "x-displayname": "PatchUserRequest.", "x-ves-proto-message": "ves.io.schema.scim.PatchUserRequest", "properties": { "Operations": { "type": "array", "description": "\"op\": \"add\",\n\"path\": \"name.preferredname\",\n\"value\": \"new name\"\n}]\n}\"\"\noperations that will modify or DELETE the user object.", "title": "operations", "items": { "$ref": "#/components/schemas/scimPatchOperation" }, "x-displayname": "Operations.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "\"\"operations\"[{", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "\"op\": \"add\", \"path\": \"name.preferredname\", \"value\": \"new name\" }] }\"\" operations that will modify or DELETE the user object.", "x-f5xc-description-medium": "\"op\": \"add\", \"path\": \"name.preferredname\", \"value\": \"new name\" }] }\"\" operations that will modify or DELETE the user object.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the user object that needs patching.", "title": "id", "x-displayname": "ID", "x-ves-example": "\"ID\": \"1234-5678-901234\"", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "\"\"id\"\"1234-5678-901234\"\"", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "ID of the user object that needs patching.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schemas for PATCH.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Urn:ietf:params:scim:API:messages:2.0:PatchOp.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "urn:ietf:params:scim:api:messages:2.0:PatchOp", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimPatchUserRequest", "required_fields": [ "Operations", "id", "schemas" ], "mutually_exclusive_groups": [], "example_json": "{\n \"Operations\": [\n {}\n ],\n \"id\": \"\\\"\\\"id\\\"\\\"1234-5678-901234\\\"\\\"\",\n \"schemas\": [\n \"value\"\n ]\n}", "example_yaml": "Operations:\n- {}\nid: '\"\"id\"\"1234-5678-901234\"\"'\nschemas:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimResource": { "type": "object", "description": "Resource", "title": "Resource", "x-displayname": "Resource", "x-ves-proto-message": "ves.io.schema.scim.Resource", "properties": { "endpoint": { "type": "string", "description": "[\n]\n[x-required]\nendpoint for the resource..", "title": "endpoint", "x-displayname": "EndPoint", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "/Groups", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "[ ] [x-required] endpoint for the resource..", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^https?://[^\\s/$.?#].[^\\s]*$", "format": "uri", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "id": { "type": "string", "description": "[\n]\n[x-required]\nID of the resource.", "title": "Id", "x-displayname": "ID", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Group", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "meta": { "allOf": [ { "$ref": "#/components/schemas/scimResourceMeta" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "[\n]\n[x-required]\nname of the resource.", "title": "name", "x-displayname": "Name", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Group", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "schema": { "type": "string", "description": "[x-example: \"urn:ietf:params:scim:schemas:core:2.0:ResourceType]\n[x-required]\nSchema defined in scim spec..", "title": "schema", "x-displayname": "Schema", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "[\n]\n[x-required]\nschemas defined in scim spec.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "urn:ietf:params:scim:api:messages:2.0:ListResponse", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "[ ] [x-required] schemas defined in scim spec.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimResource", "required_fields": [ "endpoint", "id", "name", "schema", "schemas" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endpoint\": \"/Groups\",\n \"id\": \"Group\",\n \"name\": \"Group\",\n \"schema\": \"value\",\n \"schemas\": [\n \"value\"\n ]\n}", "example_yaml": "endpoint: /Groups\nid: Group\nname: Group\nschema: value\nschemas:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimResourceMeta": { "type": "object", "description": "ResourceMeta.", "title": "ResourceMeta", "x-displayname": "ResourceMeta.", "x-ves-proto-message": "ves.io.schema.scim.ResourceMeta", "properties": { "location": { "type": "string", "description": "Location of resource.", "title": "location", "x-displayname": "Location", "x-ves-example": "/Resurce/User.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "/Resource/User", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "resourceType": { "type": "string", "description": "ResourceType represents resource.", "title": "resourceType", "x-displayname": "ResourceType.", "x-ves-example": "User", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "User", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimResourceMeta", "required_fields": [ "location", "resourceType" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"/Resource/User\",\n \"resourceType\": \"User\"\n}", "example_yaml": "location: /Resource/User\nresourceType: User" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimResourceTypesResponse": { "type": "object", "description": "ResourceTypesResponse.", "title": "ResourceTypesResponse", "x-displayname": "ResourceTypesResponse.", "x-ves-proto-message": "ves.io.schema.scim.ResourceTypesResponse", "properties": { "detail": { "type": "string", "description": "Detail defines the details of the response status.", "title": "detail", "x-displayname": "Status", "x-f5xc-description-short": "Detail defines the details of the response status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resources": { "type": "array", "description": "[\n]\n[x-required]\nResources for the query.", "title": "resources", "items": { "$ref": "#/components/schemas/scimResource" }, "x-displayname": "Resources", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "resources", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "[ ] [x-required] Resources for the query.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "[\n]\n[x-required]\nschemas defined by scim spec..", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "urn:ietf:params:scim:schemas:core:2.0:ResourceType", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "[ ] [x-required] schemas defined by scim spec..", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "status": { "type": "string", "description": "Status defines the status code of the response.", "title": "status", "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "Status defines the status code of the response.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "totalResults": { "type": "string", "description": "[\n]\n[x-required]\nNo of results for the query.", "title": "totalResults", "format": "uint64", "x-displayname": "TotalResults.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "8", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "[ ] [x-required] No of results for the query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimResourceTypesResponse", "required_fields": [ "resources", "schemas", "totalResults" ], "mutually_exclusive_groups": [], "example_json": "{\n \"resources\": [\n {\n \"endpoint\": \"/Groups\",\n \"id\": \"Group\",\n \"name\": \"Group\",\n \"schema\": \"value\",\n \"schemas\": [\n \"value\"\n ]\n }\n ],\n \"schemas\": [\n \"value\"\n ],\n \"totalResults\": \"8\"\n}", "example_yaml": "resources:\n- endpoint: /Groups\n id: Group\n name: Group\n schema: value\n schemas:\n - value\nschemas:\n- value\ntotalResults: '8'" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimServiceProviderConfigResponse": { "type": "object", "description": "ServiceProviderConfigResponse.", "title": "ServiceProviderConfigResponse", "x-displayname": "ServiceProviderConfigResponse.", "x-ves-proto-message": "ves.io.schema.scim.ServiceProviderConfigResponse", "properties": { "authenticationSchemes": { "type": "array", "description": "Supported authenticationSchemes for the resource.", "title": "authenticationSchemes", "items": { "type": "string" }, "x-displayname": "AuthenticationSchemes.", "x-ves-example": "--", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "--", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Supported authenticationSchemes for the resource.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "bulk": { "allOf": [ { "$ref": "#/components/schemas/scimSupport" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "changePassword": { "allOf": [ { "$ref": "#/components/schemas/scimSupport" } ], "x-f5xc-description-short": "Configuration parameter for changePassword.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "documentationUri": { "type": "string", "description": "URI for documentation.", "title": "documentationUri", "x-displayname": "DocumentationUri.", "x-ves-example": "https://example.com./scumentation/URI.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "https://example.com./scumentation/uri", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "etag": { "allOf": [ { "$ref": "#/components/schemas/scimSupport" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filter": { "allOf": [ { "$ref": "#/components/schemas/scimFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "patch": { "allOf": [ { "$ref": "#/components/schemas/scimSupport" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schemas scim spec.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Urn:ietf:params:scim:schemas:core:2.0:ResourceType.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "urn:ietf:params:scim:schemas:core:2.0:ResourceType", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/scimSupport" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimServiceProviderConfigResponse", "required_fields": [ "authenticationSchemes", "documentationUri", "schemas" ], "mutually_exclusive_groups": [], "example_json": "{\n \"authenticationSchemes\": [\n \"value\"\n ],\n \"documentationUri\": \"https://example.com./scumentation/uri\",\n \"schemas\": [\n \"value\"\n ]\n}", "example_yaml": "authenticationSchemes:\n- value\ndocumentationUri: https://example.com./scumentation/uri\nschemas:\n- value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimSupport": { "type": "object", "description": "Support.", "title": "Support", "x-displayname": "Support", "x-ves-proto-message": "ves.io.schema.scim.Support", "properties": { "supported": { "type": "boolean", "description": "Is support supported.", "title": "supported", "format": "boolean", "x-displayname": "Supported", "x-ves-example": "True/false.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "true/false", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimSupport", "required_fields": [ "supported" ], "mutually_exclusive_groups": [], "example_json": "{\n \"supported\": false\n}", "example_yaml": "supported: false" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimUser": { "type": "object", "description": "User object representing the user created.", "title": "User", "x-displayname": "User", "x-ves-proto-message": "ves.io.schema.scim.User", "properties": { "active": { "type": "boolean", "description": "Active specifies if user is active or not.", "title": "active", "format": "boolean", "x-displayname": "Active", "x-ves-example": "True/false.", "x-f5xc-example": "true/false", "x-f5xc-description-short": "Active specifies if user is active or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "displayName": { "type": "string", "description": "DisplayName for the user.", "title": "displayName", "x-displayname": "DisplayName.", "x-ves-example": "Rodney", "x-f5xc-example": "Rodney", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "display", "maxLength": 1024, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "emails": { "type": "array", "description": "Emails for the user whether primary or secondary.", "title": "emails", "items": { "$ref": "#/components/schemas/scimEmail" }, "x-displayname": "Emails", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Emails for the user whether primary or secondary.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalId": { "type": "string", "description": "ExternalId specifies the ID for the user object in external system.", "title": "externalId", "x-displayname": "ExternalId.", "x-ves-example": "Rod_1234", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "rod_1234", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "ExternalId specifies the ID for the user object in external system.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "groups": { "type": "array", "description": "Groups to which user is part of.", "title": "groups", "items": { "$ref": "#/components/schemas/scimUserGroup" }, "x-displayname": "Groups", "x-ves-example": "Group-ID", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "group-id", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "id": { "type": "string", "description": "ID for user object.", "title": "id", "x-displayname": "ID", "x-ves-example": "123-456-789012.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "123-456-789012", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "meta": { "allOf": [ { "$ref": "#/components/schemas/scimMeta" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "allOf": [ { "$ref": "#/components/schemas/scimName" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "nickName": { "type": "string", "description": "NickName for the user.", "title": "nickName", "x-displayname": "NickName", "x-ves-example": "Rod", "x-f5xc-example": "Rod", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "roles": { "type": "array", "description": "Roles defined for the user.", "title": "roles", "items": { "type": "string" }, "x-displayname": "Roles", "x-ves-example": "Roles", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "roles", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "schemas": { "type": "array", "description": "Schemas for user object as per scim spec 2.0.", "title": "schemas", "items": { "type": "string" }, "x-displayname": "Schemas", "x-ves-example": "Urn:ietf:params:scim:schemas:core:2.0:User.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "urn:ietf:params:scim:schemas:core:2.0:User", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Schemas for user object as per scim spec 2.0.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "userName": { "type": "string", "description": "UserName for the user.", "title": "userName", "x-displayname": "UserName", "x-ves-example": "Rod_1234", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "rod_1234", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "userType": { "allOf": [ { "$ref": "#/components/schemas/userUserType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "User object representing the user created.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimUser", "required_fields": [ "externalId", "groups", "id", "roles", "schemas", "userName" ], "mutually_exclusive_groups": [], "example_json": "{\n \"externalId\": \"rod_1234\",\n \"groups\": [\n {}\n ],\n \"id\": \"123-456-789012\",\n \"roles\": [\n \"value\"\n ],\n \"schemas\": [\n \"value\"\n ],\n \"userName\": \"rod_1234\"\n}", "example_yaml": "externalId: rod_1234\ngroups:\n- {}\nid: 123-456-789012\nroles:\n- value\nschemas:\n- value\nuserName: rod_1234" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "scimUserGroup": { "type": "object", "description": "UserGroup.", "title": "UserGroup", "x-displayname": "UserGroup", "x-ves-proto-message": "ves.io.schema.scim.UserGroup", "properties": { "display": { "type": "string", "description": "Display for the user group name.", "title": "display", "x-displayname": "Display", "x-ves-example": "Group-1", "x-f5xc-example": "Group-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the group to which user belongs.", "title": "id", "x-displayname": "ID", "x-ves-example": "1234-2345-123456.", "x-f5xc-example": "1234-2345-123456", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for scimUserGroup", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schematenantEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.tenant.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematenantEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematenantFSMState": { "type": "string", "description": "Tenant states https://gitlab.com/F5 Distributed Cloud/F5 XC/eywa/-/wikis/Tenant-State-Machine.\n\n- StateUndefined: StateUndefined\n\nTenant state when it was created without any state.\n- StateCreating: StateCreating\n\nTenant state of initial bootstrapping tenant, registering tenant in other service and\npre-create default objects for the tenant like default namespaces, default roles etc.\n- StateCreateFailed: StateCreateFailed\n\nTenant state when initial bootstrapping was failed by some reason and must be retried\nafter issue is solved.\n- StateInactive: StateInactive\n\nTenant state when initial creation is completed and we have trigger next stage of tenant\nregistration like creating support account, billing account in third party services.\n- StateActive: StateActive\n\nTenant state of completely registered tenant and available to use.\n- StateSuspended: StateSuspended\n\nTenant state of suspended tenant by some reason like not finished billing payments,\nmanually suspended by administrator, etc.\n- StateDisabled: StateDisabled\n\nTenant state of disabled tenant which are in pre-deletion state.\n- StateConfiguring: StateConfiguring\n\nConfiguring state of the specific tenant, can be set for instance if tenant is setting up billing account, etc..\n- StateConfiguringFailed: StateConfiguringFailed\n\nConfiguring state of the specific tenant, can be set for instance if tenant is setting up billing account, etc..", "title": "States", "enum": [ "StateUndefined", "StateCreating", "StateCreateFailed", "StateInactive", "StateActive", "StateSuspended", "StateDisabled", "StateConfiguring", "StateConfiguringFailed" ], "default": "StateUndefined", "x-displayname": "States", "x-ves-proto-enum": "ves.io.schema.tenant.FSMState", "x-f5xc-description-short": "Tenant states https://gitlab.com/F5 Distributed Cloud/F5 XC/eywa/-/wikis/Tenant-State-Machine. - StateUndefined: StateUndefined Tenant state when...", "x-f5xc-description-medium": "Tenant states https://gitlab.com/F5 Distributed Cloud/F5 XC/eywa/-/wikis/Tenant-State-Machine. - StateUndefined: StateUndefined Tenant state when it was created without any state. - StateCreating: StateCreating Tenant state of initial bootstrapping tenant, registering tenant in other service and...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematenantFSMState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"StateUndefined\"", "example_yaml": "StateUndefined\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantAssignDomainOwnerRequest": { "type": "object", "description": "Domain owner assignment request.", "title": "Domain owner assignment request", "x-displayname": "Domain owner assignment request.", "x-ves-proto-message": "ves.io.schema.tenant.AssignDomainOwnerRequest", "properties": { "email": { "type": "string", "description": "Assign domain owner to user with this email.", "title": "Email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Assign domain owner to user with this email.", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantAssignDomainOwnerRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantCredentialsExpiry": { "type": "object", "description": "CredentialsExpiry is a struct that holds max expiration days setting for the different credentials.", "title": "CredentialsExpiry", "x-displayname": "CredentialsExpiry.", "x-ves-proto-message": "ves.io.schema.tenant.CredentialsExpiry", "properties": { "max_api_certificate_expiry_days": { "type": "integer", "description": "Certificate expiry period as days.", "title": "Certificate expiry period", "format": "int32", "x-displayname": "Certificate expiry period.", "x-ves-example": "90", "x-f5xc-example": "90", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "max_api_token_expiry_days": { "type": "integer", "description": "Token expiry period as days.", "title": "Token expiry period", "format": "int32", "x-displayname": "Token expiry period.", "x-ves-example": "90", "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "max_kube_config_expiry_days": { "type": "integer", "description": "TokeKubeconfign expiry period as days.", "title": "Kubeconfig expiry period", "format": "int32", "x-displayname": "Kubeconfig expiry period.", "x-ves-example": "90", "x-f5xc-example": "90", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CredentialsExpiry is a struct that holds max expiration days setting for the different credentials.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantCredentialsExpiry", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantDeactivateTenantRequest": { "type": "object", "description": "Request to deactivate the tenant.", "title": "DeactivateTenantRequest", "x-displayname": "Deactivate Tenant Request.", "x-ves-proto-message": "ves.io.schema.tenant.DeactivateTenantRequest", "properties": { "feedback": { "type": "string", "description": "Feedback from the customer related to reason of account deactivation.", "title": "Feedback", "x-displayname": "Feedback", "x-ves-example": "Customers feedback.", "x-f5xc-example": "Customers feedback", "x-f5xc-description-short": "Feedback from the customer related to reason of account deactivation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "allOf": [ { "$ref": "#/components/schemas/tenantDeletionReason" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 43, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantDeactivateTenantRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantDeactivateTenantResponse": { "type": "object", "title": "DeactivateTenantResponse", "x-displayname": "Deactivate Tenant Response.", "x-ves-proto-message": "ves.io.schema.tenant.DeactivateTenantResponse", "properties": { "job_id": { "type": "string", "description": "Job ID of the async job that triggered to process the tenant deactivation.", "title": "Job Id", "x-displayname": "Job ID", "x-f5xc-description-short": "Job ID of the async job that triggered to process the tenant deactivation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantDeactivateTenantResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantDeleteTenantRequest": { "type": "object", "description": "Request for marking Tenant for deletion.", "title": "DeleteTenantRequest", "x-displayname": "DeleteTenantRequest.", "x-ves-proto-message": "ves.io.schema.tenant.DeleteTenantRequest", "properties": { "email": { "type": "string", "description": "Email of freemium account which need to be deleted.", "title": "Email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Email of freemium account which need to be deleted.", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "feedback": { "type": "string", "description": "Feedback from the customer related to reason of account deletion.", "title": "Feedback", "x-displayname": "Feedback", "x-ves-example": "Customers feedback.", "x-f5xc-example": "Customers feedback", "x-f5xc-description-short": "Feedback from the customer related to reason of account deletion.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Tenant name marked for deletion.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Tenant-1", "x-f5xc-example": "tenant-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "reason": { "allOf": [ { "$ref": "#/components/schemas/tenantDeletionReason" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 43, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Request for marking Tenant for deletion.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantDeleteTenantRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantDeletionReason": { "type": "string", "description": "List of available reason for account deletion.\n\n- REASON_UNKNOWN: Unknown reason\n\nUnknown reason\n- REASON_SWITCH_TO_FREE_PLAN: Switch to free plan\n\nSwitch to free plan\n- REASON_NO_LONGER_NEEDED: No longer needed\n\nNo longer needed\n- REASON_NOT_JUSTIFY_COSTS: Too expensive\n\nToo expensive\n- REASON_DIFFICULT_TO_USE: Difficult to use\n\nDifficult to use.", "title": "DeletionReason", "enum": [ "REASON_UNKNOWN", "REASON_SWITCH_TO_FREE_PLAN", "REASON_NO_LONGER_NEEDED", "REASON_NOT_JUSTIFY_COSTS", "REASON_DIFFICULT_TO_USE" ], "default": "REASON_UNKNOWN", "x-displayname": "DeletionReason.", "x-ves-proto-enum": "ves.io.schema.tenant.DeletionReason", "x-f5xc-description-short": "List of available reason for account deletion. - REASON_UNKNOWN: Unknown reason Unknown reason - REASON_SWITCH_TO_FREE_PLAN: Switch to free plan...", "x-f5xc-description-medium": "List of available reason for account deletion. - REASON_UNKNOWN: Unknown reason Unknown reason - REASON_SWITCH_TO_FREE_PLAN: Switch to free plan Switch to free plan - REASON_NO_LONGER_NEEDED: No longer needed No longer needed - REASON_NOT_JUSTIFY_COSTS: Too expensive Too expensive ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantDeletionReason", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"REASON_UNKNOWN\"", "example_yaml": "REASON_UNKNOWN\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantGetLoginEventsInTimeFrameRequest": { "type": "object", "description": "Contains fields to retrieve events in timeframe.", "title": "GetLoginEventsInTimeFrameRequest", "x-displayname": "GetLoginEventsInTimeFrameRequest.", "x-ves-proto-message": "ves.io.schema.tenant.GetLoginEventsInTimeFrameRequest", "properties": { "end": { "type": "string", "description": "End time", "title": "End", "format": "date-time", "x-displayname": "End", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first": { "type": "integer", "description": "Records per page.", "title": "Max", "format": "int64", "x-displayname": "Max", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "max": { "type": "integer", "description": "Records per page.", "title": "Max", "format": "int64", "x-displayname": "Max", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start": { "type": "string", "description": "Start time.", "title": "Start", "format": "date-time", "x-displayname": "Start", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains fields to retrieve events in timeframe.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantGetLoginEventsInTimeFrameRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantLastLoginMap": { "type": "object", "description": "Last login map.", "title": "Last login map", "x-displayname": "Last login map.", "x-ves-proto-message": "ves.io.schema.tenant.LastLoginMap", "properties": { "last_login_map": { "type": "object", "description": "Login map username->timestamp.", "title": "Last login map", "x-displayname": "Last login map.", "additionalProperties": { "type": "string" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantLastLoginMap", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantLoginEventsMap": { "type": "object", "description": "LoginEventsMap is a map from username to list of login events. In can be useful have login events grouped by usernames.", "title": "LoginEventsMap", "x-displayname": "LoginEventsMap.", "x-ves-proto-message": "ves.io.schema.tenant.LoginEventsMap", "properties": { "login_events_map": { "type": "object", "description": "Map of login events based on input filter group by username.", "title": "Login map", "x-displayname": "Login map", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Map of login events based on input filter group by username.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "LoginEventsMap is a map from username to list of login events. In can be useful have login events grouped by usernames.", "x-f5xc-description-medium": "LoginEventsMap is a map from username to list of login events. In can be useful have login events grouped by usernames.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantLoginEventsMap", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantOtpStatus": { "type": "string", "description": "OtpStatus can be either enabled/disabled or processing.\nApplying new policy can take time, especially if tenant has many users so for this purpose processing state is introduced.\n\n- OTP_DISABLED: OTP_DISABLED\n\nOTP disabled\n- OTP_ENABLED: OTP_ENABLED\n\nOTP enabled\n- OTP_PROCESSING: OTP_PROCESSING\n\nOTP is being updated\n- OTP_PROCESS_DISABLING: OTP_PROCESSING\n\nOTP is being updated to be disabled.", "title": "OtpStatus", "enum": [ "OTP_DISABLED", "OTP_ENABLED", "OTP_PROCESSING", "OTP_PROCESS_DISABLING" ], "default": "OTP_DISABLED", "x-displayname": "OtpStatus", "x-ves-proto-enum": "ves.io.schema.tenant.OtpStatus", "x-f5xc-description-short": "OtpStatus can be either enabled/disabled or processing.", "x-f5xc-description-medium": "OtpStatus can be either enabled/disabled or processing. Applying new policy can take time, especially if tenant has many users so for this purpose processing state is introduced. - OTP_DISABLED: OTP_DISABLED OTP disabled - OTP_ENABLED: OTP_ENABLED OTP enabled - OTP_PROCESSING: OTP_PROCESSING OTP...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantOtpStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"OTP_DISABLED\"", "example_yaml": "OTP_DISABLED\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantPasswordPolicyPublicAccess": { "type": "object", "description": "PasswordPolicyPublicAccess contains subset of password policy settings. This settings will be available publicly\nwithout authentication.", "title": "PasswordPolicyPublicAccess", "x-displayname": "PasswordPolicyPublicAccess.", "x-ves-proto-message": "ves.io.schema.tenant.PasswordPolicyPublicAccess", "properties": { "digits": { "type": "integer", "description": "Number of digits.", "title": "Digits", "format": "int64", "x-displayname": "Digits", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lowercase_characters": { "type": "integer", "description": "Number of lowercase characters.", "title": "lowercase_characters", "format": "int64", "x-displayname": "Lowercase_characters.", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "minimum_length": { "type": "integer", "description": "Minimum password length.", "title": "minimum_length", "format": "int64", "x-displayname": "Minimum_length.", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not_recently_used": { "type": "integer", "description": "Number of previous passwords to check for equality - if match found the password is rejected.", "title": "not_recently_used", "format": "int64", "x-displayname": "Not_recently_used.", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-description-short": "Number of previous passwords to check for equality - if match found the password is rejected.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not_username": { "type": "boolean", "description": "If true then username must not appear in the password string.", "title": "not_username", "format": "boolean", "x-displayname": "Not_username.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "If true then username must not appear in the password string.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "special_characters": { "type": "integer", "description": "Number of special characters.", "title": "special_characters", "format": "int64", "x-displayname": "Special_characters.", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uppercase_characters": { "type": "integer", "description": "Number of uppercase characters.", "title": "uppercase_characters", "format": "int64", "x-displayname": "Uppercase_characters.", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PasswordPolicyPublicAccess contains subset of password policy settings. This settings will be available publicly without authentication.", "x-f5xc-description-medium": "PasswordPolicyPublicAccess contains subset of password policy settings. This settings will be available publicly without authentication.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantPasswordPolicyPublicAccess", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantStatusResponse": { "type": "object", "description": "LookupCnameResponse sets the response format based on the availability of cname.\n\nIt can return any of these three types of errors.\nEEXISTS => cname exists.\nEOK => valid request. However, cname does not exist.\nEUNKNOWN => internal error in fetching tenants info.", "x-displayname": "LookupCnameResponse.", "x-ves-proto-message": "ves.io.schema.tenant.StatusResponse", "x-f5xc-description-short": "LookupCnameResponse sets the response format based on the availability of cname.", "x-f5xc-description-medium": "LookupCnameResponse sets the response format based on the availability of cname. It can return any of these three types of errors. EEXISTS => cname exists.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantSummaryResponse": { "type": "object", "description": "Tenant Summary Response.", "title": "SummaryResponse", "x-displayname": "Tenant Summary Response.", "x-ves-proto-message": "ves.io.schema.tenant.SummaryResponse", "properties": { "preferred_lma_region": { "type": "string", "description": "Preferred LMA Region.", "title": "Preferred LMA Region", "x-displayname": "Preferred LMA Region.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Default VIP Type (dedicated/shared)", "title": "Type", "x-displayname": "Default VIP Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip": { "type": "string", "description": "Default VIP.", "title": "VIP", "x-displayname": "Default VIP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantSupportInfo": { "type": "object", "description": "Support Info contains support information for tenant.", "title": "Support Info", "x-displayname": "Support Info.", "x-ves-proto-message": "ves.io.schema.tenant.SupportInfo", "properties": { "support_email_address": { "type": "string", "description": "Support Email address for tenant.", "title": "Support email address", "x-displayname": "Support email address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Support Info contains support information for tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantSupportInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantTenantSettingsResponse": { "type": "object", "description": "Defines tenant specific settings.", "title": "TenantSettingsResponse", "x-displayname": "TenantSettingsResponse.", "x-ves-proto-message": "ves.io.schema.tenant.TenantSettingsResponse", "properties": { "active_plan_transition_id": { "type": "string", "description": "ID of the plan transition request which is currently in state CREATING.", "x-displayname": "ActivePlanTransitionId.", "x-ves-example": "00000000-0000-4000-8000-e92dff7c10ec.", "x-f5xc-example": "00000000-0000-4000-8000-e92dff7c10ec", "x-f5xc-description-short": "ID of the plan transition request which is currently in state CREATING.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "company_name": { "type": "string", "description": "Company name of the tenant.", "title": "CompanyName", "x-displayname": "Company Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Domain of the tenant.", "title": "Domain", "x-displayname": "Domain", "x-f5xc-example": "example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "max_credentials_expiry": { "allOf": [ { "$ref": "#/components/schemas/tenantCredentialsExpiry" } ], "x-f5xc-description-short": "Configuration parameter for max credentials expiry.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name will represent name of the tenant that is being accessed.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Tenant1", "x-f5xc-example": "tenant1", "x-f5xc-description-short": "Name will represent name of the tenant that is being accessed.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "original_tenant": { "type": "string", "description": "Orginal_tenant represent tenant ID where the user belongs to.", "title": "Original Tenant", "x-displayname": "Original Tenant.", "x-ves-example": "Tenant1", "x-f5xc-example": "tenant1", "x-f5xc-description-short": "Orginal_tenant represent tenant ID where the user belongs to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_enabled": { "type": "boolean", "description": "OTP configuration for tenant scope.", "title": "OTP Enabled", "format": "boolean", "x-displayname": "OTP Enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_status": { "allOf": [ { "$ref": "#/components/schemas/tenantOtpStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scim_enabled": { "type": "boolean", "description": "Flag to show SCIM is enabled for specific tenant.", "title": "scim_enabled", "format": "boolean", "x-displayname": "SCIM Enabled.", "x-f5xc-description-short": "Flag to show SCIM is enabled for specific tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sso_enabled": { "type": "boolean", "description": "Flag to show SSO is enabled for specific tenant.", "title": "SSO Enabled", "format": "boolean", "x-displayname": "SSO Enabled.", "x-f5xc-description-short": "Flag to show SSO is enabled for specific tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/schematenantFSMState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantTenantSettingsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantUnassignDomainOwnerRequest": { "type": "object", "description": "Domain owner assignment request.", "title": "Domain owner un-assignment request", "x-displayname": "Domain owner un-assignment request.", "x-ves-proto-message": "ves.io.schema.tenant.UnassignDomainOwnerRequest", "properties": { "email": { "type": "string", "description": "Remove domain owner privilege from user with this email.", "title": "Email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Remove domain owner privilege from user with this email.", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantUnassignDomainOwnerRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantUpdateImageRequest": { "type": "object", "description": "Update user image request.", "title": "Update user image request", "x-displayname": "Update user image request.", "x-ves-proto-message": "ves.io.schema.tenant.UpdateImageRequest", "properties": { "content_type": { "type": "string", "description": "Type of uploading image.", "x-displayname": "ContentType.", "x-ves-example": "Image/jpeg.", "x-f5xc-example": "image/jpeg", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "description": "Blob of the tenant profile image.", "format": "byte", "x-displayname": "Image", "x-ves-example": "DXNlci1pbWFnZS5qcGVn.", "x-f5xc-example": "dXNlci1pbWFnZS5qcGVn", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantUpdateImageRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantUpdateTenantSettingsRequest": { "type": "object", "description": "Request to update tenant settings for specific tenant.", "title": "UpdateTenantSettingsRequest", "x-displayname": "UpdateTenantSettingsRequest.", "x-ves-proto-message": "ves.io.schema.tenant.UpdateTenantSettingsRequest", "properties": { "max_credentials_expiry": { "allOf": [ { "$ref": "#/components/schemas/tenantCredentialsExpiry" } ], "x-f5xc-description-short": "Configuration parameter for max credentials expiry.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_enabled": { "type": "boolean", "description": "OTP configuration for tenant scope.", "title": "OTP Enabled", "format": "boolean", "x-displayname": "OTP Enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to update tenant settings for specific tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantUpdateTenantSettingsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantUpdateTenantSettingsResponse": { "type": "object", "description": "Defines tenant specific settings.", "title": "TenantSettingsResponse", "x-displayname": "TenantSettingsResponse.", "x-ves-proto-message": "ves.io.schema.tenant.UpdateTenantSettingsResponse", "properties": { "max_credentials_expiry": { "allOf": [ { "$ref": "#/components/schemas/tenantCredentialsExpiry" } ], "x-f5xc-description-short": "Configuration parameter for max credentials expiry.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_enabled": { "type": "boolean", "description": "OTP configuration for tenant scope.", "title": "OTP Enabled", "format": "boolean", "x-displayname": "OTP Enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_status": { "allOf": [ { "$ref": "#/components/schemas/tenantOtpStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scim_enabled": { "type": "boolean", "description": "Flag to show SCIM is enabled for specific tenant.", "title": "scim_enabled", "format": "boolean", "x-displayname": "SCIM Enabled.", "x-f5xc-description-short": "Flag to show SCIM is enabled for specific tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sso_enabled": { "type": "boolean", "description": "Flag to show SSO is enabled for specific tenant.", "title": "SSO Enabled", "format": "boolean", "x-displayname": "SSO Enabled.", "x-f5xc-description-short": "Flag to show SSO is enabled for specific tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validation_errors": { "type": "array", "description": "X-displayName : \"Validation errors\"\ncollection of validation errors.", "title": "validation errors", "items": { "$ref": "#/components/schemas/tenantValidationErrorField" }, "x-f5xc-description-short": "X-displayName : \"Validation errors\" collection of validation errors.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantUpdateTenantSettingsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantUser": { "type": "object", "description": "Login user representation. Currently users are identified by their email.", "title": "User", "x-displayname": "User", "x-ves-proto-message": "ves.io.schema.tenant.User", "properties": { "email": { "type": "string", "description": "User's email.", "title": "email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Login user representation. Currently users are identified by their email.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantUser", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantUserList": { "type": "object", "description": "Collection of users.", "title": "User list", "x-displayname": "User list", "x-ves-proto-message": "ves.io.schema.tenant.UserList", "properties": { "users": { "type": "array", "description": "Collection of users.", "title": "Users", "items": { "$ref": "#/components/schemas/tenantUser" }, "x-displayname": "Users", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantUserList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenantValidationErrorField": { "type": "object", "description": "Contains information on a single validation error.", "title": "Validation error field", "x-displayname": "Validation error field.", "x-ves-proto-message": "ves.io.schema.tenant.ValidationErrorField", "properties": { "error_field": { "type": "string", "description": "Path indicates the field that is not valid.", "title": "Error field", "x-displayname": "Error field.", "x-ves-example": "Max_credentials_expiry.", "x-f5xc-example": "max_credentials_expiry", "x-f5xc-description-short": "Path indicates the field that is not valid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_message": { "type": "string", "description": "More descriptive error message.", "title": "Error message", "x-displayname": "Error message.", "x-ves-example": "Max_credentials_expiry code should be less < 0.", "x-f5xc-example": "max_credentials_expiry code should be less < 0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains information on a single validation error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenantValidationErrorField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationBasicConfiguration": { "type": "object", "title": "BasicConfiguration", "x-displayname": "BasicConfiguration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.BasicConfiguration", "properties": { "display_name": { "type": "string", "description": "Changes the tenant name displayed during login without affecting your company’s domain name.", "title": "Display Name", "maxLength": 255, "x-displayname": "Display Name.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.pattern": "^[^<>&\\\"]+$" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.pattern": "^[^<>&\\\"]+$" }, "x-f5xc-description-short": "Changes the tenant name displayed during login without affecting your company’s domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 255, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "pattern": "^[^<>&\\\"]+$", "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationBasicConfiguration", "required_fields": [ "display_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"display_name\": \"value\"\n}", "example_yaml": "display_name: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationBruteForceDetectionSettings": { "type": "object", "title": "BruteForceDetectionSettings", "x-displayname": "BruteForceDetectionSettings.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.BruteForceDetectionSettings", "properties": { "max_login_failures": { "type": "integer", "description": "How many failures before wait is triggered.\nWhen login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.", "title": "Max Login Failures", "format": "int64", "x-displayname": "Max Login Failures.", "x-ves-example": "5", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "30" }, "x-f5xc-example": "5", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "30" }, "x-f5xc-description-short": "How many failures before wait is triggered. When login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.", "x-f5xc-description-medium": "How many failures before wait is triggered. When login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 30, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationBruteForceDetectionSettings", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationCookieHoursDuration": { "type": "object", "description": "Represents the cookie duration in hours.", "title": "Cookie Hours Duration", "x-displayname": "Cookie Hours Duration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.CookieHoursDuration", "properties": { "duration": { "type": "integer", "description": "Configuration parameter for duration", "title": "Duration", "format": "int64", "x-displayname": "Duration", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "720" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "720" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 720, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents the cookie duration in hours.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationCookieHoursDuration", "required_fields": [ "duration" ], "mutually_exclusive_groups": [], "example_json": "{\n \"duration\": 1\n}", "example_yaml": "duration: 1" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationCookieMinutesDuration": { "type": "object", "description": "Represents the cookie duration in minutes.", "title": "Cookie Minutes Duration", "x-displayname": "Cookie Minutes Duration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.CookieMinutesDuration", "properties": { "duration": { "type": "integer", "description": "Configuration parameter for duration", "title": "Duration", "format": "int64", "x-displayname": "Duration", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "5", "ves.io.schema.rules.uint32.lte": "43200" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "5", "ves.io.schema.rules.uint32.lte": "43200" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 5, "maximum": 43200, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents the cookie duration in minutes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationCookieMinutesDuration", "required_fields": [ "duration" ], "mutually_exclusive_groups": [], "example_json": "{\n \"duration\": 5\n}", "example_yaml": "duration: 5" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationDurationByUnitCookie": { "type": "object", "description": "Represents the cookie expiration duration.", "title": "Duration By Unit Cookie", "x-displayname": "Duration By Unit Cookie.", "x-ves-oneof-field-unit_of_time": "[\"hours\",\"minutes\"]", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.DurationByUnitCookie", "properties": { "hours": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationCookieHoursDuration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "minutes" ] }, "minutes": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationCookieMinutesDuration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hours" ] } }, "x-f5xc-description-short": "Represents the cookie expiration duration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationDurationByUnitCookie", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationDurationByUnitSession": { "type": "object", "description": "Represents the session expiration duration.", "title": "Duration By Unit Session", "x-displayname": "Duration By Unit Session.", "x-ves-oneof-field-unit_of_time": "[\"hours\",\"minutes\"]", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.DurationByUnitSession", "properties": { "hours": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationSessionHoursDuration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "minutes" ] }, "minutes": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationSessionMinutesDuration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hours" ] } }, "x-f5xc-description-short": "Represents the session expiration duration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationDurationByUnitSession", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationPasswordPolicy": { "type": "object", "title": "PasswordPolicy", "x-displayname": "PasswordPolicy.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.PasswordPolicy", "properties": { "digits": { "type": "integer", "description": "The number of digits required to be in the password string.", "title": "Digits", "format": "int64", "x-displayname": "Min Number Of Digits.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-description-short": "The number of digits required to be in the password string.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expire_password": { "type": "integer", "description": "The number of days for which the password is valid.\nAfter the number of days has expired, the user is required to change their password.", "title": "Expire Password", "format": "int64", "x-displayname": "Expire Password.", "x-ves-example": "30", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "1080" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "1080" }, "x-f5xc-description-short": "The number of days for which the password is valid. After the number of days has expired, the user is required to change their password.", "x-f5xc-description-medium": "The number of days for which the password is valid. After the number of days has expired, the user is required to change their password.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 1080, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lowercase_characters": { "type": "integer", "description": "The number of lower case letters required to be in the password string.", "title": "Lowercase Characters", "format": "int64", "x-displayname": "Min Number Of Lowercase Characters.", "x-ves-example": "8", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-example": "8", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-description-short": "The number of lower case letters required to be in the password string.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "minimum_length": { "type": "integer", "description": "Minimum length of password.", "title": "Minimum Length", "format": "int64", "x-displayname": "Minimum Length.", "x-ves-example": "12", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "7" }, "x-f5xc-example": "12", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "7" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 7, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "not_recently_used": { "type": "integer", "description": "This policy is used to restrict user from using previously used passwords.\nNumber that's set determines number of last passwords which user cannot use as new password.", "title": "Not Recently Used", "format": "int64", "x-displayname": "Not Recently Used.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Policy is used to restrict user from using previously used passwords.", "x-f5xc-description-medium": "Policy is used to restrict user from using previously used passwords. Number that's set determines number of last passwords which user cannot use as new password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not_username": { "type": "boolean", "description": "When set, the password is not allowed to be the same as the username.", "title": "Not Username", "format": "boolean", "x-displayname": "Not Username.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "When set, the password is not allowed to be the same as the username.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "special_characters": { "type": "integer", "description": "The number of special characters like '?!#%$' required to be in the password string.", "title": "Special Characters", "format": "int64", "x-displayname": "Min Number Of Special Characters.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-description-short": "The number of special characters like '?!#%$' required to be in the password string.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uppercase_characters": { "type": "integer", "description": "The number of upper case letters required to be in the password string.", "title": "Uppercase Characters", "format": "int64", "x-displayname": "Min Number Of Uppercase Characters.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-description-short": "The number of upper case letters required to be in the password string.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationPasswordPolicy", "required_fields": [ "minimum_length" ], "mutually_exclusive_groups": [], "example_json": "{\n \"minimum_length\": 7\n}", "example_yaml": "minimum_length: 7" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationSessionHoursDuration": { "type": "object", "description": "Represents the session duration in hours.", "title": "Session Hours Duration", "x-displayname": "Session Hours Duration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.SessionHoursDuration", "properties": { "duration": { "type": "integer", "description": "Configuration parameter for duration", "title": "Duration", "format": "int64", "x-displayname": "Duration", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "720" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "720" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 720, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents the session duration in hours.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationSessionHoursDuration", "required_fields": [ "duration" ], "mutually_exclusive_groups": [], "example_json": "{\n \"duration\": 1\n}", "example_yaml": "duration: 1" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationSessionMinutesDuration": { "type": "object", "description": "Represents the session duration in minutes.", "title": "Session Minutes Duration", "x-displayname": "Session Minutes Duration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.SessionMinutesDuration", "properties": { "duration": { "type": "integer", "description": "Configuration parameter for duration", "title": "Duration", "format": "int64", "x-displayname": "Duration", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "5", "ves.io.schema.rules.uint32.lte": "43200" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "5", "ves.io.schema.rules.uint32.lte": "43200" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 5, "maximum": 43200, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents the session duration in minutes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationSessionMinutesDuration", "required_fields": [ "duration" ], "mutually_exclusive_groups": [], "example_json": "{\n \"duration\": 5\n}", "example_yaml": "duration: 5" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationUserSessionExpiration": { "type": "object", "description": "Defines all session-related expiration for user sessions within a tenant's environment.\nRelationship between session_expiry and cookie_expiry:\n- session_expiry defines the 'absolute maximum duration' of a session and enforces RE-authentication after this time.\n- cookie_expiry defines the 'inactivity timeout', which resets on user activity and only logs out users after idle periods.\nTogether, these ensure the user is logged out when either the session reaches its maximum age or the user is inactive for too long.", "title": "User Session Expiration", "x-displayname": "User Session Expiration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.UserSessionExpiration", "properties": { "absolute_timeout": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationDurationByUnitSession" } ], "x-f5xc-description-short": "Configuration parameter for absolute timeout.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "idle_timeout": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationDurationByUnitCookie" } ], "x-f5xc-example": "30s", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines all session-related expiration for user sessions within a tenant's environment.", "x-f5xc-description-medium": "Defines all session-related expiration for user sessions within a tenant's environment. Relationship between session_expiry and cookie_expiry: - session_expiry defines the 'absolute maximum duration' of a session and enforces RE-authentication after this time. - cookie_expiry defines the...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationUserSessionExpiration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewstenant_configurationGlobalSpecType": { "type": "object", "description": "Shape of the tenant configuration specification.", "title": "GlobalSpecType", "x-displayname": "Global Specification.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.GlobalSpecType", "properties": { "basic_configuration": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBasicConfiguration" } ], "x-f5xc-description-short": "Configuration parameter for basic configuration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "brute_force_detection": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBruteForceDetectionSettings" } ], "x-f5xc-description-short": "Configuration parameter for brute force detection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "brute_force_detection_settings": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBruteForceDetectionSettings" } ], "x-f5xc-description-short": "Configuration parameter for brute force detection settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "password_policy": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationPasswordPolicy" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_details": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBasicConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_session_expiration": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationUserSessionExpiration" } ], "x-f5xc-description-short": "Configuration parameter for user session expiration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the tenant configuration specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewstenant_configurationGlobalSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of tenant_configuration", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.CreateRequest", "properties": { "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationCreateSpecType": { "type": "object", "description": "Shape of the tenant configuration specification.", "title": "CreateSpecType", "x-displayname": "Create tenant configuration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.CreateSpecType", "properties": { "brute_force_detection": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBruteForceDetectionSettings" } ], "x-f5xc-description-short": "Configuration parameter for brute force detection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "password_policy": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationPasswordPolicy" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_details": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBasicConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_session_expiration": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationUserSessionExpiration" } ], "x-f5xc-description-short": "Configuration parameter for user session expiration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the tenant configuration specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a tenant_configuration", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read tenant_configuration", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_configurationStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationGetSpecType": { "type": "object", "description": "Shape of the tenant configuration specification.", "title": "GetSpecType", "x-displayname": "GET tenant configuration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.GetSpecType", "properties": { "brute_force_detection": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBruteForceDetectionSettings" } ], "x-f5xc-description-short": "Configuration parameter for brute force detection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "password_policy": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationPasswordPolicy" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_details": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBasicConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_session_expiration": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationUserSessionExpiration" } ], "x-f5xc-description-short": "Configuration parameter for user session expiration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the tenant configuration specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of tenant_configuration", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/tenant_configurationListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationListResponseItem": { "type": "object", "description": "By default a summary of tenant_configuration is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of tenant_configuration", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this tenant_configuration.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this tenant_configuration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this tenant_configuration.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this tenant_configuration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates tenant_configuration is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates tenant_configuration is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this tenant_configuration.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this tenant_configuration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this tenant_configuration.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/tenant_configurationStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this tenant_configuration.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this tenant_configuration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of tenant_configuration is returned in 'List'.", "x-f5xc-description-medium": "By default a summary of tenant_configuration is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a tenant_configuration", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.ReplaceRequest", "properties": { "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationReplaceSpecType": { "type": "object", "description": "Shape of the tenant configuration specification.", "title": "ReplaceSpecType", "x-displayname": "Replace tenant configuration.", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.ReplaceSpecType", "properties": { "brute_force_detection": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBruteForceDetectionSettings" } ], "x-f5xc-description-short": "Configuration parameter for brute force detection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "password_policy": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationPasswordPolicy" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_details": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationBasicConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_session_expiration": { "allOf": [ { "$ref": "#/components/schemas/tenant_configurationUserSessionExpiration" } ], "x-f5xc-description-short": "Configuration parameter for user session expiration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the tenant configuration specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_configurationStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.tenant_configuration.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Tenant configuration view object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-description-short": "Tenant configuration view object direct reference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_configurationStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant configuration is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementSubscribeRequest": { "type": "object", "description": "Request to subscribe to Tenant Management Service.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.SubscribeRequest", "x-f5xc-description-short": "Request to subscribe to Tenant Management Service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementSubscribeResponse": { "type": "object", "description": "Response of subscribe to Tenant Management Service.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.SubscribeResponse", "x-f5xc-description-short": "Response of subscribe to Tenant Management Service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementUnsubscribeRequest": { "type": "object", "description": "Request to unsubscribe to Tenant Management Service.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.UnsubscribeRequest", "x-f5xc-description-short": "Request to unsubscribe to Tenant Management Service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_managementUnsubscribeResponse": { "type": "object", "description": "Response of unsubscribe to Tenant Management Service.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.UnsubscribeResponse", "x-f5xc-description-short": "Response of unsubscribe to Tenant Management Service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaFile": { "type": "object", "description": "Contains file data.", "title": "File", "x-displayname": "File", "x-ves-oneof-field-storage_provider": "[\"aws_s3\"]", "x-ves-proto-message": "ves.io.schema.File", "properties": { "aws_s3": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "content": { "type": "string", "description": "Content of the file.", "title": "Content", "format": "byte", "x-displayname": "Content", "x-ves-example": "DXNlci1pbWFnZS5qcGVn.", "x-f5xc-example": "dXNlci1pbWFnZS5qcGVn", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "content_type": { "type": "string", "description": "Content type of the file (MIME type)", "title": "ContentType", "x-displayname": "Content Type.", "x-ves-example": "Image/jpeg.", "x-f5xc-example": "image/jpeg", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaFile", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_managementtenant_profileNamespaceRoleType": { "type": "object", "description": "Allows linking namespaces and roles.", "title": "Namespace role", "x-displayname": "Namespace Role.", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.NamespaceRoleType", "properties": { "namespace": { "type": "string", "description": "All Namespaces with custom names will be created in the new Child Tenant.\nInput a '*' to apply to all application namespaces. The System, Shared, and Default namespaces will be created automatically.", "title": "Namespace", "maxLength": 256, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "All Namespaces with custom names will be created in the new Child Tenant. Input a '*' to apply to all application namespaces.", "x-f5xc-description-medium": "All Namespaces with custom names will be created in the new Child Tenant. Input a '*' to apply to all application namespaces. The System, Shared, and Default namespaces will be created automatically.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "role": { "type": "string", "description": "User role that users in the newly created group will inherit.", "title": "Role", "maxLength": 256, "x-displayname": "Role", "x-ves-example": "VES-I/O-monitor-role.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "ves-io-monitor-role", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "User role that users in the newly created group will inherit.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_managementtenant_profileNamespaceRoleType", "required_fields": [ "namespace", "role" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"ns1\",\n \"role\": \"ves-io-monitor-role\"\n}", "example_yaml": "namespace: ns1\nrole: ves-io-monitor-role" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tenant object is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "tenant_profileCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of tenant_profile", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_profileCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_profileGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileCreateSpecType": { "type": "object", "description": "Creates a tenant_profile config instance. Name of the object is the name of the tenant profile to be created.", "title": "Create Tenant Profile", "x-displayname": "Create Tenant Profile.", "x-ves-displayorder": "1,2,4,7,8,6", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.CreateSpecType", "properties": { "ct_groups": { "type": "array", "description": "List of user groups to be created on child tenant.", "maxItems": 16, "items": { "$ref": "#/components/schemas/tenant_profileGroupObjTmplType" }, "x-displayname": "Child Tenant Groups.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of user groups to be created on child tenant.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_support_access": { "type": "boolean", "description": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant\nfor troubleshooting. Unselecting will pause access for XC Support.", "format": "boolean", "x-displayname": "Support Access.", "x-f5xc-description-short": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant for troubleshooting.", "x-f5xc-description-medium": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant for troubleshooting. Unselecting will pause access for XC Support.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "favicon": { "allOf": [ { "$ref": "#/components/schemas/schemaFile" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "logo": { "allOf": [ { "$ref": "#/components/schemas/schemaFile" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "plan": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "plan", "gated_by": null, "required": false, "cardinality": "single" } ] }, "support_email": { "type": "string", "description": "Support Email address for child tenant.", "x-displayname": "Support Email.", "x-ves-example": "Dana@example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "email", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Creates a tenant_profile config instance. Name of the object is the name of the tenant profile to be created.", "x-f5xc-description-medium": "Creates a tenant_profile config instance. Name of the object is the name of the tenant profile to be created.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a tenant_profile", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read tenant_profile", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_profileCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/tenant_profileReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_profileGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileGetSpecType": { "type": "object", "description": "GET tenant_profile reads a given object from storage backend for metadata.namespace.", "title": "Get Tenant Profile", "x-displayname": "GET Tenant Profile.", "x-ves-displayorder": "1,2,4,7,8,6", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.GetSpecType", "properties": { "ct_groups": { "type": "array", "description": "List of user groups to be created on child tenant.", "maxItems": 16, "items": { "$ref": "#/components/schemas/tenant_profileGroupObjTmplType" }, "x-displayname": "Child Tenant Groups.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of user groups to be created on child tenant.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_support_access": { "type": "boolean", "description": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant\nfor troubleshooting. Unselecting will pause access for XC Support.", "format": "boolean", "x-displayname": "Support Access.", "x-f5xc-description-short": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant for troubleshooting.", "x-f5xc-description-medium": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant for troubleshooting. Unselecting will pause access for XC Support.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "favicon": { "allOf": [ { "$ref": "#/components/schemas/schemaFile" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "logo": { "allOf": [ { "$ref": "#/components/schemas/schemaFile" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "plan": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "plan", "gated_by": null, "required": false, "cardinality": "single" } ] }, "support_email": { "type": "string", "description": "Support Email address for child tenant.", "x-displayname": "Support Email.", "x-ves-example": "Dana@example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "email", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GET tenant_profile reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileGroupObjTmplType": { "type": "object", "description": "Shape for specifying group object template for ct groups.", "title": "GroupObjTmplType", "x-displayname": "Group object template.", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.GroupObjTmplType", "properties": { "name": { "type": "string", "description": "Name of the child tenant user group.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Admin", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "admin", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ves_object_name": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_roles": { "type": "array", "description": "[\n]\nList of namespaces and associated roles to be created in the new Child Tenant.", "title": "Namespace roles", "maxItems": 16, "items": { "$ref": "#/components/schemas/tenant_managementtenant_profileNamespaceRoleType" }, "x-displayname": "Namespace Roles.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-example": "monitor, system:monitor-role", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-description-short": "[ ] List of namespaces and associated roles to be created in the new Child Tenant.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape for specifying group object template for ct groups.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileGroupObjTmplType", "required_fields": [ "name", "namespace_roles" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"admin\",\n \"namespace_roles\": [\n {\n \"namespace\": \"ns1\",\n \"role\": \"ves-io-monitor-role\"\n }\n ]\n}", "example_yaml": "name: admin\nnamespace_roles:\n- namespace: ns1\n role: ves-io-monitor-role" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of tenant_profile", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/tenant_profileListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileListResponseItem": { "type": "object", "description": "By default a summary of tenant_profile is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of tenant_profile", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this tenant_profile.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this tenant_profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this tenant_profile.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this tenant_profile.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates tenant_profile is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates tenant_profile is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_profileGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this tenant_profile.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this tenant_profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this tenant_profile.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this tenant_profile.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of tenant_profile is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of tenant_profile is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a tenant_profile", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/tenant_profileReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "tenant_profileReplaceSpecType": { "type": "object", "description": "Replaces attributes of a tenant_profile configuration.", "title": "Replace Tenant Profile", "x-displayname": "Replace Tenant Profile.", "x-ves-displayorder": "1,2,4,7,8,6", "x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.ReplaceSpecType", "properties": { "ct_groups": { "type": "array", "description": "List of user groups to be created on child tenant.", "maxItems": 16, "items": { "$ref": "#/components/schemas/tenant_profileGroupObjTmplType" }, "x-displayname": "Child Tenant Groups.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of user groups to be created on child tenant.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_support_access": { "type": "boolean", "description": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant\nfor troubleshooting. Unselecting will pause access for XC Support.", "format": "boolean", "x-displayname": "Support Access.", "x-f5xc-description-short": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant for troubleshooting.", "x-f5xc-description-medium": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant for troubleshooting. Unselecting will pause access for XC Support.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "favicon": { "allOf": [ { "$ref": "#/components/schemas/schemaFile" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "logo": { "allOf": [ { "$ref": "#/components/schemas/schemaFile" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "plan": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "plan", "gated_by": null, "required": false, "cardinality": "single" } ] }, "support_email": { "type": "string", "description": "Support Email address for child tenant.", "x-displayname": "Support Email.", "x-ves-example": "Dana@example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "email", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Replaces attributes of a tenant_profile configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for tenant_profileReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaNamespaceAccessType": { "type": "object", "description": "Access info in the namespaces for the entity.", "title": "Namespace Access", "x-displayname": "Namespace Access.", "x-ves-proto-message": "ves.io.schema.NamespaceAccessType", "properties": { "namespace_role_map": { "type": "object", "description": "List of all the roles for the entity in the namespaces.", "title": "Namespace Role Map", "x-displayname": "Namespace Role Map.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "256", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "' []'", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "256", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "List of all the roles for the entity in the namespaces.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Access info in the namespaces for the entity.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaNamespaceAccessType", "required_fields": [ "namespace_role_map" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace_role_map\": {}\n}", "example_yaml": "namespace_role_map: {}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaNamespaceRoleType": { "type": "object", "description": "Allows linking namespaces and roles.", "title": "Namespace role", "x-displayname": "Namespace Role.", "x-ves-proto-message": "ves.io.schema.NamespaceRoleType", "properties": { "namespace": { "type": "string", "description": "Namespace the role applies to\n'*' value implies all namespaces.", "title": "Namespace", "maxLength": 256, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Namespace the role applies to '*' value implies all namespaces.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "role": { "type": "string", "description": "Users role for this namespace.", "title": "Role", "maxLength": 256, "x-displayname": "Role", "x-ves-example": "VES-I/O-monitor-role.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "ves-io-monitor-role", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaNamespaceRoleType", "required_fields": [ "namespace", "role" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"ns1\",\n \"role\": \"ves-io-monitor-role\"\n}", "example_yaml": "namespace: ns1\nrole: ves-io-monitor-role" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "identity", "multi_tenant_pattern": "per-tenant" } } }, "schemaPlanType": { "type": "string", "description": "PlanType is the type of billing plan for the customer.", "title": "PlanType", "enum": [ "FREE", "INDIVIDUAL", "TEAM", "ORGANIZATION", "PLAN_TYPE_UNSPECIFIED" ], "default": "FREE", "x-displayname": "Plan Type", "x-ves-proto-enum": "ves.io.schema.PlanType", "x-f5xc-description-short": "PlanType is the type of billing plan for the customer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaPlanType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"FREE\"", "example_yaml": "FREE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaSignupOrigin": { "type": "string", "description": "SignupOrigin indicates, from which platform signup is originated, example f5xc, AWS..etc\n\n- ORIGIN_UNKNOWN: ORIGIN_UNKNOWN\n\nIndicates, the origin of the signup is unknown\n- ORIGIN_F5XC: ORIGIN_F5XC\n\nORIGIN_F5XC as an origin indicates, signup is initiated from console or by internal scaling/testing/support teams using private API\n- ORIGIN_AWS: ORIGIN_AWS\n\nORIGIN_AWS as an origin indicates, signup is initiated from AWS marketplace & it comes to eywaprime via tsahik\n- ORIGIN_ASB: ORIGIN_ASB\n\nORIGIN_ASB as an origin indicates signup originated from Azure service bus provisioning messages & it comes to eywaprime via tsahik.", "title": "SignupOrigin", "enum": [ "ORIGIN_UNKNOWN", "ORIGIN_F5XC", "ORIGIN_AWS", "ORIGIN_ASB" ], "default": "ORIGIN_UNKNOWN", "x-displayname": "Signup Origin.", "x-ves-proto-enum": "ves.io.schema.SignupOrigin", "x-required": true, "x-f5xc-description-short": "SignupOrigin indicates, from which platform signup is originated, example f5xc, AWS..etc - ORIGIN_UNKNOWN: ORIGIN_UNKNOWN Indicates, the origin of...", "x-f5xc-description-medium": "SignupOrigin indicates, from which platform signup is originated, example f5xc, AWS..etc - ORIGIN_UNKNOWN: ORIGIN_UNKNOWN Indicates, the origin of the signup is unknown - ORIGIN_F5XC: ORIGIN_F5XC ORIGIN_F5XC as an origin indicates, signup is initiated from console or by internal...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSignupOrigin", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ORIGIN_UNKNOWN\"", "example_yaml": "ORIGIN_UNKNOWN\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemauserEmpty": { "type": "object", "description": "Empty is a message without actual content/body.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.user.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemauserEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userAcceptTOSRequest": { "type": "object", "description": "Accept TOS request model.", "title": "Accept TOS request model", "x-displayname": "Accept TOS Request.", "x-ves-proto-message": "ves.io.schema.user.AcceptTOSRequest", "properties": { "namespace": { "type": "string", "description": "Value of namespace is always \"system\".", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tos_accepted": { "type": "string", "description": "Tos accepted version, this field is deprecated refer the fields `tos_accepted_at` and `tos_version` instead.", "title": "tos_accepted", "x-displayname": "TOS Accepted.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Tos accepted version, this field is deprecated refer the fields and instead.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted_at": { "type": "string", "description": "Tos accepted timestamp in epoch.", "title": "tos_accepted_at", "format": "int64", "x-displayname": "TOS Accepted Timestamp.", "x-ves-example": "1628490105132.", "x-f5xc-example": "1628490105132", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_version": { "type": "string", "description": "Tos accepted version.", "title": "tos_version", "x-displayname": "TOS version.", "x-ves-example": "V1.0", "x-f5xc-example": "v1.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userAcceptTOSRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userAcceptTOSResponse": { "type": "object", "description": "Accept TOS response model.", "title": "Accept TOS response model", "x-displayname": "Accept TOS Response.", "x-ves-proto-message": "ves.io.schema.user.AcceptTOSResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userAcceptTOSResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userAccessType": { "type": "string", "description": "Used to identify the tenant access\n\n- UNKNOWN_ACCESS: UNKNOWN_ACCESS\n\nWhen unable to determine the tenant access\n- DIRECT_ACCESS: DIRECT_ACCESS\n\nAccessing tenant through direct login\n- MSP_ACCESS: MSP_ACCESS\n\nAccessing tenant from MSP tenant\n- DELEGATED_ACCESS: DELEGATED_ACCESS\n\nAccessing tenant from operating tenant through delegated access\n- SUPPORT_ACCESS: SUPPORT_ACCESS\n\nAccessing tenant from support tenant.", "title": "AccessType", "enum": [ "UNKNOWN_ACCESS", "DIRECT_ACCESS", "MSP_ACCESS", "DELEGATED_ACCESS", "SUPPORT_ACCESS" ], "default": "UNKNOWN_ACCESS", "x-displayname": "Identify the tenant access.", "x-ves-proto-enum": "ves.io.schema.user.AccessType", "x-f5xc-description-short": "Used to identify the tenant access - UNKNOWN_ACCESS: UNKNOWN_ACCESS When unable to determine the tenant access - DIRECT_ACCESS: DIRECT_ACCESS...", "x-f5xc-description-medium": "Used to identify the tenant access - UNKNOWN_ACCESS: UNKNOWN_ACCESS When unable to determine the tenant access - DIRECT_ACCESS: DIRECT_ACCESS Accessing tenant through direct login - MSP_ACCESS: MSP_ACCESS Accessing tenant from MSP tenant - DELEGATED_ACCESS: DELEGATED_ACCESS Accessing tenant from...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userAccessType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNKNOWN_ACCESS\"", "example_yaml": "UNKNOWN_ACCESS\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userAssignRoleRequest": { "type": "object", "description": "Allows assigning user's role in a namespace or set of namespaces.", "title": "Assign role", "x-displayname": "Assign Role.", "x-ves-proto-message": "ves.io.schema.user.AssignRoleRequest", "properties": { "namespace": { "type": "string", "description": "Namespace the requesting user is calling the action from.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-description-short": "Namespace the requesting user is calling the action from.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespaces_role": { "allOf": [ { "$ref": "#/components/schemas/userNamespacesRoleType" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "username": { "type": "array", "description": "Username of the user that needs the role assigned.\nIdeally this will be the email address of the user (which is by default treated as username)\ncheck Create RPC UserRoleRequest for more details.", "title": "Username", "items": { "type": "string" }, "x-displayname": "Username", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Username of the user that needs the role assigned.", "x-f5xc-description-medium": "Username of the user that needs the role assigned. Ideally this will be the email address of the user (which is by default treated as username) check Create RPC UserRoleRequest for more details.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Allows assigning user's role in a namespace or set of namespaces.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userAssignRoleRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userBillingFeatureIndicator": { "type": "object", "description": "Single instance of a billing indicator.\nIt informs the customer of any problems with their billing, including failed payments, overdue invoices, or missing valid payment methods.", "title": "Billing Feature Indicator", "x-displayname": "Billing feature indicator.", "x-ves-proto-message": "ves.io.schema.user.BillingFeatureIndicator", "properties": { "action": { "allOf": [ { "$ref": "#/components/schemas/userBillingFlagAction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "additional_info": { "type": "string", "description": "Any description (such as error message) related to this billing feature.", "title": "Additional info", "x-displayname": "Additional info.", "x-ves-example": "Payment failed due to insufficient funds.", "x-f5xc-example": "payment failed due to insufficient funds", "x-f5xc-description-short": "Any description (such as error message) related to this billing feature.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "billing_flag": { "allOf": [ { "$ref": "#/components/schemas/userBillingFlag" } ], "x-f5xc-description-short": "Configuration parameter for billing flag.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "failed": { "type": "boolean", "description": "If true then the billing feature is failed and to be looked into.", "title": "Failed", "format": "boolean", "x-displayname": "Failed", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "If true then the billing feature is failed and to be looked into.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-medium": "Single instance of a billing indicator. It informs the customer of any problems with their billing, including failed payments, overdue invoices, or missing valid payment methods.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userBillingFeatureIndicator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userBillingFlag": { "type": "string", "description": "Possible billing flags used to indicate problems with customer billing.\n\n- VALID_PAYMENT_METHOD: customer has a valid payment method on our file\n- OVERDUE_INVOICE: customer has at least one overdue invoice with with us\n- LAST_TRANSACTION_STATUS: status of customer's last transaction. A retry may be triggered so this is an early warning.\n- PAYMENT_METHOD_EXPIRED: this flag is on when the customer has no but expired payment method on it's file.\nWe could not charge your primary payment method due to insufficient funds\nYour primary payment method was declined\nSecurity code for your primary payment method is incorrect\nZIP code for your primary payment method is incorrect\nWe could not charge your primary payment method due to insufficient funds. Your secondary payment method was charged\nYour primary payment method has expired. Your secondary payment method was charged\nYour primary payment method was declined. Your secondary payment method was charged\nWe could not charge any of the active payment methods\nWe could not charge any of the active payment methods\nAdding a payment method resulted in an error.", "title": "Billing flag", "enum": [ "VALID_PAYMENT_METHOD", "OVERDUE_INVOICE", "LAST_TRANSACTION_STATUS", "PAYMENT_METHOD_EXPIRED", "PAYMENT_METHOD_INSUFFICIENT_FUNDS", "PAYMENT_METHOD_PRIMARY_DECLINED", "PAYMENT_METHOD_CVC_INVALID", "PAYMENT_METHOD_ZIP_INVALID", "PAYMENT_METHOD_INSUFFICIENT_FUNDS_SECONDARY_CHARGED", "PAYMENT_METHOD_PRIMARY_EXPIRED_SECONDARY_CHARGED", "PAYMENT_METHOD_PRIMARY_DECLINED_SECONDARY_CHARGED", "PAYMENT_METHOD_BOTH_PAYMENT_METHOD_FAILED", "PAYMENT_METHOD_GENERIC_FAILURE", "PAYMENT_METHOD_GENERIC_ADD_FAILURE" ], "default": "VALID_PAYMENT_METHOD", "x-displayname": "Billing flag.", "x-ves-proto-enum": "ves.io.schema.user.BillingFlag", "x-f5xc-description-short": "Possible billing flags used to indicate problems with customer billing. - VALID_PAYMENT_METHOD: customer has a valid payment method on our file ...", "x-f5xc-description-medium": "Possible billing flags used to indicate problems with customer billing. - VALID_PAYMENT_METHOD: customer has a valid payment method on our file - OVERDUE_INVOICE: customer has at least one overdue invoice with with us - LAST_TRANSACTION_STATUS: status of customer's last transaction. A retry may...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userBillingFlag", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VALID_PAYMENT_METHOD\"", "example_yaml": "VALID_PAYMENT_METHOD\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userBillingFlagAction": { "type": "string", "description": "Action to be executed when customer click on the UI warning\n\n- NO_ACTION: we don't expect customer to take any actoon\n- ADD_NEW_PAYMENT_METHOD: customer should provide a new payment method\n- CONTACT_US: customer should send us an email.", "title": "Billing flag action", "enum": [ "NO_ACTION", "ADD_NEW_PAYMENT_METHOD", "CONTACT_US" ], "default": "NO_ACTION", "x-displayname": "Billing flag action.", "x-ves-proto-enum": "ves.io.schema.user.BillingFlagAction", "x-f5xc-description-short": "Action to be executed when customer click on the UI warning - NO_ACTION: we don't expect customer to take any actoon - ADD_NEW_PAYMENT_METHOD...", "x-f5xc-description-medium": "Action to be executed when customer click on the UI warning - NO_ACTION: we don't expect customer to take any actoon - ADD_NEW_PAYMENT_METHOD: customer should provide a new payment method - CONTACT_US: customer should send us an email.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userBillingFlagAction", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NO_ACTION\"", "example_yaml": "NO_ACTION\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userCascadeDeleteItemType": { "type": "object", "description": "CascadeDeleteItemType contains details of object that was handled as part of cascade DELETE\nof user and whether it was successfully deleted.", "title": "CascadeDeleteItemType", "x-displayname": "Cascade Deletion of User and Associated Namespace Roles.", "x-ves-proto-message": "ves.io.schema.user.CascadeDeleteItemType", "properties": { "error_message": { "type": "string", "description": "Informative error message about the success or failure of the object's deletion response.", "title": "error message", "x-displayname": "Error Message.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Informative error message about the success or failure of the object's deletion response.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_name": { "type": "string", "description": "Name of the object.", "title": "object's name", "x-displayname": "Object Name.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_type": { "type": "string", "description": "The type of the object.", "title": "object's type", "x-displayname": "Object Type.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_uid": { "type": "string", "description": "The uid of the object.", "title": "object's uid", "x-displayname": "Object Uid.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CascadeDeleteItemType contains details of object that was handled as part of cascade DELETE of user and whether it was successfully deleted.", "x-f5xc-description-medium": "CascadeDeleteItemType contains details of object that was handled as part of cascade DELETE of user and whether it was successfully deleted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userCascadeDeleteItemType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userCascadeDeleteRequest": { "type": "object", "description": "CascadeDeleteRequest is the request to DELETE the user along with the associated namespace role objects.\nNote: only admin is allowed to DELETE the user and associated objects.", "title": "CascadeDeleteRequest", "x-displayname": "DELETE the User and Associated Namespace Roles.", "x-ves-proto-message": "ves.io.schema.user.CascadeDeleteRequest", "properties": { "email": { "type": "string", "description": "Email of the user requesting for.", "title": "email of the user", "x-displayname": "Email", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Value of namespace is always \"system\"", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "CascadeDeleteRequest is the request to DELETE the user along with the associated namespace role objects.", "x-f5xc-description-medium": "CascadeDeleteRequest is the request to DELETE the user along with the associated namespace role objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userCascadeDeleteRequest", "required_fields": [ "email" ], "mutually_exclusive_groups": [], "example_json": "{\n \"email\": \"value\"\n}", "example_yaml": "email: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userCascadeDeleteResponse": { "type": "object", "description": "CascadeDeleteResponse contains a list of user objects that were deleted\nand possibly any errors when attempting to DELETE those objects.", "title": "CascadeDeleteResponse", "x-displayname": "DELETE Response for the User and Associated Namespace Roles.", "x-ves-proto-message": "ves.io.schema.user.CascadeDeleteResponse", "properties": { "delete_ok": { "type": "boolean", "description": "Status of the deleted objects.\n\"true\" value indicates that the operation had been successful for all the objects.\n\"false\" value indicates that at least one of the DELETE operations had been unsuccessful.", "title": "delete_ok", "format": "boolean", "x-displayname": "DELETE Ok", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Status of the deleted objects. \"true\" value indicates that the operation had been successful for all the objects. \"false\" value indicates that at...", "x-f5xc-description-medium": "Status of the deleted objects. \"true\" value indicates that the operation had been successful for all the objects. \"false\" value indicates that at least one of the DELETE operations had been unsuccessful.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "The objects deleted for the specific user.", "title": "items", "items": { "$ref": "#/components/schemas/userCascadeDeleteItemType" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "The objects deleted for the specific user.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CascadeDeleteResponse contains a list of user objects that were deleted and possibly any errors when attempting to DELETE those objects.", "x-f5xc-description-medium": "CascadeDeleteResponse contains a list of user objects that were deleted and possibly any errors when attempting to DELETE those objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userCascadeDeleteResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userFeatureFlagType": { "type": "object", "title": "FeatureFlagType\nx-displayName: \"Feature and its Status for the Tenant's Plan\"", "x-displayname": "Feature and its Status for the Tenant's Plan.", "x-ves-proto-message": "ves.io.schema.user.FeatureFlagType", "properties": { "disabled": { "type": "boolean", "description": "X-displayName \"Disabled\"\nstatus of whether this feature should be disabled for current plan.", "title": "disabled", "format": "boolean", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "X-displayName \"Disabled\" status of whether this feature should be disabled for current plan.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the feature.", "title": "feature's name", "x-displayname": "Feature Name.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userFeatureFlagType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userGetTOSResponse": { "type": "object", "description": "GET TOS response model.", "title": "Get TOS response model", "x-displayname": "GET TOS Response.", "x-ves-proto-message": "ves.io.schema.user.GetTOSResponse", "properties": { "text": { "type": "string", "description": "Value of TOS text.", "title": "Text", "x-displayname": "TOS Text", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Value of TOS version.", "title": "Version", "x-displayname": "TOS Version.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userGetTOSResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userGetUserRoleResponse": { "type": "object", "description": "Detailed information about user including role assignments and other details for tenant.", "title": "Get User Detail Response", "x-displayname": "User Detail Response.", "x-ves-oneof-field-managed_access_info": "[\"msp_managed\",\"self_managed\"]", "x-ves-proto-message": "ves.io.schema.user.GetUserRoleResponse", "properties": { "access_type": { "allOf": [ { "$ref": "#/components/schemas/userAccessType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "active_plan_transition_uid": { "type": "string", "description": "UUID of the plan transition request which is currently in progress. This field is empty\nif there is no such request.", "title": "Active plan transition id", "x-displayname": "Active plan transition ID.", "x-f5xc-description-short": "UUID of the plan transition request which is currently in progress. This field is empty if there is no such request.", "x-f5xc-description-medium": "UUID of the plan transition request which is currently in progress. This field is empty if there is no such request.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "addon_service_status": { "type": "object", "description": "Addon service state and access for the user.", "title": "Addon Service Status", "x-displayname": "Addon Service Status.", "x-f5xc-description-short": "Addon service state and access for the user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "billing_flags": { "type": "array", "description": "Collection of flags informing the customer of any billing related problems, such as overdue invoices.", "items": { "$ref": "#/components/schemas/userBillingFeatureIndicator" }, "x-displayname": "Billing flags.", "x-f5xc-description-short": "Collection of flags informing the customer of any billing related problems, such as overdue invoices.", "x-f5xc-description-medium": "Collection of flags informing the customer of any billing related problems, such as overdue invoices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "billing_plan_name": { "type": "string", "description": "Billing plan name of the plan template the tenant is subscribed to (Free plan, Teams Plan, Organization Plan, ...)", "title": "Billing plan name", "x-displayname": "Billing plan name.", "x-ves-example": "Teams Plan.", "x-f5xc-example": "Teams Plan", "x-f5xc-description-short": "Billing plan name of the plan template the tenant is subscribed to (Free plan, Teams Plan, Organization Plan, ...).", "x-f5xc-description-medium": "Billing plan name of the plan template the tenant is subscribed to (Free plan, Teams Plan, Organization Plan, ...).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cname": { "type": "string", "description": "CName via tenant will be accessed from URL. .", "title": "Cname\nx-displayName: \"CName\"\nx-example: \"web\"\nCName via tenant will be accessed from url. .", "x-displayname": "CName", "x-ves-example": "Web", "x-f5xc-example": "web", "x-f5xc-description-short": "CName via tenant will be accessed from URL. ..", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "company": { "type": "string", "description": "Legal name of the company the user/tenant belongs to.", "title": "Company name\nx-displayName: \"Company\"\nx-example: \"Example Corp\"\nLegal name of the company the user/tenant belongs to", "x-displayname": "Company", "x-ves-example": "Example Corp.", "x-f5xc-example": "Example Corp", "x-f5xc-description-short": "Legal name of the company the user/tenant belongs to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creation_timestamp": { "type": "string", "description": "User object creation timestamp.", "title": "Creation Timestamp\nx-displayName: \"Creation Timestamp\"\nUser object creation timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "disabled": { "type": "boolean", "description": "If set to true user is completely disabled including IDM.", "title": "Disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "If set to true user is completely disabled including IDM.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_owner": { "type": "boolean", "description": "Domain owner is the first user who registered or signed up the associated Tenant.\nUser created via signup flow will have this value set to true.\nFew restrictions apply to this user w.r.t role update and deletion.", "title": "Domain Owner", "format": "boolean", "x-displayname": "Domain Owner.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Domain owner is the first user who registered or signed up the associated Tenant.", "x-f5xc-description-medium": "Domain owner is the first user who registered or signed up the associated Tenant. User created via signup flow will have this value set to true. Few restrictions apply to this user w.r.t role update and deletion.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "email": { "type": "string", "description": "Email of the user object.", "title": "Email", "x-displayname": "Email Address.", "x-ves-example": "Value", "x-f5xc-example": "value", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "environment": { "type": "string", "description": "Current global controller deployment environment.", "title": "Environment", "x-displayname": "Environment.", "x-f5xc-description-short": "Current global controller deployment environment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "feature_flags": { "type": "array", "description": "Feature flag that shows whether this feature should be enabled on UI for the current plan.", "title": "Feature flag type", "items": { "$ref": "#/components/schemas/userFeatureFlagType" }, "x-displayname": "Feature Flag Type.", "x-f5xc-example": "True", "x-f5xc-description-short": "Feature flag that shows whether this feature should be enabled on UI for the current plan.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_name": { "type": "string", "description": "First name of the customer.", "title": "First name", "x-displayname": "First Name.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_names": { "type": "array", "description": "Group list must be associated to this user.", "title": "Groups", "items": { "type": "string" }, "x-displayname": "Groups", "x-ves-example": "[\"dev-group-1\"]", "x-f5xc-example": "\"[\"dev-group-1\"]\"", "x-f5xc-description-short": "Group list must be associated to this user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "idm_type": { "allOf": [ { "$ref": "#/components/schemas/userIdmType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_login_timestamp": { "type": "string", "description": "Last login timestamp when user successfully login to access VoltConsole.", "title": "Last login timestamp", "format": "date-time", "x-displayname": "Last login timestamp.", "x-f5xc-description-short": "Last login timestamp when user successfully login to access VoltConsole.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "Last name of the customer.", "title": "Last name", "x-displayname": "Last Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "msp_managed": { "allOf": [ { "$ref": "#/components/schemas/userMSPManaged" } ], "x-f5xc-description-short": "Configuration parameter for msp managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "self_managed" ] }, "name": { "type": "string", "description": "Username of the user.", "title": "Name", "x-displayname": "Username", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of the user object (namespace where the user object is stored).", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Namespace of the user object (namespace where the user object is stored).", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_access": { "allOf": [ { "$ref": "#/components/schemas/schemaNamespaceAccessType" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace_roles": { "type": "array", "description": "Directly attached namespace roles for the user\nThis field is deprecated, refer to namespace_access field for the access of the user.", "title": "Namespace roles", "items": { "$ref": "#/components/schemas/schemaNamespaceRoleType" }, "x-displayname": "Namespace Roles.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Directly attached namespace roles for the user This field is deprecated, refer to namespace_access field for the access of the user.", "x-f5xc-description-medium": "Directly attached namespace roles for the user This field is deprecated, refer to namespace_access field for the access of the user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "original_tenant": { "type": "string", "description": "Returns original tenant ID that the user belongs if request header exist for original tenant else regular tenant ID.", "title": "Original Tenant", "x-displayname": "Original Tenant.", "x-ves-example": "Tenant1", "x-f5xc-example": "tenant1", "x-f5xc-description-short": "Returns original tenant ID that the user belongs if request header exist for original tenant else regular tenant ID.", "x-f5xc-description-medium": "Returns original tenant ID that the user belongs if request header exist for original tenant else regular tenant ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "plan_type": { "allOf": [ { "$ref": "#/components/schemas/schemaPlanType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "self_managed": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for self managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "msp_managed" ] }, "signup_origin": { "allOf": [ { "$ref": "#/components/schemas/schemaSignupOrigin" } ], "x-f5xc-description-short": "Configuration parameter for signup origin.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/userFSMState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaSyncMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "Tenant will represent ID of the tenant that is being accessed.", "title": "Tenant", "x-displayname": "Tenant", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Tenant will represent ID of the tenant that is being accessed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tenant_flags": { "type": "object", "description": "Contains information about tenant configuration for giving UI instructions to show specific sections.", "title": "Tenant Flags", "x-displayname": "Tenant Flags.", "x-f5xc-description-short": "Contains information about tenant configuration for giving UI instructions to show specific sections.", "x-f5xc-description-medium": "Contains information about tenant configuration for giving UI instructions to show specific sections.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_state": { "type": "string", "description": "Contains information about current state of the tenant.", "title": "Tenant State", "x-displayname": "Tenant State.", "x-f5xc-description-short": "Contains information about current state of the tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant_type": { "allOf": [ { "$ref": "#/components/schemas/schemaTenantType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tile_access": { "type": "object", "description": "Primary Navigation Tile access based on Plan and Addon service subscription.", "title": "Tile Access", "x-displayname": "Tile Access.", "x-f5xc-description-short": "Primary Navigation Tile access based on Plan and Addon service subscription.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted": { "type": "string", "description": "Tos accepted version.", "title": "tos_accepted", "x-displayname": "TOS Accepted.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted_at": { "type": "string", "description": "Tos accepted timestamp.", "title": "tos_accepted_at", "format": "date-time", "x-displayname": "TOS Accepted At.", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_current_version": { "type": "string", "description": "Tos current version.", "title": "tos_current_version", "x-displayname": "TOS Current Version.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_version": { "type": "string", "description": "Tos accepted version.", "title": "tos_version", "x-displayname": "TOS Version.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/userUserType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_uuid": { "type": "string", "description": "User UUID of the currently logged in user.", "title": "User UUId", "x-displayname": "User UUID", "x-ves-example": "00000000-0000-4000-8000-8e0133588d70.", "x-f5xc-example": "00000000-0000-4000-8000-8e0133588d70", "x-f5xc-description-short": "User UUID of the currently logged in user.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Detailed information about user including role assignments and other details for tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userGetUserRoleResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userGlobalSpecType": { "type": "object", "title": "GlobalSpecType", "x-displayname": "Global Specification.", "x-ves-proto-message": "ves.io.schema.user.GlobalSpecType", "properties": { "contacts": { "type": "array", "description": "Contact information for user.", "title": "contacts", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Contact", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_owner": { "type": "boolean", "description": "Domain owner is the first user who registered or signed up the associated Tenant.\nUser created via signup flow will have this value set to true.\nFew restrictions apply to this user w.r.t role update and deletion.", "title": "Domain Owner", "format": "boolean", "x-displayname": "Domain Owner.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Domain owner is the first user who registered or signed up the associated Tenant.", "x-f5xc-description-medium": "Domain owner is the first user who registered or signed up the associated Tenant. User created via signup flow will have this value set to true. Few restrictions apply to this user w.r.t role update and deletion.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "email": { "type": "string", "description": "User's email.", "title": "email", "x-displayname": "Email", "x-ves-example": "Value", "x-f5xc-example": "value", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_name": { "type": "string", "description": "User's first name.", "title": "first_name", "x-displayname": "First Name.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "groups": { "type": "array", "description": "Reference to the user groups.", "title": "Groups", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Groups", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "idm_type": { "allOf": [ { "$ref": "#/components/schemas/userIdmType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_login_timestamp": { "type": "string", "description": "Last successful login timestamp of the user.", "title": "last_login_timestamp", "format": "date-time", "x-displayname": "Last Login Timestamp.", "x-f5xc-description-short": "Last successful login timestamp of the user.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "User's last name.", "title": "last_name", "x-displayname": "Last Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locale": { "type": "string", "description": "Locale of the user (defaults to English)", "title": "locale", "x-displayname": "Locale", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Locale of the user (defaults to English).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/userFSMState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaSyncMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted": { "type": "string", "description": "Tos accepted version, this field is deprecated refer the fields `tos_accepted_at` and `tos_version` instead.", "title": "tos_accepted", "x-displayname": "TOS Accepted.", "x-ves-example": "1.0", "x-f5xc-example": "1.0", "x-f5xc-description-short": "Tos accepted version, this field is deprecated refer the fields and instead.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_accepted_at": { "type": "string", "description": "Tos accepted timestamp.", "title": "tos_accepted_at", "format": "date-time", "x-displayname": "TOS Accepted Timestamp.", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tos_version": { "type": "string", "description": "Tos accepted version.", "title": "tos_version", "x-displayname": "TOS version.", "x-ves-example": "V1.0", "x-f5xc-example": "v1.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/userUserType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userGlobalSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userListUserRoleResponse": { "type": "object", "description": "Allows user namespace roles retrieval.", "title": "List user roles", "x-displayname": "List User Roles.", "x-ves-proto-message": "ves.io.schema.user.ListUserRoleResponse", "properties": { "items": { "type": "array", "description": "List of user namespace roles.", "title": "User namespace roles", "items": { "$ref": "#/components/schemas/userListUserRoleResponseItem" }, "x-displayname": "User Namespace Roles.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userListUserRoleResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userListUserRoleResponseItem": { "type": "object", "description": "Allows user namespace role retrieval.", "title": "List user role", "x-displayname": "List User Role.", "x-ves-proto-message": "ves.io.schema.user.ListUserRoleResponseItem", "properties": { "creation_timestamp": { "type": "string", "description": "Timestamp of user creation.", "title": "Creation timestamp", "format": "date-time", "x-displayname": "Creation timestamp.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "disabled": { "type": "boolean", "description": "If set to true user is completely disabled including IDM.", "title": "Disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "If set to true user is completely disabled including IDM.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_owner": { "type": "boolean", "description": "Domain owner is the first user who registered or signed up the associated Tenant.\nUser created via signup flow will have this value set to true.\nFew restrictions apply to this user w.r.t role update and deletion.", "title": "Domain Owner", "format": "boolean", "x-displayname": "Domain Owner.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Domain owner is the first user who registered or signed up the associated Tenant.", "x-f5xc-description-medium": "Domain owner is the first user who registered or signed up the associated Tenant. User created via signup flow will have this value set to true. Few restrictions apply to this user w.r.t role update and deletion.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "email": { "type": "string", "description": "Email of the user object.", "title": "Email", "x-displayname": "Email Address.", "x-ves-example": "Value", "x-f5xc-example": "value", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_name": { "type": "string", "description": "First name of the customer.", "title": "First name", "x-displayname": "First Name.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_names": { "type": "array", "description": "Group list must be associated to this user.", "title": "Groups", "items": { "type": "string" }, "x-displayname": "Groups", "x-ves-example": "[\"dev-group-1\"]", "x-f5xc-example": "\"[\"dev-group-1\"]\"", "x-f5xc-description-short": "Group list must be associated to this user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "idm_type": { "allOf": [ { "$ref": "#/components/schemas/userIdmType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_login_timestamp": { "type": "string", "description": "Last login timestamp when user successfully login to access VoltConsole.", "title": "Last login timestamp", "format": "date-time", "x-displayname": "Last login timestamp.", "x-f5xc-description-short": "Last login timestamp when user successfully login to access VoltConsole.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "Last name of the customer.", "title": "Last name", "x-displayname": "Last Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the user.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of the user object (namespace where the user object is stored).", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "x-f5xc-description-short": "Namespace of the user object (namespace where the user object is stored).", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_roles": { "type": "array", "description": "List of directly attached roles that the user has for each namespace.", "title": "Namespace roles", "items": { "$ref": "#/components/schemas/schemaNamespaceRoleType" }, "x-displayname": "Namespace Roles.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "List of directly attached roles that the user has for each namespace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_enabled": { "type": "boolean", "description": "Shows if OTP is enabled in IDM Provider.", "title": "OTP Enabled", "format": "boolean", "x-displayname": "OTP Enabled.", "x-f5xc-description-short": "Shows if OTP is enabled in IDM Provider.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaSyncMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "Tenant that the user belongs to.", "title": "Tenant", "x-displayname": "Tenant", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tenant_type": { "allOf": [ { "$ref": "#/components/schemas/schemaTenantType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/userUserType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userListUserRoleResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userMSPManaged": { "type": "object", "description": "MSP information for tenant.", "title": "MSP Managed", "x-displayname": "MSP Managed.", "x-ves-proto-message": "ves.io.schema.user.MSPManaged", "properties": { "msp_id": { "type": "string", "description": "Msp ID for the tenant.", "title": "msp_id", "x-displayname": "Msp_id", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "node_type": { "allOf": [ { "$ref": "#/components/schemas/userMSPNodeType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "parent_tenant_id": { "type": "string", "description": "Hold parent tenant ID.", "title": "Parent Tenant ID", "x-displayname": "Parent Tenant ID.", "x-ves-example": "F5 Distributed Cloud-abc.", "x-f5xc-example": "F5 Distributed Cloud-abc", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "tier": { "type": "integer", "description": "Tier of tenant in MSP tree.", "title": "tier", "format": "int64", "x-displayname": "Tier", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userMSPManaged", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userMSPNodeType": { "type": "string", "description": "Managed services node type. This is used to determine if the tenant is a parent or a child or not set at all.\n\n- MspNodeTypeUnknown: MspUnknown\n\nManaged services status is unknown or not set\n- MspNodeTypeChild: MspChild\n\nTenant acts as a child for another tenant. In other words, the tenant has a parent tenant that is managing it.\n- MspNodeTypeParent: MspParent\n\nTenant acts as a parent for another tenant(s). In other words, the tenant has child tenants that are managed by it.", "title": "Managed services node type", "enum": [ "MspNodeTypeUnknown", "MspNodeTypeChild", "MspNodeTypeParent" ], "default": "MspNodeTypeUnknown", "x-displayname": "Managed services node type.", "x-ves-proto-enum": "ves.io.schema.user.MSPNodeType", "x-f5xc-description-medium": "Managed services node type. This is used to determine if the tenant is a parent or a child or not set at all. - MspNodeTypeUnknown: MspUnknown Managed services status is unknown or not set - MspNodeTypeChild: MspChild Tenant acts as a child for another tenant. In other words, the tenant has a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userMSPNodeType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"MspNodeTypeUnknown\"", "example_yaml": "MspNodeTypeUnknown\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userNamespacesRoleType": { "type": "object", "description": "Association of a role to namespaces.", "title": "Namespace Role Type", "x-displayname": "Namespace Role Type.", "x-ves-proto-message": "ves.io.schema.user.NamespacesRoleType", "properties": { "namespaces": { "type": "array", "description": "Namespace, including star (`*`) which means all tenant's namespaces.", "title": "Namespaces", "items": { "type": "string" }, "x-displayname": "Namespaces.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Namespace, including star () which means all tenant's namespaces.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "role": { "type": "string", "description": "Users role for this namespace.", "title": "Role", "x-displayname": "Role", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userNamespacesRoleType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userObject": { "type": "object", "description": "User object.", "title": "User", "x-displayname": "Object", "x-ves-proto-message": "ves.io.schema.user.Object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/userSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectMetaType__ves_io_schema_api_credential" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userResetPasswordByAdminRequest": { "type": "object", "description": "Reset password by admin request contains email of user for which password will be reset.", "title": "Reset password by admin request", "x-displayname": "Reset password by admin request.", "x-ves-proto-message": "ves.io.schema.user.ResetPasswordByAdminRequest", "properties": { "email": { "type": "string", "description": "Email of user for which password will be reset.", "title": "Email", "x-displayname": "Email", "x-ves-example": "John@example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "john@example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Email of user for which password will be reset.", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Reset password by admin request contains email of user for which password will be reset.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userResetPasswordByAdminRequest", "required_fields": [ "email" ], "mutually_exclusive_groups": [], "example_json": "{\n \"email\": \"john@example.com\"\n}", "example_yaml": "email: john@example.com" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userSendPasswordEmailRequest": { "type": "object", "description": "SendPasswordEmailRequest is the request parameters for sending the password update.\nNote that only admin is allowed to resend the password for users.", "title": "Send password email request", "x-displayname": "Send Password Email Request.", "x-ves-proto-message": "ves.io.schema.user.SendPasswordEmailRequest", "properties": { "email": { "type": "string", "description": "Email of the user requesting for.", "title": "email of the user", "x-displayname": "Email", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Value of namespace is always \"system\"", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "SendPasswordEmailRequest is the request parameters for sending the password update.", "x-f5xc-description-medium": "SendPasswordEmailRequest is the request parameters for sending the password update. Note that only admin is allowed to resend the password for users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userSendPasswordEmailRequest", "required_fields": [ "email" ], "mutually_exclusive_groups": [], "example_json": "{\n \"email\": \"value\"\n}", "example_yaml": "email: value" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userSendPasswordEmailResponse": { "type": "object", "description": "SendPasswordEmailResponse is an empty response after an email had been sent.", "title": "Send password email response", "x-displayname": "Send Password Email Response.", "x-ves-proto-message": "ves.io.schema.user.SendPasswordEmailResponse", "x-f5xc-description-short": "SendPasswordEmailResponse is an empty response after an email had been sent.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userSendPasswordEmailResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userSpecType": { "type": "object", "description": "Shape of the User specification.", "title": "Specification for User object", "x-displayname": "Specification.", "x-ves-proto-message": "ves.io.schema.user.SpecType", "properties": { "gc_spec": { "allOf": [ { "$ref": "#/components/schemas/userGlobalSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userUserGroupRequest": { "type": "object", "description": "Used for adding or removing specific user to/from group.", "title": "User group request", "x-displayname": "User group request.", "x-ves-proto-message": "ves.io.schema.user.UserGroupRequest", "properties": { "group_names": { "type": "array", "description": "Group list must be associated to this user.", "title": "Groups", "items": { "type": "string" }, "x-displayname": "Groups", "x-ves-example": "[\"dev-group-1\"]", "x-f5xc-example": "\"[\"dev-group-1\"]\"", "x-f5xc-description-short": "Group list must be associated to this user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "username": { "type": "string", "description": "Username of the user who should be associated with the group.", "title": "Username", "minLength": 1, "maxLength": 320, "x-displayname": "Username", "x-ves-example": "Dana@example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "320", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "320", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Username of the user who should be associated with the group.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 320, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 320, "min": 1 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Used for adding or removing specific user to/from group.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userUserGroupRequest", "required_fields": [ "username" ], "mutually_exclusive_groups": [], "example_json": "{\n \"username\": \"dana@example.com\"\n}", "example_yaml": "username: dana@example.com" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userUserGroupResponse": { "type": "object", "title": "User Group Response", "x-displayname": "User Group Response.", "x-ves-proto-message": "ves.io.schema.user.UserGroupResponse", "properties": { "error": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userUserGroupResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "userUserRoleRequest": { "type": "object", "description": "Allows creation of a user along with their roles in namespaces.", "title": "User role", "x-displayname": "User Role", "x-ves-proto-message": "ves.io.schema.user.UserRoleRequest", "properties": { "email": { "type": "string", "description": "User's email.", "title": "email", "x-displayname": "Email Address.", "x-ves-example": "Dana@example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "first_name": { "type": "string", "description": "User's first name.", "title": "first name", "x-displayname": "First Name.", "x-ves-example": "Dan", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Dan", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "group_names": { "type": "array", "description": "Group list must be associated to this user.", "title": "Groups", "items": { "type": "string" }, "x-displayname": "Groups", "x-ves-example": "[\"dev-group-1\"]", "x-f5xc-example": "\"[\"dev-group-1\"]\"", "x-f5xc-description-short": "Group list must be associated to this user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "idm_type": { "allOf": [ { "$ref": "#/components/schemas/userIdmType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "User's last name.", "title": "last name", "x-displayname": "Last Name", "x-ves-example": "Brown", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Brown", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "name": { "type": "string", "description": "This is an optional field meant to be used as username.\nInside F5 Distributed Cloud's UAM, email is already treated as user's username\nand as best practice, recommendation is to keep this same as email field.\nIf not specified, this field will be set same as email field.", "title": "Username", "x-displayname": "Username", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "x-f5xc-description-short": "Optional field meant to be used as username.", "x-f5xc-description-medium": "Optional field meant to be used as username. Inside F5 Distributed Cloud's UAM, email is already treated as user's username and as best practice, recommendation is to keep this same as email field. If not specified, this field will be set same as email field.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "All users of a tenant must be created in tenant's system namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.const": "system" }, "x-f5xc-description-short": "All users of a tenant must be created in tenant's system namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_roles": { "type": "array", "description": "List of directly attached roles that the user has for each namespace.", "title": "Namespace roles", "items": { "$ref": "#/components/schemas/schemaNamespaceRoleType" }, "x-displayname": "Namespace Roles.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "List of directly attached roles that the user has for each namespace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/userUserType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Allows creation of a user along with their roles in namespaces.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for userUserRoleRequest", "required_fields": [ "email", "first_name", "last_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"email\": \"dana@example.com\",\n \"first_name\": \"Dan\",\n \"last_name\": \"Brown\"\n}", "example_yaml": "email: dana@example.com\nfirst_name: Dan\nlast_name: Brown" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "schemauser_groupEmpty": { "type": "object", "description": "Data for empty response.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.user_group.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemauser_groupEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupAnalyzeForDeletionRequest": { "type": "object", "description": "Analyze For Deletion Request.\n\nAnalyzeForDeletionRequest is for the checking whether the object is deletable by going through it's references in other objects.", "x-displayname": "AnalyzeForDeletionRequest.", "x-ves-oneof-field-object_identifier": "[\"namespace_name_identifier\",\"object_uid\"]", "x-ves-proto-message": "ves.io.schema.user_group.AnalyzeForDeletionRequest", "properties": { "namespace_name_identifier": { "allOf": [ { "$ref": "#/components/schemas/user_groupNamespaceNameIdentifier" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "object_uid" ] }, "object_uid": { "type": "string", "description": "Exclusive with [namespace_name_identifier]\nUid of the specific object.", "title": "Uid of the object", "x-displayname": "Uid", "x-ves-example": "00000000-0000-4000-8000-399945a7d658.", "x-f5xc-example": "00000000-0000-4000-8000-399945a7d658", "x-f5xc-description-short": "Exclusive with [namespace_name_identifier] Uid of the specific object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "namespace_name_identifier" ] } }, "x-f5xc-description-medium": "Analyze For Deletion Request. AnalyzeForDeletionRequest is for the checking whether the object is deletable by going through it's references in other objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupAnalyzeForDeletionRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupAnalyzeForDeletionResponse": { "type": "object", "description": "Response holds the references of the object and also talks about the object is deletable or not.", "title": "Analyze For Deletion Response", "x-displayname": "Analyze For Deletion Response.", "x-ves-proto-message": "ves.io.schema.user_group.AnalyzeForDeletionResponse", "properties": { "back_referencing_items": { "type": "object", "description": "BackReferencingItems holds the details of the objects which are referencing the deletion candidate.", "title": "BackReferencingItems", "x-displayname": "BackReferencingItems.", "x-f5xc-description-short": "BackReferencingItems holds the details of the objects which are referencing the deletion candidate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deletion_analysis": { "allOf": [ { "$ref": "#/components/schemas/user_groupDeletionAnalysis" } ], "x-f5xc-description-short": "Configuration parameter for deletion analysis.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referenced_items": { "type": "object", "description": "ReferencedItems holds the details of the objects which are referenced in the deletion candidate.", "title": "ReferencedItems", "x-displayname": "ReferencedItems.", "x-f5xc-description-short": "ReferencedItems holds the details of the objects which are referenced in the deletion candidate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response holds the references of the object and also talks about the object is deletable or not.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupAnalyzeForDeletionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupDeletionAnalysis": { "type": "string", "description": "DeletionAnalysis holds the reasons for allowing, warning or blocking a object deletion.\n\n- Unknown: Unknown\n\nUnknown factor\n- Deletable: Deletable\n\nDeletable indicates there are no references for the object, so it is safe for deletion\n- Internal: Internal\n\nDeletion is blocked because the object is used for internal usage.\nSuch objects cannot be deleted.\n- ReferencesAutoRemovable: ReferencesAutoRemovable\n\nThis means there are some references which can be removed and\nmake the object safe for deletion without manual intervention\n- ReferencesRemovable: ReferencesRemovable\n\nThis means there are some references which can be removed with\nmanual intervention to make the object safe for deletion\n- ReferencesNonRemovable: ReferencesNonRemovable\n\nReferencesNonRemovable means there are references which cannot be removed,\nso the object cannot be deleted.", "title": "DeletionAnalysis", "enum": [ "Unknown", "Deletable", "Internal", "ReferencesAutoRemovable", "ReferencesRemovable", "ReferencesNonRemovable" ], "default": "Unknown", "x-displayname": "DeletionAnalysis.", "x-ves-proto-enum": "ves.io.schema.user_group.DeletionAnalysis", "x-f5xc-description-short": "DeletionAnalysis holds the reasons for allowing, warning or blocking a object deletion. - Unknown: Unknown Unknown factor - Deletable: Deletable...", "x-f5xc-description-medium": "DeletionAnalysis holds the reasons for allowing, warning or blocking a object deletion. - Unknown: Unknown Unknown factor - Deletable: Deletable Deletable indicates there are no references for the object, so it is safe for deletion - Internal: Internal Deletion is blocked because the object is...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupDeletionAnalysis", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"Unknown\"", "example_yaml": "Unknown\n..." }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read user_group", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.user_group.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/user_groupGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/user_groupStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupGetSpecType": { "type": "object", "title": "GetSpecType", "x-displayname": "GET User Group.", "x-ves-proto-message": "ves.io.schema.user_group.GetSpecType", "properties": { "display_name": { "type": "string", "description": "Name of the user group.", "maxLength": 320, "x-displayname": "DisplayName.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "320" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "320" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 320, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of user_group", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.user_group.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/user_groupListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupListResponseItem": { "type": "object", "description": "By default a summary of user_group is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of user_group", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.user_group.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this user_group.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this user_group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this user_group.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this user_group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates user_group is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates user_group is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/user_groupGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this user_group.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this user_group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this user_group.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/user_groupStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this user_group.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of user_group is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of user_group is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupListUserGroupsResponse": { "type": "object", "description": "Response for receiving all existing group created for the tenant.", "title": "List User Groups", "x-displayname": "List User Groups.", "x-ves-proto-message": "ves.io.schema.user_group.ListUserGroupsResponse", "properties": { "user_groups": { "type": "array", "description": "List of the user groups.", "title": "User Groups", "items": { "$ref": "#/components/schemas/user_groupUserGroupResponse" }, "x-displayname": "User Groups.", "x-ves-example": "UserGroupList.", "x-f5xc-example": "UserGroupList", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for receiving all existing group created for the tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupListUserGroupsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupModifyRoleRequest": { "type": "object", "description": "Roles of the specific group to be modified.", "title": "Modify roles of the user group", "x-displayname": "Modify Role Request.", "x-ves-proto-message": "ves.io.schema.user_group.ModifyRoleRequest", "properties": { "name": { "type": "string", "description": "Name of the specific group.", "title": "Name of the user group", "x-displayname": "Name", "x-ves-example": "00000000-0000-4000-8000-6a2fe61e3db8.", "x-f5xc-example": "00000000-0000-4000-8000-6a2fe61e3db8", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_roles": { "type": "array", "description": "Roles of the specific group to be modified.", "title": "Namespace Roles", "items": { "$ref": "#/components/schemas/schemaNamespaceRoleType" }, "x-displayname": "Namespace Roles.", "x-ves-example": "[{NamespaceRoleType: ...}]", "x-f5xc-example": "[{NamespaceRoleType...}]", "x-f5xc-description-short": "Roles of the specific group to be modified.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Roles of the specific group to be modified.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupModifyRoleRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupNamespaceNameIdentifier": { "type": "object", "description": "NamespaceNameIdentifier holds the name and namespace of the specific object.", "title": "Namespace-Name Identifier", "x-displayname": "NamespaceNameIdentifier.", "x-ves-proto-message": "ves.io.schema.user_group.NamespaceNameIdentifier", "properties": { "object_name": { "type": "string", "description": "Name of the specific object.", "title": "ObjectName", "minLength": 1, "x-displayname": "ObjectName.", "x-ves-example": "F5xc-group.", "x-ves-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "f5xc-group", "x-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "object_namespace": { "type": "string", "description": "Namespace of the specific object.", "title": "ObjectNamespace of the object", "minLength": 1, "x-displayname": "ObjectNamespace.", "x-ves-example": "System", "x-ves-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "NamespaceNameIdentifier holds the name and namespace of the specific object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupNamespaceNameIdentifier", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for User object", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.user_group.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupUserGroupRequest": { "type": "object", "description": "Request to create/update user group with user assignment to it.", "title": "User Group Request", "x-displayname": "Create/Replace User Group With Users.", "x-ves-proto-message": "ves.io.schema.user_group.UserGroupRequest", "properties": { "description": { "type": "string", "description": "The description set for this user_group.", "title": "description", "x-displayname": "Description.", "x-ves-example": "User group - Group1.", "x-f5xc-example": "User group - Group1", "x-f5xc-description-short": "The description set for this user_group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "display_name": { "type": "string", "description": "Display name of the group used as well for scim sync.", "title": "Display Name", "x-displayname": "Display Name.", "x-ves-example": "Sales", "x-f5xc-example": "Sales", "x-f5xc-description-short": "Display name of the group used as well for scim sync.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "display", "maxLength": 1024, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Internal name of the group.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Sales", "x-f5xc-example": "sales", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_roles": { "type": "array", "description": "List of roles that the user group has for each namespace.", "title": "Namespace roles", "items": { "$ref": "#/components/schemas/schemaNamespaceRoleType" }, "x-displayname": "Namespace Roles.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "List of roles that the user group has for each namespace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_id": { "type": "string", "description": "Sync ID of the user group.", "title": "Sync Id", "x-displayname": "Sync ID", "x-ves-example": "External-sync-ID-anfjadh.", "x-f5xc-example": "external-sync-id-anfjadh", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "usernames": { "type": "array", "description": "List of the users enumerated by name.", "title": "Usernames", "items": { "type": "string" }, "x-displayname": "Usernames", "x-ves-example": "[\"dana@example.com\", \"dana@example.com\"]", "x-f5xc-example": "\"[\"dana@example.com\", \"dana@example.com\"]\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to create/update user group with user assignment to it.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupUserGroupRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_groupUserGroupResponse": { "type": "object", "description": "Response which return the created user group with the list of the users.", "title": "Create User Group Response", "x-displayname": "Create User Group Response.", "x-ves-proto-message": "ves.io.schema.user_group.UserGroupResponse", "properties": { "description": { "type": "string", "description": "The description set for this user_group.", "title": "description", "x-displayname": "Description.", "x-ves-example": "User group - Group1.", "x-f5xc-example": "User group - Group1", "x-f5xc-description-short": "The description set for this user_group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "display_name": { "type": "string", "description": "Display name of the group used as well for scim sync.", "title": "Display Name", "x-displayname": "Display Name.", "x-ves-example": "Sales", "x-f5xc-example": "Sales", "x-f5xc-description-short": "Display name of the group used as well for scim sync.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "display", "maxLength": 1024, "minLength": 1, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "Internal ID of the group.", "title": "Id", "x-displayname": "ID", "x-ves-example": "00000000-0000-4000-8000-e6a6261463c8.", "x-f5xc-example": "00000000-0000-4000-8000-e6a6261463c8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Internal name of the group.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Sales", "x-f5xc-example": "sales", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace_roles": { "type": "array", "description": "List of namespace,roles for the user group.", "title": "Namespace roles", "items": { "$ref": "#/components/schemas/schemaNamespaceRoleType" }, "x-displayname": "Namespace Roles.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "List of namespace,roles for the user group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "references_count": { "type": "object", "description": "The map holds the count of references which needs to be shown in the group list.", "title": "Reference Count", "x-displayname": "Reference Count.", "x-ves-example": "{\"VES.I/o.schema.tenant_management.child_tenant_manager.object\": 3}", "x-f5xc-example": "\"{\"ves.io.schema.tenant_management.child_tenant_manager.object\"3}\"", "x-f5xc-description-short": "The map holds the count of references which needs to be shown in the group list.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_id": { "type": "string", "description": "Sync ID of the user group.", "title": "Sync Id", "x-displayname": "Sync ID", "x-ves-example": "External-sync-ID-anfjadh.", "x-f5xc-example": "external-sync-id-anfjadh", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "sync_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaSyncMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uid": { "type": "string", "description": "Internal uid of the group.", "title": "UID", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-e6a6261463c8.", "x-f5xc-example": "00000000-0000-4000-8000-e6a6261463c8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "usernames": { "type": "array", "description": "List of the users in the group.", "title": "Usernames", "items": { "type": "string" }, "x-displayname": "Usernames", "x-ves-example": "[dana@example.com, dana@example.com...]", "x-f5xc-example": "[dana@example.com, dana@example.com...]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response which return the created user group with the list of the users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_groupUserGroupResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_identificationCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of user_identification", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.user_identification.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/user_identificationCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "User identification rules for bot defense and rate limiting", "required_fields": [ "metadata.name", "metadata.namespace", "spec.rules" ], "mutually_exclusive_groups": [], "example_yaml": "apiVersion: v1\nkind: user_identification\nmetadata:\n name: example-user-id\n namespace: default\nspec:\n rules:\n - client_ip: {}\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example-user-id\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"rules\": [{\"client_ip\": {}}]\n }\n}\n" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.user_identification.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/user_identificationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationCreateSpecType": { "type": "object", "description": "Create user_identification creates a new object in the storage backend for metadata.namespace.", "title": "Create user identification", "x-displayname": "Create User Identification.", "x-ves-proto-message": "ves.io.schema.user_identification.CreateSpecType", "properties": { "rules": { "type": "array", "description": "An ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.\nEvaluation of the rules is terminated once a user identifier has been extracted.", "minItems": 1, "maxItems": 4, "items": { "$ref": "#/components/schemas/user_identificationUserIdentificationRule" }, "x-displayname": "User Identification Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.", "x-f5xc-description-medium": "Ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier. Evaluation of the rules is terminated once a user identifier has been extracted.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Create user_identification creates a new object in the storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationCreateSpecType", "required_fields": [ "rules" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rules\": [\n {}\n ]\n}", "example_yaml": "rules:\n- {}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-recommended-oneof-variant": { "identification_type": "client_ip" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a user_identification", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.user_identification.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read user_identification", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.user_identification.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/user_identificationCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/user_identificationReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/user_identificationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/user_identificationStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationGetSpecType": { "type": "object", "description": "GET user_identification reads a given object from storage backend for metadata.namespace.", "title": "Get user identification", "x-displayname": "GET User Identification.", "x-ves-proto-message": "ves.io.schema.user_identification.GetSpecType", "properties": { "rules": { "type": "array", "description": "An ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.\nEvaluation of the rules is terminated once a user identifier has been extracted.", "minItems": 1, "maxItems": 4, "items": { "$ref": "#/components/schemas/user_identificationUserIdentificationRule" }, "x-displayname": "User Identification Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.", "x-f5xc-description-medium": "Ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier. Evaluation of the rules is terminated once a user identifier has been extracted.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "GET user_identification reads a given object from storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationGetSpecType", "required_fields": [ "rules" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rules\": [\n {}\n ]\n}", "example_yaml": "rules:\n- {}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-recommended-oneof-variant": { "identification_type": "client_ip" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of user_identification", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.user_identification.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/user_identificationListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationListResponseItem": { "type": "object", "description": "By default a summary of user_identification is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of user_identification", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.user_identification.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this user_identification.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this user_identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this user_identification.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this user_identification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates user_identification is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates user_identification is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/user_identificationGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this user_identification.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this user_identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this user_identification.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/user_identificationStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this user_identification.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this user_identification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of user_identification is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of user_identification is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a user_identification", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.user_identification.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/user_identificationReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "User identification rules for bot defense and rate limiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.user_identification.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationReplaceSpecType": { "type": "object", "description": "Replace user_identification replaces an existing object in the storage backend for metadata.namespace.", "title": "Replace user identification", "x-displayname": "Replace User Identification.", "x-ves-proto-message": "ves.io.schema.user_identification.ReplaceSpecType", "properties": { "rules": { "type": "array", "description": "An ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.\nEvaluation of the rules is terminated once a user identifier has been extracted.", "minItems": 1, "maxItems": 4, "items": { "$ref": "#/components/schemas/user_identificationUserIdentificationRule" }, "x-displayname": "User Identification Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.", "x-f5xc-description-medium": "Ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier. Evaluation of the rules is terminated once a user identifier has been extracted.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Replace user_identification replaces an existing object in the storage backend for metadata.namespace.", "x-f5xc-description-medium": "Replace user_identification replaces an existing object in the storage backend for metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationReplaceSpecType", "required_fields": [ "rules" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rules\": [\n {}\n ]\n}", "example_yaml": "rules:\n- {}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-recommended-oneof-variant": { "identification_type": "client_ip" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of user identification", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.user_identification.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "user_identificationUserIdentificationRule": { "type": "object", "description": "A user identification rule specifies a single criterion to determine an identifier from the input fields extracted from an API request . A rule is considered\nto have a successful outcome if an identifier gets extracted.", "title": "UserIdentificationRule", "x-displayname": "User Identification Rule.", "x-ves-oneof-field-identifier": "[\"client_asn\",\"client_city\",\"client_country\",\"client_ip\",\"client_region\",\"cookie_name\",\"http_header_name\",\"ip_and_http_header_name\",\"ip_and_ja4_tls_fingerprint\",\"ip_and_tls_fingerprint\",\"ja4_tls_fingerprint\",\"jwt_claim_name\",\"none\",\"query_param_key\",\"tls_fingerprint\"]", "x-ves-proto-message": "ves.io.schema.user_identification.UserIdentificationRule", "properties": { "client_asn": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "client_city": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "client_country": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "client_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "client_region": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "cookie_name": { "type": "string", "description": "Exclusive with [client_asn client_city client_country client_ip client_region http_header_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none query_param_key tls_fingerprint]\nUse the HTTP cookie value for the given name as user identifier.", "title": "Cookie Name", "minLength": 1, "maxLength": 256, "x-displayname": "Cookie Name.", "x-ves-example": "Session", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "Session", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Exclusive with [client_asn client_city client_country client_ip client_region http_header_name ip_and_http_header_name ip_and_ja4_tls_fingerprint...", "x-f5xc-description-medium": "Exclusive with [client_asn client_city client_country client_ip client_region http_header_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none query_param_key tls_fingerprint] Use the HTTP cookie value for the given name as user...", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "byteLength": { "max": 256, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "http_header_name": { "type": "string", "description": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none query_param_key tls_fingerprint]\nUse the HTTP header value for the given name as user identifier.", "title": "HTTP header name", "minLength": 1, "maxLength": 256, "x-displayname": "HTTP Header Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name ip_and_http_header_name ip_and_ja4_tls_fingerprint...", "x-f5xc-description-medium": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none query_param_key tls_fingerprint] Use the HTTP header value for the given name as user...", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "byteLength": { "max": 256, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "ip_and_http_header_name": { "type": "string", "description": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none query_param_key tls_fingerprint]\nName of HTTP header from which the value should be extracted.", "title": "HTTP header name", "minLength": 1, "maxLength": 256, "x-displayname": "HTTP Header Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_ja4_tls_fingerprint...", "x-f5xc-description-medium": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none query_param_key tls_fingerprint] Name of HTTP header from which the value should be extracted.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "byteLength": { "max": 256, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "ip_and_ja4_tls_fingerprint": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "ip_and_tls_fingerprint": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "ja4_tls_fingerprint": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for ja4 tls fingerprint.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "jwt_claim_name", "none", "query_param_key", "tls_fingerprint" ] }, "jwt_claim_name": { "type": "string", "description": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint none query_param_key tls_fingerprint]\nUse the JWT claim value as user identifier.", "title": "JWT claim name", "minLength": 1, "maxLength": 256, "x-displayname": "JWT Claim Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_http_header_name...", "x-f5xc-description-medium": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint none query_param_key tls_fingerprint] Use the JWT claim value as user identifier.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "byteLength": { "max": 256, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "none", "query_param_key", "tls_fingerprint" ] }, "none": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "query_param_key", "tls_fingerprint" ] }, "query_param_key": { "type": "string", "description": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none tls_fingerprint]\nUse the query parameter value for the given key as user identifier.", "title": "query param key", "minLength": 1, "maxLength": 256, "x-displayname": "Query Parameter Key.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_http_header_name...", "x-f5xc-description-medium": "Exclusive with [client_asn client_city client_country client_ip client_region cookie_name http_header_name ip_and_http_header_name ip_and_ja4_tls_fingerprint ip_and_tls_fingerprint ja4_tls_fingerprint jwt_claim_name none tls_fingerprint] Use the query parameter value for the given key as user...", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "byteLength": { "max": 256, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "tls_fingerprint" ] }, "tls_fingerprint": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for tls fingerprint.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "client_asn", "client_city", "client_country", "client_ip", "client_region", "cookie_name", "http_header_name", "ip_and_http_header_name", "ip_and_ja4_tls_fingerprint", "ip_and_tls_fingerprint", "ja4_tls_fingerprint", "jwt_claim_name", "none", "query_param_key" ] } }, "x-f5xc-description-short": "User identification rule specifies a single criterion to determine an identifier from the input fields extracted from an API request .", "x-f5xc-description-medium": "User identification rule specifies a single criterion to determine an identifier from the input fields extracted from an API request . A rule is considered to have a successful outcome if an identifier gets extracted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_identificationUserIdentificationRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "User identification should be consistent across namespaces" }, "classification": { "category": "security", "multi_tenant_pattern": "shared-ref" } } }, "settingInitialAccess": { "type": "object", "description": "User console view preferences.", "title": "Initial access", "x-displayname": "Initial access.", "x-ves-proto-message": "ves.io.schema.user.setting.InitialAccess", "properties": { "email_sent": { "type": "boolean", "description": "Boolean flag which shows whether email has been sent or not.", "title": "EmailSent", "format": "boolean", "x-displayname": "EmailSent", "x-f5xc-description-short": "Boolean flag which shows whether email has been sent or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_requesting_time": { "type": "string", "description": "If initial access was requested at least once, last_requesting_time contains last time when it happened.", "title": "Last requesting time", "format": "date-time", "x-displayname": "Last requesting time.", "x-f5xc-description-short": "If initial access was requested at least once, last_requesting_time contains last time when it happened.", "x-f5xc-description-medium": "If initial access was requested at least once, last_requesting_time contains last time when it happened.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "requested": { "type": "boolean", "description": "Boolean flag which shows whether initial access was requested or not.", "title": "Requested", "format": "boolean", "x-displayname": "Requested", "x-f5xc-description-short": "Boolean flag which shows whether initial access was requested or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingInitialAccess", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingNotification": { "type": "object", "description": "Definition of existing notifications created for subscription.", "title": "Notification", "x-displayname": "Notification.", "x-ves-proto-message": "ves.io.schema.user.setting.Notification", "properties": { "code": { "type": "string", "description": "Code of notification.", "title": "Code", "x-displayname": "Code", "x-ves-example": "Notif-1", "x-f5xc-example": "notif-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Description text of the notification.", "title": "Notification", "x-displayname": "Notification.", "x-ves-example": "Something to notify of.", "x-f5xc-example": "Something to notify of", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "enabled": { "type": "boolean", "description": "Is it enabled.", "title": "Enabled", "format": "boolean", "x-displayname": "Enabled", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "label": { "type": "string", "description": "Public label of the notification.", "title": "Label", "x-displayname": "Label", "x-ves-example": "Notification 1.", "x-f5xc-example": "Notification 1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "labeling", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Definition of existing notifications created for subscription.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingNotification", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingNotificationList": { "type": "object", "description": "List of notifications.", "title": "NotificationList", "x-displayname": "NotificationList.", "x-ves-proto-message": "ves.io.schema.user.setting.NotificationList", "properties": { "notifications": { "type": "array", "description": "List of notifications.", "title": "Notifications", "items": { "$ref": "#/components/schemas/settingNotification" }, "x-displayname": "Notifications.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingNotificationList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingNtfnPreferencesMap": { "type": "object", "description": "Notification preferences information.", "title": "Notification preferences", "x-displayname": "Notification preferences.", "x-ves-proto-message": "ves.io.schema.user.setting.NtfnPreferencesMap", "properties": { "ntfn_preferences_map": { "type": "object", "description": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.", "title": "Ntfn preferences map", "x-displayname": "Ntfn preferences map.", "x-ves-example": "['notif-1':false]", "x-f5xc-example": "['notif-1':false]", "x-f5xc-description-short": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.", "x-f5xc-description-medium": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingNtfnPreferencesMap", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingNtfnToUnset": { "type": "object", "description": "Notification to unset.", "title": "Notification unset", "x-displayname": "Notification unset.", "x-ves-proto-message": "ves.io.schema.user.setting.NtfnToUnset", "properties": { "ntfn_to_unset": { "type": "string", "description": "Ntfn to unset contains notification which should be unset for particular user.", "title": "Ntfn to unset", "x-displayname": "Ntfn to unset.", "x-ves-example": "Notif-1", "x-f5xc-example": "notif-1", "x-f5xc-description-short": "Ntfn to unset contains notification which should be unset for particular user.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingNtfnToUnset", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingPersonaPreferences": { "type": "object", "description": "Preferences to display appropriate content to appropriate audience.", "title": "Persona type", "x-displayname": "Persona type.", "x-ves-proto-message": "ves.io.schema.user.setting.PersonaPreferences", "properties": { "billing": { "type": "boolean", "description": "Audience is a billing admin.", "title": "Billing", "format": "boolean", "x-displayname": "Billing", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dev_ops": { "type": "boolean", "description": "Audience is DevOps.", "title": "DevOps", "format": "boolean", "x-displayname": "DevOps", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "developer": { "type": "boolean", "description": "Audience is a developer.", "title": "Developer", "format": "boolean", "x-displayname": "Developer", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "master": { "type": "boolean", "description": "Audience is an admin.", "title": "Admin", "format": "boolean", "x-displayname": "Admin", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "net_ops": { "type": "boolean", "description": "Audience is NetOps.", "title": "NetOps", "format": "boolean", "x-displayname": "NetOps", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sec_ops": { "type": "boolean", "description": "Audience is SecOps.", "title": "SecOps", "format": "boolean", "x-displayname": "SecOps", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Preferences to display appropriate content to appropriate audience.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingPersonaPreferences", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingSetViewPreferenceRequest": { "type": "object", "description": "User console view preferences.", "title": "View preference", "x-displayname": "View preference.", "x-ves-proto-message": "ves.io.schema.user.setting.SetViewPreferenceRequest", "properties": { "advanced_view": { "type": "boolean", "description": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed.", "title": "Advanced view", "format": "boolean", "x-displayname": "Advanced view.", "x-f5xc-description-short": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "persona_preferences": { "allOf": [ { "$ref": "#/components/schemas/settingPersonaPreferences" } ], "x-f5xc-description-short": "Configuration parameter for persona preferences.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "wizard_advanced_auto_expand": { "type": "boolean", "description": "If true then all advanced configuration fields are automatically expanded when creating a new object.", "title": "Advanced fields auto-expand", "format": "boolean", "x-displayname": "Advanced fields auto-expand.", "x-f5xc-description-short": "If true then all advanced configuration fields are automatically expanded when creating a new object.", "x-f5xc-description-medium": "If true then all advanced configuration fields are automatically expanded when creating a new object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingSetViewPreferenceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingUpdateImageRequest": { "type": "object", "description": "Message contains data for updating user profile image.", "title": "UpdateImageRequest", "x-displayname": "UpdateImageRequest.", "x-ves-proto-message": "ves.io.schema.user.setting.UpdateImageRequest", "properties": { "content_type": { "type": "string", "description": "Type of uploading image.", "x-displayname": "ContentType.", "x-ves-example": "Image/jpeg.", "x-f5xc-example": "image/jpeg", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "description": "Blob of the user profile image.", "format": "byte", "x-displayname": "Image", "x-ves-example": "DXNlci1pbWFnZS5qcGVn.", "x-f5xc-example": "dXNlci1pbWFnZS5qcGVn", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Message contains data for updating user profile image.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingUpdateImageRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingUserEmail": { "type": "object", "description": "Email", "title": "Email", "x-displayname": "Email", "x-ves-proto-message": "ves.io.schema.user.setting.UserEmail", "properties": { "user_email": { "type": "string", "description": "Configuration parameter for user email", "title": "Email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingUserEmail", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingUserSession": { "type": "object", "description": "UserSession contains information about active user's sessions in IAM.", "title": "UserSession", "x-displayname": "UserSession.", "x-ves-proto-message": "ves.io.schema.user.setting.UserSession", "properties": { "ip_address": { "type": "string", "description": "IPAddress from which session was initialized.", "title": "IPAddress", "x-displayname": "IPAddress", "x-ves-example": "192.0.2.19.", "x-f5xc-example": "192.0.2.19", "x-f5xc-description-short": "IPAddress from which session was initialized.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "ipv4", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_access": { "type": "string", "description": "Last recorded activity for the session.", "title": "LastAccess", "format": "date-time", "x-displayname": "LastAccess.", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start": { "type": "string", "description": "Time when session was initialized.", "title": "Start", "format": "date-time", "x-displayname": "Start", "x-ves-example": "2020-04-20T12:32:51.341959216Z.", "x-f5xc-example": "2020-04-20T12:32:51.341959216Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "UserSession contains information about active user's sessions in IAM.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingUserSession", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingUserSessionList": { "type": "object", "description": "UserSessionList contains list of user sessions.", "title": "UserSessionList", "x-displayname": "UserSessionList.", "x-ves-proto-message": "ves.io.schema.user.setting.UserSessionList", "properties": { "user_sessions": { "type": "array", "description": "UserSessions contains list of user sessions.", "title": "UserSessions", "items": { "$ref": "#/components/schemas/settingUserSession" }, "x-displayname": "UserSessions.", "x-f5xc-description-short": "UserSessions contains list of user sessions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "UserSessionList contains list of user sessions.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingUserSessionList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingUserSettingsRequest": { "type": "object", "description": "Allowed settings for the user to be modified.", "title": "UserSettingsRequest", "x-displayname": "UserSettingsRequest.", "x-ves-proto-message": "ves.io.schema.user.setting.UserSettingsRequest", "properties": { "enabled_notifications": { "type": "array", "description": "Enabled notification for specific user.", "title": "Enabled Notifications", "items": { "type": "string" }, "x-displayname": "Enabled Notifications.", "x-ves-example": "['notif-1','notif-2']", "x-f5xc-example": "['notif-1','notif-2']", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_name": { "type": "string", "description": "First name of the user.", "title": "First Name", "x-displayname": "First Name.", "x-ves-example": "Joe", "x-f5xc-example": "Joe", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "description": "Blob of the user avatar image.", "title": "Image", "format": "byte", "x-displayname": "Image", "x-ves-example": "DXNlci1pbWFnZS5qcGVn.", "x-f5xc-example": "dXNlci1pbWFnZS5qcGVn", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_name": { "type": "string", "description": "Last Name of the user.", "title": "Last Name", "x-displayname": "Last Name", "x-ves-example": "Doe", "x-f5xc-example": "Doe", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_enabled": { "type": "boolean", "description": "OTP enabled flag.", "title": "OTP enable", "format": "boolean", "x-displayname": "OTP enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Allowed settings for the user to be modified.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingUserSettingsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingUserSettingsResponse": { "type": "object", "description": "Response of modified user settings.", "title": "UserSettingsResponse", "x-displayname": "UserSettingsResponse.", "x-ves-proto-message": "ves.io.schema.user.setting.UserSettingsResponse", "properties": { "image": { "type": "string", "description": "Image blob field stores user's image, should be base64 encoded while used by HTTP.", "title": "Image", "format": "byte", "x-displayname": "Image", "x-ves-example": "DXNlci1pbWFnZS5qcGVn.", "x-f5xc-example": "dXNlci1pbWFnZS5qcGVn", "x-f5xc-description-short": "Image blob field stores user's image, should be base64 encoded while used by HTTP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initial_access": { "allOf": [ { "$ref": "#/components/schemas/settingInitialAccess" } ], "x-f5xc-description-short": "Configuration parameter for initial access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "is_next_request_allowed": { "type": "boolean", "description": "Boolean flag which shows whether RE-request access is allowed or not.\nVirtually flag shows whether 24hrs are passed from the last_requesting_time timestamp or not.", "title": "Is Next Request Allowed", "format": "boolean", "x-displayname": "Is Next Request Allowed.", "x-f5xc-description-short": "Boolean flag which shows whether RE-request access is allowed or not.", "x-f5xc-description-medium": "Boolean flag which shows whether RE-request access is allowed or not. Virtually flag shows whether 24hrs are passed from the last_requesting_time timestamp or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "notifications": { "type": "array", "description": "List of enabled notifications for specific user account.", "title": "EnabledNotification", "items": { "$ref": "#/components/schemas/settingNotification" }, "x-displayname": "EnabledNotification.", "x-f5xc-description-short": "List of enabled notifications for specific user account.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_enabled": { "type": "boolean", "description": "Switcher for configuration of enabling OTP in IAM Provider.", "title": "OTP Enabled", "format": "boolean", "x-displayname": "OTP Enabled.", "x-f5xc-description-short": "Switcher for configuration of enabling OTP in IAM Provider.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "otp_status": { "allOf": [ { "$ref": "#/components/schemas/tenantOtpStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingUserSettingsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "settingViewPreference": { "type": "object", "description": "Preferences to display appropriate content to appropriate audience.", "title": "View preference", "x-displayname": "View preference.", "x-ves-proto-message": "ves.io.schema.user.setting.ViewPreference", "properties": { "advanced_view": { "type": "boolean", "description": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed.", "title": "Advanced view", "format": "boolean", "x-displayname": "Advanced view.", "x-f5xc-description-short": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initialized": { "type": "boolean", "description": "If true then the user picked their preference.", "title": "Initialized", "format": "boolean", "x-displayname": "Initialized.", "x-f5xc-description-short": "If true then the user picked their preference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "persona_preferences": { "allOf": [ { "$ref": "#/components/schemas/settingPersonaPreferences" } ], "x-f5xc-description-short": "Configuration parameter for persona preferences.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "wizard_advanced_auto_expand": { "type": "boolean", "description": "If true then all advanced configuration fields are automatically expanded when creating a new object.", "title": "Advanced fields auto-expand", "format": "boolean", "x-displayname": "Advanced fields auto-expand.", "x-f5xc-description-short": "If true then all advanced configuration fields are automatically expanded when creating a new object.", "x-f5xc-description-medium": "If true then all advanced configuration fields are automatically expanded when creating a new object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Preferences to display appropriate content to appropriate audience.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for settingViewPreference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "usersettingEmpty": { "type": "object", "description": "Empty object definition.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.user.setting.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for usersettingEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "user_tokenGetUserTokenResponse": { "type": "object", "description": "Response body of token to connect to the Web App Scanning Service.", "title": "GetUserTokenResponse", "x-displayname": "Web App Scanning Service User Token Response.", "x-ves-proto-message": "ves.io.schema.was.user_token.GetUserTokenResponse", "properties": { "redirect_url": { "type": "string", "description": "The Web App Scanning Service URL to be redirected by F5 Distributed Cloud Console.", "title": "Web App Scanning Service Redirect URL", "x-displayname": "Web App Scanning Service Redirect URL.", "x-ves-example": "https://app.heyhack.com/logout.", "x-f5xc-example": "https://app.heyhack.com/logout", "x-f5xc-description-short": "The Web App Scanning Service URL to be redirected by F5 Distributed Cloud Console.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "token": { "type": "string", "description": "The token to connect to Web App Scanning Service.", "title": "Web App Scanning Service User Token", "x-displayname": "Web App Scanning Service User Token.", "x-ves-example": "Blahblah", "x-f5xc-example": "example", "x-f5xc-description-short": "The token to connect to Web App Scanning Service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "security", "maxLength": 1024, "minLength": 20, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_id": { "type": "string", "description": "The User ID of Web App Scanning Service.", "title": "Web App Scanning Service User ID", "x-displayname": "Web App Scanning Service User ID.", "x-ves-example": "Blah|662ab03aeff9c175ea1310c1.", "x-f5xc-example": "blah|662ab03aeff9c175ea1310c1", "x-f5xc-description-short": "The User ID of Web App Scanning Service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Response body of token to connect to the Web App Scanning Service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for user_tokenGetUserTokenResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "User management is platform-level identity" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } } }, "responses": {}, "parameters": {}, "requestBodies": {} } }