@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0007.public.ves.io.schema.api_credential.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.api_credential","description":"F5XC supports 2 variation of credentials - \n1. My Credentials or API credentials\n2. Service Credentials\n\nCredentials created via My credential or API credential inherits same user that of the creator\nand it gets same RBAC applied to the user. So when this credential is used in APIs, it will \nhave same response/audit as creator of the credential is. Generate this credential if you want to\nautomate or access APIs via CLI as yourself.\n\nservice credential on the other hand will have a separte service user associated and RBAC can be\nmanaged differently per namespace than that of the original user creating it.\n\nFor each these credentials, user can request credential in 3 different formats as required by\ntheir usecase:\n\n* API certificate - a password protected P12 certificate bundle\n* virtual K8s kubeconfig - a kubeconfig to access a cluster with embedded user access with client certificate.\n* API token - an easy to use secret that can be send part of HTTP request header Authorization: APIToken <value>","version":""},"paths":{"/api/web/namespaces/system/bulk_revoke/api_credentials":{"post":{"summary":"Bulk Revoke API credentials","description":"It is used to revoke multiple API credentials. This API would disable the credentials and mark them for deletion.\nThe actual removal of objects would be done in the background.\nDepending upon if user is admin or not, following behaviour is supported:-\n* for admins : user has the access to delete their own as well as credentials created by others\n* for non-admins: user can only delete their own credentials.","operationId":"ves.io.schema.api_credential.CustomAPI.BulkRevoke","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialBulkRevokeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/api_credentialBulkRevokeRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-bulkrevoke"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.BulkRevoke"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/bulk_revoke/service_credentials":{"post":{"summary":"Bulk Revoke service credential","description":"It is used to revoke multiple service credentials. This API would disable the credentials and mark them for deletion.\nThe actual removal of objects would be done in the background. Only admins are allowed to access this API.","operationId":"ves.io.schema.api_credential.CustomAPI.BulkRevokeServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialBulkRevokeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/api_credentialBulkRevokeRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-bulkrevokeservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.BulkRevokeServiceCredentials"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/activate/api_credentials":{"post":{"summary":"Activate API credential","description":"For API credential activation/deactivation.","operationId":"ves.io.schema.api_credential.CustomAPI.Activate","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/api_credentialGetRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-activate"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.Activate"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/activate/service_credentials":{"post":{"summary":"Activate API service credential","description":"For Service credential activation/deactivation.","operationId":"ves.io.schema.api_credential.CustomAPI.ActivateServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/api_credentialGetRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-activateservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.ActivateServiceCredentials"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/api_credentials":{"get":{"summary":"List API Credentials","description":"Returns list of api credential of all types created by the user.\nQuery will look into tenants system namespace.","operationId":"ves.io.schema.api_credential.CustomAPI.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-list"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.List"},"post":{"summary":"Create API Credentials","description":"user can request 3 types of credential for themselves. \nAPI_TOKEN, API_CERTIFICATE and KUBE_CONFIG.\n\nan API_TOKEN is an easy to use secret that can be send part of HTTP request header Authorization: APIToken <value>\nin the create request expiry can be set additionally. F5XC also supports renew and revoke of API_TOKENs.\nan API_CERTIFICATE is a password protected P12 certificate bundle document and can be used as client certificate.\nwhen sending create request, user can request with an expiry and password. F5XC Identity Authority (IA)\nmints new certificate with required credentials and is shared in the response as API Certificate. \na virtual K8s kubeconfig can be generate with type KUBE_CONFIG. Create request can specify cluster, namespace and expiry\nwith embedded user access with client certificate.\n\nrequest can specify name, expiry and type of credential required. since this credential inherits the creator's RBAC\nservice will determine the user from request context.","operationId":"ves.io.schema.api_credential.CustomAPI.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-create"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.Create"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/api_credentials/{name}":{"get":{"summary":"Get API Credentials","description":"Get implements api credential query by name.\nReturns api credential object. Query will look into tenants system namespace for api credential by name.","operationId":"ves.io.schema.api_credential.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Credential name\n\nx-required\nx-example: \"value\"\nName of API credential.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.Get"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/renew/api_credentials":{"post":{"summary":"Renew API credential","description":"Renew user's my credential expiry.\nRenewal is only supported for the credential type API_TOKEN.","operationId":"ves.io.schema.api_credential.CustomAPI.Renew","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\" .","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/api_credentialRenewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-renew"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.Renew"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/renew/service_credentials":{"post":{"summary":"Renew API service credential","description":"Renew service credential's expiry.\nRenewal is only supported for the credential type SERVICE_API_TOKEN.","operationId":"ves.io.schema.api_credential.CustomAPI.RenewServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\" .","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/api_credentialRenewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-renewservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.RenewServiceCredentials"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/revoke/api_credentials":{"post":{"summary":"Revoke API credential","description":"For API credential revoke/deletion.","operationId":"ves.io.schema.api_credential.CustomAPI.Revoke","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/api_credentialGetRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-revoke"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.Revoke"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/revoke/scim_token":{"post":{"summary":"Revoke SCIM API credential","description":"For SCIM API credential revoke/deletion.","operationId":"ves.io.schema.api_credential.CustomAPI.RevokeScimToken","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialScimTokenRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-revokescimtoken"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.RevokeScimToken"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/revoke/service_credentials":{"post":{"summary":"Revoke Service credential","description":"For Service credential revoke/deletion.","operationId":"ves.io.schema.api_credential.CustomAPI.RevokeServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/api_credentialGetRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-revokeservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.RevokeServiceCredentials"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/scim_token":{"get":{"summary":"Get Scim Token","description":"GetScimToken implements querying of scim token.\nSCIM API token value will be visible only on create API response.\nThis detail RPC will show the current token's expiry. Returns api credential object.","operationId":"ves.io.schema.api_credential.CustomAPI.GetScimToken","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-getscimtoken"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.GetScimToken"},"post":{"summary":"Create/Re-create SCIM API token","description":"request to create/re-create new SCIM API credential.\nNote: Only one valid (non-expired) SCIM token could exist for a tenant, and only if SCIM is enabled for the tenant.\nIf a valid SCIM token is already minted, we would revoke the current one and generate a new one.","operationId":"ves.io.schema.api_credential.CustomAPI.RecreateScimToken","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialRecreateScimTokenRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-recreatescimtoken"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.RecreateScimToken"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/service_credentials":{"get":{"summary":"List service credentials","description":"request to list service credentials created by user.","operationId":"ves.io.schema.api_credential.CustomAPI.ListServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialListServiceCredentialsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-listservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.ListServiceCredentials"},"post":{"summary":"Create service credentials","description":"request to create new service credentials.\nuser can specify name, expiry and list of namespce and allowed role of the service user.","operationId":"ves.io.schema.api_credential.CustomAPI.CreateServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialCreateServiceCredentialsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-createservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.CreateServiceCredentials"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/service_credentials/{name}":{"get":{"summary":"Get Service Credential","description":"Get implements service credential query by name.\nReturns service credential object. Query will look into tenants system namespace for service credential by name.","operationId":"ves.io.schema.api_credential.CustomAPI.GetServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialGetServiceCredentialsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Credential name\n\nx-required\nx-example: \"value\"\nName of API credential.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-getservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.GetServiceCredentials"},"put":{"summary":"Replace service credentials","description":"request to replace user_groups and roles in service credentials.\nNote - for updating expiry use RenewServiceCredentials and to active/inactive service credential use ActivateServiceCredentials API","operationId":"ves.io.schema.api_credential.CustomAPI.ReplaceServiceCredentials","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialReplaceServiceCredentialsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nNamespace of the service credential user.\nValue of namespace is always \"system\".","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Service Credential name\n\nx-required\nx-example: \"api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a\"\nName of service credential object.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialReplaceServiceCredentialsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_credential-customapi-replaceservicecredentials"},"x-ves-proto-rpc":"ves.io.schema.api_credential.CustomAPI.ReplaceServiceCredentials"},"x-displayname":"API/Service Credentials","x-ves-proto-service":"ves.io.schema.api_credential.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"API/Service Credentials","x-ves-proto-package":"ves.io.schema.api_credential","components":{"requestBodies":{"api_credentialRenewRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialRenewRequest"}}},"required":true},"api_credentialGetRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialGetRequest"}}},"required":true},"api_credentialBulkRevokeRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_credentialBulkRevokeRequest"}}},"required":true}},"schemas":{"api_credentialAPICredentialType":{"type":"string","description":"Types of API credential given when requesting credentials from volterra\n\nF5XC user certificate to access F5XC public API using mTLS\nusing self credential (my credential)\nKubernetes config file to access Virtual Kubernetes API in Volterra\nusing self credential (my credential)\nAPI token to access F5XC public API\nusing self credential (my credential)\nAPI token for service credentials\nusing service user credential (service credential)\nAPI certificate for service credentials\nusing service user credential (service credential)\nService Credential kubeconfig\nusing service user credential (service credential)\nKubeconfig for accessing Site via Global Controller\nusing self credential (my credential)\nToken for the SCIM public APIs used to sync users and groups with the F5XC platform.\nExternal identity provider's SCIM client can use this token as Bearer token with Authorization header\nService Credential Kubeconfig for accessing Site via Global Controller\nusing service user credential (service credential)","title":"API Credential type","enum":["API_CERTIFICATE","KUBE_CONFIG","API_TOKEN","SERVICE_API_TOKEN","SERVICE_API_CERTIFICATE","SERVICE_KUBE_CONFIG","SITE_GLOBAL_KUBE_CONFIG","SCIM_API_TOKEN","SERVICE_SITE_GLOBAL_KUBE_CONFIG"],"default":"API_CERTIFICATE","x-displayname":"Credential Type","x-ves-proto-enum":"ves.io.schema.api_credential.APICredentialType"},"api_credentialApiCertificateType":{"type":"object","description":"Service API Certificate parameters","title":"api_certificate","x-displayname":"Service API Certificate Specification","x-ves-proto-message":"ves.io.schema.api_credential.ApiCertificateType","properties":{"password":{"type":"string","description":" Password is used for generating an API certificate P12 bundle user can use to protect access to it.\n this password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE\n Users have to use this password when they use the certificate, e.g. in curl or while adding to key chain.\n\nExample: ` \"myPassw0rd123\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 50\n  ves.io.schema.rules.string.min_bytes: 6\n","title":"Password for API certificate","minLength":6,"maxLength":50,"x-displayname":"Password","x-ves-example":"myPassw0rd123","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"50","ves.io.schema.rules.string.min_bytes":"6"}}}},"api_credentialBulkRevokeRequest":{"type":"object","description":"request format for revoking multiple api credentials.","title":"Bulk Revoke Request","x-displayname":"Bulk Revoke Request","x-ves-oneof-field-bulkrevoke_choice":"[\"expired_selector\",\"name_selector\"]","x-ves-proto-message":"ves.io.schema.api_credential.BulkRevokeRequest","properties":{"expired_selector":{"$ref":"#/components/schemas/api_credentialExpiredSelector"},"name_selector":{"$ref":"#/components/schemas/api_credentialNameSelector"}}},"api_credentialBulkRevokeResponse":{"type":"object","description":"response format for revoking multiple api credentials.","title":"Bulk Revoke Response","x-displayname":"Bulk Revoke Response","x-ves-proto-message":"ves.io.schema.api_credential.BulkRevokeResponse","properties":{"credentials_failed":{"type":"array","description":" names of credentials that are not marked as delete due to some error","title":"Credentials Failed","items":{"type":"string"},"x-displayname":"Credentials Failed"},"credentials_marked_for_deletion":{"type":"array","description":" names of credentials that are successfully marked for deletion","title":"Credentials Success","items":{"type":"string"},"x-displayname":"Credentials Success"},"error_message":{"type":"string","description":" error message about the failures of bulk revoke of credentials","title":"error message","x-displayname":"Error Message"}}},"api_credentialCreateRequest":{"type":"object","description":"CreateRequest is the request format for generating api credential.","title":"Create Request","x-displayname":"Create Request","x-ves-displayorder":"1,2,3,5","x-ves-proto-message":"ves.io.schema.api_credential.CreateRequest","properties":{"expiration_days":{"type":"integer","description":"Qty of days of service credential expiration.\n\nExample: `\"value\"`","title":"Expiry in days","format":"int64","x-displayname":"Expiry in days","x-ves-example":"value"},"name":{"type":"string","description":"Name of API credential record. It will be saved in metadata.\n\nExample: `\"value\"`","title":"Name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":"Value of namespace is always \"system\".\n\nExample: `\"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"spec":{"$ref":"#/components/schemas/api_credentialCustomCreateSpecType"}}},"api_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"},"data":{"type":"string","description":" data is the response format based on the API credential type.\n In case of API_CERTIFICATES, the response is the base64 encoded value of \n certificate in PKCS12 format.\n In case of KUBE_CONFIG, the response is the base64 encoded value of the K8s kubeconfig file\n with contents as requested - cluster,namespace and base64 encoded certificate, key and CA.\n\nExample: ` \"value\"`","title":"Credentials","x-displayname":"Credentials","x-ves-example":"value"},"expiration_timestamp":{"type":"string","format":"date-time"},"name":{"type":"string"}}},"api_credentialCreateServiceCredentialsRequest":{"type":"object","description":"CreateServiceCredentialsRequest is the request format for creating service credentials.","title":"Create Service Credentials Request","x-displayname":"Create Service Credentials Request","x-ves-oneof-field-service_credential_choice":"[\"api_certificate\",\"api_token\",\"site_kubeconfig\",\"vk8s_kubeconfig\"]","x-ves-proto-message":"ves.io.schema.api_credential.CreateServiceCredentialsRequest","properties":{"api_certificate":{"$ref":"#/components/schemas/api_credentialApiCertificateType"},"api_token":{"$ref":"#/components/schemas/schemaEmpty"},"expiration_days":{"type":"integer","description":" Qty of days of service credential expiration.\n\nExample: ` \"value\"`","title":"Expiry in days","format":"int64","x-displayname":"Expiry in days","x-ves-example":"value"},"name":{"type":"string","description":" Name of API credential record. It will be saved in metadata.\n\nExample: ` \"svc-cred-app1\"`","title":"Name","x-displayname":"Name","x-ves-example":"svc-cred-app1"},"namespace":{"type":"string","description":" Value of namespace is always \"system\".\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"namespace_roles":{"type":"array","description":" list of roles per namespace to be assigned to service credentials.\n\nExample: ` \"value\"`","title":"Roles","items":{"$ref":"#/components/schemas/schemaNamespaceRoleType"},"x-displayname":"List of roles","x-ves-example":"value"},"password":{"type":"string","description":" Password is used for generating an API certificate P12 bundle user can use to protect access to it.\n this password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE\n Users have to use this password when they use the certificate, e.g. in curl or while adding to key chain.\n\nExample: ` \"myPassw0rd123\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Password for API certificate","x-displayname":"Password","x-ves-example":"myPassw0rd123","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"site_kubeconfig":{"$ref":"#/components/schemas/api_credentialSiteKubeconfigType"},"type":{"$ref":"#/components/schemas/api_credentialAPICredentialType"},"user_group_names":{"type":"array","description":" list of user_groups assigned to this service credential\n\nExample: ` \"[\"dev-group-1\"]\"`","title":"User Groups Names","items":{"type":"string"},"x-displayname":"Groups","x-ves-example":"[\"dev-group-1\"]"},"virtual_k8s_name":{"type":"string","description":" Name of virtual_k8s cluster. Applicable for KUBE_CONFIG.\n\nExample: ` \"vk8s-product-app1\"`","title":"virtual k8s cluster name","x-displayname":"vK8s Cluster","x-ves-example":"vk8s-product-app1"},"virtual_k8s_namespace":{"type":"string","description":" Namespace of virtual_k8s cluster. Applicable for KUBE_CONFIG.\n\nExample: ` \"app-ns1\"`","title":"Virtual k8s namespace","x-displayname":"vK8s Namespace","x-ves-example":"app-ns1"},"vk8s_kubeconfig":{"$ref":"#/components/schemas/api_credentialVk8sKubeconfigType"}}},"api_credentialCustomCreateSpecType":{"type":"object","description":"Create request specification.","title":"Create Spec Type","x-displayname":"Create API Credential","x-ves-displayorder":"1,2,5,3,4","x-ves-proto-message":"ves.io.schema.api_credential.CustomCreateSpecType","properties":{"password":{"type":"string","description":" Password is used for generating an API certificate P12 bundle user can use to protect access to it.\n this password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE\n Users have to use this password when they use the certificate, e.g. in curl or while adding to key chain.\n\nExample: ` \"myPassw0rd123\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Password for API certificate","x-displayname":"Password","x-ves-example":"myPassw0rd123","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"type":{"$ref":"#/components/schemas/api_credentialAPICredentialType"},"virtual_k8s_name":{"type":"string","description":" Name of virtual K8s cluster. Applicable for KUBE_CONFIG.\n\nExample: ` \"vk8s-product-app1\"`","title":"virtual k8s cluster name","x-displayname":"vK8s Cluster","x-ves-example":"vk8s-product-app1"},"virtual_k8s_namespace":{"type":"string","description":" Namespace of virtual K8s cluster. Applicable for KUBE_CONFIG.\n\nExample: ` \"app-ns1\"`","title":"Virtual K8s namespace","x-displayname":"vK8s Namespace","x-ves-example":"app-ns1"}}},"api_credentialExpiredSelector":{"type":"object","description":"It specifies which expired credentials needs to be deleted","title":"Expired Selector","x-displayname":"Expired Selector","x-ves-oneof-field-expired_credential_choice":"[\"all\",\"credential_type\"]","x-ves-proto-message":"ves.io.schema.api_credential.ExpiredSelector","properties":{"all":{"$ref":"#/components/schemas/schemaEmpty"},"credential_type":{"$ref":"#/components/schemas/api_credentialAPICredentialType"}}},"api_credentialGetRequest":{"type":"object","description":"Get credential object with a given name.","title":"Get credential request","x-displayname":"Get Credential","x-ves-proto-message":"ves.io.schema.api_credential.GetRequest","properties":{"name":{"type":"string","description":" Name of API credential.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Credential name","x-displayname":"Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Value of namespace is always \"system\".\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"api_credentialGetResponse":{"type":"object","description":"Response of get credential request with a given name.","title":"Get credential response","x-displayname":"Get Credential Response","x-ves-proto-message":"ves.io.schema.api_credential.GetResponse","properties":{"object":{"$ref":"#/components/schemas/api_credentialObject"}}},"api_credentialGetServiceCredentialsResponse":{"type":"object","description":"Response of get service credentials request with a given name.","title":"Get service credentials response","x-displayname":"Get Service Credentials Response","x-ves-proto-message":"ves.io.schema.api_credential.GetServiceCredentialsResponse","properties":{"active":{"type":"boolean","description":" Possibility to deactivate credential with no deletion.\n\nExample: ` \"true\"`","title":"Active","format":"boolean","x-displayname":"Active","x-ves-example":"true"},"create_timestamp":{"type":"string","description":" Create time of service credential.","title":"Create timestamp","format":"date-time","x-displayname":"Creation Time"},"expiry_timestamp":{"type":"string","description":" Expiry time of service credential.","title":"Expiry time","format":"date-time","x-displayname":"Expiry Time"},"name":{"type":"string","description":" Name of service credential object.\n\nExample: ` \"value\"`","title":"Credential name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" Namespace of service credential object.\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"namespace_access":{"$ref":"#/components/schemas/schemaNamespaceAccessType"},"type":{"$ref":"#/components/schemas/api_credentialAPICredentialType"},"uid":{"type":"string","description":" uid of service credential object.\n\nExample: ` \"fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa\"`","title":"uid of the record","x-displayname":"UUID","x-ves-example":"fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa"},"user_email":{"type":"string","description":" email of the service user attached to service credential .\n\nExample: ` \"admin@acmecorp.com\"`","title":"Email of user","x-displayname":"User","x-ves-example":"admin@acmecorp.com"},"user_group_names":{"type":"array","description":" user group list associated to this service credential.\n\nExample: ` \"[\"dev-group-1\"]\"`","title":"User Groups Names","items":{"type":"string"},"x-displayname":"User Groups","x-ves-example":"[\"dev-group-1\"]"}}},"api_credentialGlobalSpecType":{"type":"object","description":"Keeps track of user requested API credentials","title":"API credentials","x-displayname":"API Credentials","x-ves-proto-message":"ves.io.schema.api_credential.GlobalSpecType","properties":{"active":{"type":"boolean","description":" Possibility to deactivate/activate credential with no deletion","title":"Active","format":"boolean","x-displayname":"Active"},"certificate_serial_num":{"type":"string","description":" Serial number of the client certificate part of credential type API Certificate or Kubeconfig\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 32\n","title":"Certificate Serial Number","maxLength":32,"x-displayname":"Certificate Serial Number","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"32"}},"created_timestamp":{"type":"string","description":" Timestamp of credential creation","title":"Created timestamp","format":"date-time","x-displayname":"Created timestamp"},"digest":{"type":"string","description":" Digest sha1 of credential","title":"Digest sha1","x-displayname":"Digest sha1"},"expiration_timestamp":{"type":"string","description":" Timestamp of credential expiration","title":"Expiry timestamp","format":"date-time","x-displayname":"Expiry timestamp"},"site_name":{"type":"string","description":" Site name when global kubeconfig is issued for physical k8s site","title":"Site Name","x-displayname":"Site Name"},"type":{"$ref":"#/components/schemas/api_credentialAPICredentialType"},"users":{"type":"array","description":" Reference to user for whom API credential is created\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"user requesting credential","maxItems":1,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"User","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"virtual_k8s_name":{"type":"string","description":" Name of virtual K8s cluster","title":"Virtual K8s","x-displayname":"Virtual K8s"},"virtual_k8s_namespace":{"type":"string","description":" Namespace of virtual_k8s","title":"Virtual K8s namespace","x-displayname":"Namespace"}}},"api_credentialListResponse":{"type":"object","description":"Response of request to list all of users credential objects.","title":"List credential response","x-displayname":"List Credential Response","x-ves-proto-message":"ves.io.schema.api_credential.ListResponse","properties":{"items":{"type":"array","description":" List of credential items.","title":"List of the credentials","items":{"$ref":"#/components/schemas/api_credentialListResponseItem"},"x-displayname":"Credentials"}}},"api_credentialListResponseItem":{"type":"object","description":"Each item of credential list request.","title":"List Credential item","x-displayname":"List credential response item","x-ves-proto-message":"ves.io.schema.api_credential.ListResponseItem","properties":{"active":{"type":"boolean","description":" Possibility to deactivate credential with no deletion.\n\nExample: ` \"true\"`","title":"Active","format":"boolean","x-displayname":"Active","x-ves-example":"true"},"create_timestamp":{"type":"string","description":" Create time of API credential.","title":"Create timestamp","format":"date-time","x-displayname":"Creation Time"},"expiry_timestamp":{"type":"string","description":" Expiry time of credential.","title":"Expiry time","format":"date-time","x-displayname":"Expiry Time"},"name":{"type":"string","description":" Name of API credential object.\n\nExample: ` \"value\"`","title":"Credential name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" Namespace of API credential object.\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"type":{"$ref":"#/components/schemas/api_credentialAPICredentialType"},"uid":{"type":"string","description":" UUID of API credential object.\n\nExample: ` \"fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa\"`","title":"uuid of the record","x-displayname":"UUID","x-ves-example":"fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa"},"user_email":{"type":"string","description":" User email of user that requested credential .\n\nExample: ` \"admin@acmecorp.com\"`","title":"Email of user","x-displayname":"User","x-ves-example":"admin@acmecorp.com"}}},"api_credentialListServiceCredentialsResponse":{"type":"object","description":"Response of request to list all of service credential objects.","title":"List service credential response","x-displayname":"List Service Credential Response","x-ves-proto-message":"ves.io.schema.api_credential.ListServiceCredentialsResponse","properties":{"items":{"type":"array","description":" List of service credential items.","title":"List of the service credentials","items":{"$ref":"#/components/schemas/api_credentialListServiceCredentialsResponseItem"},"x-displayname":"Service Credentials"}}},"api_credentialListServiceCredentialsResponseItem":{"type":"object","description":"Each item of service credential list request.","title":"List Service Credential item","x-displayname":"List service credential response item","x-ves-proto-message":"ves.io.schema.api_credential.ListServiceCredentialsResponseItem","properties":{"active":{"type":"boolean","description":" Possibility to deactivate credential with no deletion.\n\nExample: ` \"true\"`","title":"Active","format":"boolean","x-displayname":"Active","x-ves-example":"true"},"create_timestamp":{"type":"string","description":" Create time of API credential.","title":"Create timestamp","format":"date-time","x-displayname":"Creation Time"},"expiry_timestamp":{"type":"string","description":" Expiry time of credential.","title":"Expiry time","format":"date-time","x-displayname":"Expiry Time"},"name":{"type":"string","description":" Name of API credential object.\n\nExample: ` \"value\"`","title":"Credential name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" Namespace of API credential object.\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"namespace_access":{"$ref":"#/components/schemas/schemaNamespaceAccessType"},"type":{"$ref":"#/components/schemas/api_credentialAPICredentialType"},"uid":{"type":"string","description":" UUID of API credential object.\n\nExample: ` \"fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa\"`","title":"uuid of the record","x-displayname":"UUID","x-ves-example":"fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa"},"user_email":{"type":"string","description":" User email of user that requested credential .\n\nExample: ` \"admin@acmecorp.com\"`","title":"Email of user","x-displayname":"User","x-ves-example":"admin@acmecorp.com"},"user_group_names":{"type":"array","description":" user group list associated to this service credential.\n\nExample: ` \"[\"dev-group-1\"]\"`","title":"User Groups Names","items":{"type":"string"},"x-displayname":"User Groups","x-ves-example":"[\"dev-group-1\"]"}}},"api_credentialNameSelector":{"type":"object","description":"Revoke Credentials by their names","title":"Name Selector","x-displayname":"Name Selector","x-ves-proto-message":"ves.io.schema.api_credential.NameSelector","properties":{"names":{"type":"array","description":" It contains the names of credentials which needs to be deleted.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 200\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"name of api credential","minItems":1,"maxItems":200,"items":{"type":"string"},"x-displayname":"Name of Api Credentials","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"200","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"api_credentialObject":{"type":"object","description":"API Credential object represents the user request to create a certificate.","title":"API Credentials","x-displayname":"Credentials","x-ves-proto-message":"ves.io.schema.api_credential.Object","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectMetaType"},"spec":{"$ref":"#/components/schemas/api_credentialSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectMetaType"}}},"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.\n Expiration days value can range between 1 and 730.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 730\n","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"}},"namespace":{"type":"string","description":" Value of namespace is always \"system\".\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"api_credentialRenewRequest":{"type":"object","description":"Request to renew a credential object.","title":"Renew Credential request","x-displayname":"Renew Credentials","x-ves-proto-message":"ves.io.schema.api_credential.RenewRequest","properties":{"expiration_days":{"type":"integer","description":" Qty of days of service credential expiration.\n\nExample: ` \"value\"`","title":"Expiry in days","format":"int64","x-displayname":"Expiry in days","x-ves-example":"value"},"name":{"type":"string","description":" Name of API credential object.\n\nExample: ` \"api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Credential name","x-displayname":"Name","x-ves-example":"api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Value of namespace is always \"system\" .\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"api_credentialReplaceServiceCredentialsRequest":{"type":"object","description":"request format for replacing service credentials.","title":"Replace Service Credentials Request","x-displayname":"Replace Service Credentials Request","x-ves-proto-message":"ves.io.schema.api_credential.ReplaceServiceCredentialsRequest","properties":{"name":{"type":"string","description":" Name of service credential object.\n\nExample: ` \"api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service Credential name","x-displayname":"Name","x-ves-example":"api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Namespace of the service credential user.\n Value of namespace is always \"system\".\n\nExample: ` \"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"},"namespace_access":{"$ref":"#/components/schemas/schemaNamespaceAccessType"},"user_group_names":{"type":"array","description":" list of user_groups to be replaced for this service credentials.\n\nExample: ` \"[\"dev-group-1\"]\"`","title":"User Groups Names","items":{"type":"string"},"x-displayname":"Groups","x-ves-example":"[\"dev-group-1\"]"}}},"api_credentialReplaceServiceCredentialsResponse":{"type":"object","description":"response format for the credential's replace request.","title":"Replace service credentials response","x-displayname":"Replace service credentials response","x-ves-proto-message":"ves.io.schema.api_credential.ReplaceServiceCredentialsResponse","properties":{"active":{"type":"boolean","description":" Specifies if service credential is active or not\n\nExample: ` \"true\"`","title":"Active","format":"boolean","x-displayname":"Active","x-ves-example":"true"},"expiration_timestamp":{"type":"string","description":" Specifies the expiration timestamp","title":"Expiry","format":"date-time","x-displayname":"Expiry"},"name":{"type":"string","description":" Name of API credential record.\n\nExample: ` \"svc-cred-app1\"`","title":"Name","x-displayname":"Name","x-ves-example":"svc-cred-app1"}}},"api_credentialScimTokenRequest":{"type":"object","description":"ScimTokenRequest is used for fetching or revoking scim token","title":"Scim Token Request","x-displayname":"Scim Token Request","x-ves-proto-message":"ves.io.schema.api_credential.ScimTokenRequest","properties":{"namespace":{"type":"string","description":" Value of namespace is always \"system\".\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"api_credentialSiteKubeconfigType":{"type":"object","description":"Site Global Kube Config parameters","title":"site_kubeconfig","x-displayname":"Site Global Kube Config Specification","x-ves-proto-message":"ves.io.schema.api_credential.SiteKubeconfigType","properties":{"site":{"type":"string","description":" Name of the site for which kubeconfig is being requested.\n\nExample: ` \"ce398\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 64\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"Site","minLength":1,"maxLength":64,"x-displayname":"Site","x-ves-example":"ce398","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"64","ves.io.schema.rules.string.min_bytes":"1"}}}},"api_credentialSpecType":{"type":"object","description":"Shape of the api credential specification","title":"Specification for API credentials","x-displayname":"Specifications","x-ves-proto-message":"ves.io.schema.api_credential.SpecType","properties":{"gc_spec":{"$ref":"#/components/schemas/api_credentialGlobalSpecType"}}},"api_credentialStatusResponse":{"type":"object","description":"API credential status response","title":"API credential status response","x-displayname":"API credential status response","x-ves-proto-message":"ves.io.schema.api_credential.StatusResponse","properties":{"status":{"type":"boolean","description":" Result status flag.\n\nExample: ` \"true\"`","title":"Status","format":"boolean","x-displayname":"status","x-ves-example":"true"}}},"api_credentialVk8sKubeconfigType":{"type":"object","description":"Service Kube Config parameters","title":"vk8s_kubeconfig","x-displayname":"Service Kube Config Specification","x-ves-proto-message":"ves.io.schema.api_credential.Vk8sKubeconfigType","properties":{"vk8s_cluster_name":{"type":"string","description":" Name of virtual k8s cluster.\n\nExample: ` \"vk8s-product-app1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"virtual k8s cluster name","x-displayname":"vK8s Cluster","x-ves-example":"vk8s-product-app1","x-ves-validation-rules":{"ves.io.schema.rules.string.ves_object_name":"true"}},"vk8s_namespace":{"type":"string","description":" Namespace of virtual k8s cluster. Applicable for KUBE_CONFIG.\n\nExample: ` \"app-ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"Virtual k8s namespace","x-displayname":"vK8s Namespace","x-ves-example":"app-ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.ves_object_name":"true"}}}},"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"},"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"}}},"schemaInitializersType":{"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.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"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\n\nExample: ` '<namespace> [<roles>]'`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 256\n  ves.io.schema.rules.message.required: true\n","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"}}}},"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\n\nExample: ` \"ns1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","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"}},"role":{"type":"string","description":" Users role for this namespace\n\nExample: ` \"ves-io-monitor-role\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"Role","maxLength":256,"x-displayname":"Role","x-ves-example":"ves-io-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"}}}},"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\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","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"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"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\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. Object create will fail if\n provided by the client and the value exists in the system. Typically generated by the\n server on successful creation of an object and is not allowed to change once populated.\n Shadowed by SystemObjectMeta's uid field.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"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)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaRoleListType":{"type":"object","description":"x-displayName: \"Role List\"\nRole list","title":"List of Roles","properties":{"names":{"type":"array","description":"x-displayName: \"Roles List\"\nx-example: [\"ves-io-monitor-role\", \"ves-io-uam-admin-role\"]\nx-required\nList of all the roles","title":"Roles List","items":{"type":"string"}}}},"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.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectMetaType":{"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\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients 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"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"value"},"creator_cookie":{"type":"string","description":" This can used by the creator of the object for later audit for e.g. by storing the\n version identifying information of the object so at future it can be determined if\n version present at remote end is current or stale.\n\nExample: ` \"value\"`","title":"creator_cookie","x-displayname":"Creator Cookie","x-ves-example":"value"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"value"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"direct_ref_hash":{"type":"string","description":" A hash of the UIDs of  direct references on this object. This can be used to determine if \n this object hash has had references become resolved/unresolved","title":"direct_ref_hash","x-displayname":"Direct Reference Hash"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"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\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"namespace":{"type":"array","description":" The namespace this object belongs to. This is populated by the service based on the\n metadata.namespace field when an object is created.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","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"}},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"revision":{"type":"string","description":" A revision number which always increases with each modification of the object in storage\n This doesn't necessarily increase sequentially, but should always increase.\n This will be 0 when first created, and before any modifications.","title":"revision","format":"int64","x-displayname":"Revision"},"sre_disable":{"type":"boolean","description":" This should be set to true If VES/SRE operator wants to suppress an object from being\n presented to business-logic of a daemon(e.g. due to bad-form/issue-causing Object).\n This is meant only to be used in temporary situations for operational continuity till\n a fix is rolled out in business-logic.\n\nExample: ` \"true\"`","title":"sre_disable","format":"boolean","x-displayname":"SRE Disable","x-ves-example":"true"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"trace_info":{"type":"string","description":" trace_info holds information(<trace-id>:<span-id>:<parent-span-id>) of the request doing\n the object modification. This can be used on the watch side to create subsequent spans.\n This information can be used to co-relate activities across services (modulo state compression)\n for a synchronous API.\n\nExample: ` \"value\"`","title":"trace_info","x-displayname":"Trace Info","x-ves-example":"value"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Indicate origin of this object.","title":"vtrp_id","x-displayname":"VTRP ID"},"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"}}},"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\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0008.public.ves.io.schema.pbac.addon_service.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.pbac.addon_service","description":"Basic unit of logical representation of a F5XC service.\nAn addon service can be self serviced, partially managed or fully managed depending upon the activation requirement.\nA configuration object belong to exactly one addon service and every addon service will be linked to one or more navigation tile.\nBy default, API Groups consisting of APIs for read, write, admin read/write and subscription management capabality will be auto created.","version":""},"paths":{"/api/web/custom/namespaces/shared/addon_services/{name}":{"get":{"summary":"Get Addon Service Details","description":"Retrieves addon service information for the given addon service name.","operationId":"ves.io.schema.pbac.addon_service.CustomAPI.GetAddonServiceDetails","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addon_serviceGetAddonServiceDetailsResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"name","description":"name\n\nx-example: \"addon-service-1\"\nName of the addon service","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-pbac-addon_service-customapi-getaddonservicedetails"},"x-ves-proto-rpc":"ves.io.schema.pbac.addon_service.CustomAPI.GetAddonServiceDetails"},"x-displayname":"Addon Service","x-ves-proto-service":"ves.io.schema.pbac.addon_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/addon_services/{addon_service}/activation-status":{"get":{"summary":"Addon Service Activation Status","description":"Get current subscription status for an addon service. Response can indicate whether the service was successfully subscribed or in pending state.","operationId":"ves.io.schema.pbac.addon_service.CustomAPI.GetActivationStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addon_serviceGetActivationStatusResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"addon_service","description":"addon_service\n\nx-example: \"addon-service-1\"\nName of the addon_service","in":"path","required":true,"x-displayname":"Addon Service","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-pbac-addon_service-customapi-getactivationstatus"},"x-ves-proto-rpc":"ves.io.schema.pbac.addon_service.CustomAPI.GetActivationStatus"},"x-displayname":"Addon Service","x-ves-proto-service":"ves.io.schema.pbac.addon_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/addon_services/{addon_service}/all-activation-status":{"get":{"summary":"All Addon Service Activation Status","description":"Get current subscription status for all addon services in a feature tier. Response can indicate whether the service was successfully subscribed or in pending state.","operationId":"ves.io.schema.pbac.addon_service.CustomAPI.GetAllServiceTiersActivationStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addon_serviceGetAllServiceTiersActivationStatusResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"addon_service","description":"addon_service\n\nx-example: \"addon-service-1\"\nName of the addon_service feature tier","in":"path","required":true,"x-displayname":"Addon Service","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-pbac-addon_service-customapi-getallservicetiersactivationstatus"},"x-ves-proto-rpc":"ves.io.schema.pbac.addon_service.CustomAPI.GetAllServiceTiersActivationStatus"},"x-displayname":"Addon Service","x-ves-proto-service":"ves.io.schema.pbac.addon_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/addon_services":{"get":{"summary":"List Addon Service","description":"List the set of addon_service in a namespace","operationId":"ves.io.schema.pbac.addon_service.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addon_serviceListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of addon_service","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"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://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-pbac-addon_service-api-list"},"x-ves-proto-rpc":"ves.io.schema.pbac.addon_service.API.List"},"x-displayname":"Addon Service","x-ves-proto-service":"ves.io.schema.pbac.addon_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/web/namespaces/{namespace}/addon_services/{name}":{"get":{"summary":"Get Addon Service","description":"Get addon_service reads a given object from storage backend for metadata.namespace.","operationId":"ves.io.schema.pbac.addon_service.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addon_serviceGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"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 referrred 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://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-pbac-addon_service-api-get"},"x-ves-proto-rpc":"ves.io.schema.pbac.addon_service.API.Get"},"x-displayname":"Addon Service","x-ves-proto-service":"ves.io.schema.pbac.addon_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Addon Service","x-ves-proto-package":"ves.io.schema.pbac.addon_service","components":{"schemas":{"addon_serviceAddonServiceActivationStatus":{"type":"object","description":"x-displayName: \"Addon Service Activation Status\"\nContains single addon service activation status information","title":"AddonServiceActivationStatus","properties":{"access_status":{"$ref":"#/components/schemas/schemaAddonServiceAccess"},"addon_service_status":{"$ref":"#/components/schemas/schemaAddonServiceState"},"display_name":{"type":"string","description":"x-displayName: \"Display Name\"\nx-example: \"Addon Service 1\"\nDisplay name of the addon service","title":"display_name"},"name":{"type":"string","description":"x-displayName: \"Name\"\nx-example: \"addon-service-1\"\nName of the addon_service","title":"name"},"tier":{"$ref":"#/components/schemas/schemaAddonServiceTierType"}}},"addon_serviceContent":{"type":"object","description":"Content holds the subject and the description","title":"Content","x-displayname":"Content","x-ves-proto-message":"ves.io.schema.pbac.addon_service.Content","properties":{"description":{"type":"string","description":" Description of the support ticket","title":"Description","x-displayname":"Description"},"subject":{"type":"string","description":" Subject of the support ticket","title":"Subject","x-displayname":"Subject"}}},"addon_serviceCustomSupportTicket":{"type":"object","description":"CustomSupportTicket holds the template details provided by the service owner","title":"CustomSupportTicket","x-displayname":"Custom Support Ticket","x-ves-proto-message":"ves.io.schema.pbac.addon_service.CustomSupportTicket","properties":{"priority":{"$ref":"#/components/schemas/customer_supportSupportTicketPriority"},"service":{"$ref":"#/components/schemas/customer_supportSupportService"},"subscribe_content":{"$ref":"#/components/schemas/addon_serviceContent"},"unsubscribe_content":{"$ref":"#/components/schemas/addon_serviceContent"}}},"addon_serviceFullyManagedActivationType":{"type":"object","description":"Managed Activation and require complete manual intervention.","title":"FullyManagedActivationType","x-displayname":"Fully Managed Activation","x-ves-proto-message":"ves.io.schema.pbac.addon_service.FullyManagedActivationType","properties":{"notification_preference":{"$ref":"#/components/schemas/addon_serviceNotificationPreference"}}},"addon_serviceGetActivationStatusResp":{"type":"object","description":"Response shape for addon service activation status","title":"GetActivationStatusResp","x-displayname":"Addon Service activation status Response","x-ves-proto-message":"ves.io.schema.pbac.addon_service.GetActivationStatusResp","properties":{"state":{"$ref":"#/components/schemas/schemaAddonServiceState"}}},"addon_serviceGetAddonServiceDetailsResp":{"type":"object","description":"Response shape for addon service details","title":"GetAddonServiceDetailsResp","x-displayname":"Get Addon Service Details Response","x-ves-oneof-field-activation_type_choice":"[\"managed_activation\",\"partially_managed_activation\",\"self_activation\"]","x-ves-proto-message":"ves.io.schema.pbac.addon_service.GetAddonServiceDetailsResp","properties":{"addon_service_group_display_name":{"type":"string","description":" Display name of the addon service group.\n\nExample: ` \"addon service group 1\"`","title":"addon_service_group_display_name","x-displayname":"Addon Service Group Display Name","x-ves-example":"addon service group 1"},"addon_service_group_name":{"type":"string","description":" Name of the addon service group.\n\nExample: ` \"addon-service-group-1\"`","title":"addon_service_group_name","x-displayname":"Addon Service Group Name","x-ves-example":"addon-service-group-1"},"display_name":{"type":"string","description":" Display Name of the addon service \n\nExample: ` \"addon service 1\"`","title":"display_name","x-displayname":"Display Name","x-ves-example":"addon service 1"},"managed_activation":{"$ref":"#/components/schemas/addon_serviceFullyManagedActivationType"},"partially_managed_activation":{"$ref":"#/components/schemas/addon_servicePartiallyManagedActivationType"},"self_activation":{"$ref":"#/components/schemas/addon_serviceSelfActivationType"},"tier":{"$ref":"#/components/schemas/schemaAddonServiceTierType"}}},"addon_serviceGetAllServiceTiersActivationStatusResp":{"type":"object","description":"Response shape for addon service feature tier activation statuses","title":"GetFeatureTierActivationStatusResp","x-displayname":"Addon Service tier activation statuses Response","x-ves-proto-message":"ves.io.schema.pbac.addon_service.GetAllServiceTiersActivationStatusResp","properties":{"activation_states":{"type":"object","description":" current state of addon service subscription. the key is the name of the service.","title":"state","x-displayname":"State"}}},"addon_serviceGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read addon_service","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.pbac.addon_service.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"},"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"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"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"},"spec":{"$ref":"#/components/schemas/pbacaddon_serviceGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/addon_serviceStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"addon_serviceGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","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"},"addon_serviceListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of addon_service","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.pbac.addon_service.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/addon_serviceListResponseItem"},"x-displayname":"Items"}}},"addon_serviceListResponseItem":{"type":"object","description":"By default a summary of addon_service 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 addon_service","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.pbac.addon_service.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this addon_service","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this addon_service","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates addon_service is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/pbacaddon_serviceGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this addon_service","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this addon_service\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/addon_serviceStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this addon_service\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"addon_serviceNotificationPreference":{"type":"object","description":"NotificationPreference preference for receiving addon subscription notifications.","title":"NotificationPreference","x-displayname":"Notification Preference","x-ves-oneof-field-notification_type":"[\"emails\",\"support_ticket_option\"]","x-ves-proto-message":"ves.io.schema.pbac.addon_service.NotificationPreference","properties":{"emails":{"$ref":"#/components/schemas/pbacEmailDL"},"support_ticket_option":{"$ref":"#/components/schemas/addon_serviceSupportTicketOptions"}}},"addon_servicePartiallyManagedActivationType":{"type":"object","description":"Addon service activation will require partial management from backend or SRE.","title":"PartiallyManagedActivationType","x-displayname":"Partially Managed Activation","x-ves-proto-message":"ves.io.schema.pbac.addon_service.PartiallyManagedActivationType"},"addon_serviceSelfActivationType":{"type":"object","description":"Addon service can be subscribed and activated by user directly without any manual intervention.","title":"SelfActivationType","x-displayname":"Self Activation","x-ves-proto-message":"ves.io.schema.pbac.addon_service.SelfActivationType","properties":{"default_tile_name":{"type":"string","description":" Default landing page for the addon service after successful subscription.\n value should match name of the navigation tile config object.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 32\n","title":"default_tile_name","maxLength":32,"x-displayname":"Default Navigation Tile","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"32"}}}},"addon_serviceStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Status for Addon Service","x-displayname":"Addon Service","x-ves-proto-message":"ves.io.schema.pbac.addon_service.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Config Object"}}},"addon_serviceSupportTicketOptions":{"type":"object","description":"SupportTicketOptions deals with whether the support ticket needs to be created","title":"SupportTicketOptions","x-displayname":"Support Ticket Options","x-ves-oneof-field-support_ticket_creation_choice":"[\"no_support_ticket\",\"support_ticket_with_custom_template\",\"support_ticket_with_default_template\"]","x-ves-proto-message":"ves.io.schema.pbac.addon_service.SupportTicketOptions","properties":{"no_support_ticket":{"$ref":"#/components/schemas/ioschemaEmpty"},"support_ticket_with_custom_template":{"$ref":"#/components/schemas/addon_serviceCustomSupportTicket"},"support_ticket_with_default_template":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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\nBIG-IP Access Policy Manager (APM)\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","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_BIG_IP_APM","SS_DATA_INTELLIGENCE","SS_NGINX_ONE","SS_WEB_APP_SCANNING","SS_ROUTED_DDOS","SS_MOBILE_APP_SHIELD"],"default":"SS_UNKNOWN","x-displayname":"Support Service","x-ves-proto-enum":"ves.io.schema.customer_support.SupportService"},"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"},"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"},"pbacEmailDL":{"type":"object","description":"Addon Subscription Emails associated with the Addon Subscription","title":"EmailDL","x-displayname":"Addon Subscription Associated Emails","x-ves-proto-message":"ves.io.schema.pbac.EmailDL","properties":{"email_ids":{"type":"array","description":" Email ids associated with the Addon Subscription\n\nExample: ` \"abc@email.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.email: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"email_ids","items":{"type":"string"},"x-displayname":"Emails","x-ves-example":"abc@email.com","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.email":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"pbacaddon_serviceGetSpecType":{"type":"object","description":"Get addon_service reads a given object from storage backend for metadata.namespace.","title":"Get addon service","x-displayname":"Get Addon Service","x-ves-displayorder":"1,3,4,5,6,8,9","x-ves-oneof-field-activation_type_choice":"[\"managed_activation\",\"partially_managed_activation\",\"self_activation\"]","x-ves-proto-message":"ves.io.schema.pbac.addon_service.GetSpecType","properties":{"api_groups":{"type":"array","description":" List of references to all api_group objects that belong to this addon service.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n","maxItems":32,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"API Groups","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32"}},"dependent_services":{"type":"array","description":" List of addon services this service dependent on.\n To subscribe/enable this service, all of dependent service should be enabled.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"repeated ves.io.schema.ObjectRefType policy = 7 [(ves.io.schema.ref_to) = \"service_policy\"];","maxItems":32,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Dependent Services","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}},"display_name":{"type":"string","description":" User friendly name for display purpose.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 512\n","maxLength":512,"x-displayname":"Display Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"512"}},"included_services":{"type":"array","description":" List of additional addon services automatically subscribed part of this subscription.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":32,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Included Services","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}},"managed_activation":{"$ref":"#/components/schemas/addon_serviceFullyManagedActivationType"},"partially_managed_activation":{"$ref":"#/components/schemas/addon_servicePartiallyManagedActivationType"},"self_activation":{"$ref":"#/components/schemas/addon_serviceSelfActivationType"},"tags":{"type":"array","description":" Feature tag can flag an addon service as a feature (preview, new, beta, etc) and their combination","items":{"$ref":"#/components/schemas/schemaFeatureTag"},"x-displayname":"Feature tag"},"tier":{"$ref":"#/components/schemas/schemaAddonServiceTierType"}}},"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\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if 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.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\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\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\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][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking 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."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaAddonServiceAccess":{"type":"string","description":"x-displayName: \"Addon Service Access\"\nState of access into service\n\n - AS_AC_NONE: x-displayName: \"None\"\ndefault state\nThis can mean that addon service is not subscribed or is in pending subscription.\n - AS_AC_ALLOWED: x-displayName: \"Allow\"\naccess is allowed\n - AS_AC_PBAC_DENY: x-displayName: \"PBAC Deny\"\nAddon service is not allowed as part of current plan\n - AS_AC_PBAC_DENY_UPGRADE_PLAN: x-displayName: \"PBAC Deny - Upgrade plan\"\nAddon service is not allowed as part of current plan. To enable it, user is requested to uprade the plan\n - AS_AC_PBAC_DENY_CONTACT_SALES: x-displayName: \"PBAC Deny - Contact Sales\"\nAddon service is not allowed as part of current plan. To enable or to find out more, user is requested to contact sales\n - AS_AC_PBAC_DENY_AS_AC_EOL: x-displayName: \"PBAC Deny - End of  Life\"\nAddon service is not allowed as part of current plan as it is discontinued. User is requested to contact sales discuss alternatives","title":"AddonServiceAccess","enum":["AS_AC_NONE","AS_AC_ALLOWED","AS_AC_PBAC_DENY","AS_AC_PBAC_DENY_UPGRADE_PLAN","AS_AC_PBAC_DENY_CONTACT_SALES","AS_AC_PBAC_DENY_AS_AC_EOL"],"default":"AS_AC_NONE"},"schemaAddonServiceState":{"type":"string","description":"State of a service\n\ndefault state\ninitiated subscription request and is pending to activate (requested).\nsuccessfully subscribed\nservice subscription request ended up in error state.","title":"AddonServiceState","enum":["AS_NONE","AS_PENDING","AS_SUBSCRIBED","AS_ERROR"],"default":"AS_NONE","x-displayname":"Addon Service State","x-ves-proto-enum":"ves.io.schema.AddonServiceState"},"schemaAddonServiceTierType":{"type":"string","description":"AddonServiceTierType is for identifying the tier of an addon service\n\n - NO_TIER: none\n\nwhen tier is not applicable for a addon service\n - BASIC: basic\n\nbasic\n - STANDARD: standard\n\nstandard\n - ADVANCED: advanced\n\nadvanced\n - PREMIUM: premium\n\npremium","title":"AddonServiceTierType","enum":["NO_TIER","BASIC","STANDARD","ADVANCED","PREMIUM"],"default":"NO_TIER","x-displayname":"Addon Service Tier","x-ves-proto-enum":"ves.io.schema.AddonServiceTierType"},"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"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. 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\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","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\\\"]"}},"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\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"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"},"schemaErrorType":{"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":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaFeatureTag":{"type":"string","description":"FeatureTag is for identifying the tag of feature of an offering (new, preview)\n\nUnknown (undefined) feature tag\nNew feature tag\nPreview feature tag\nPrivate preview feature tag","title":"FeatureTag","enum":["NONE","NEW","PREVIEW","PRIVATE_PREVIEW"],"default":"NONE","x-displayname":"Feature Tag","x-ves-proto-enum":"ves.io.schema.FeatureTag"},"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"}}},"schemaInitializersType":{"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.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"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\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","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"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"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\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"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\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"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"}}},"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"},"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.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"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\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients 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"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"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\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"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\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}}}}}