@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.signup","description":"Use this API to signup for F5XC service.\none can signup to use volterra service as an individual/free account or\nas a team account more suited for enterprise customers. \nfor more details on what each type of account features, visit - https://console.ves.volterra.io/signup/usage_plan\nsince signup flow includes more complex selections and passing in secure payment processing,\nwe recommend using web UI for this process https://console.ves.volterra.io/signup/start","version":""},"paths":{"/no_auth/countries/{country_code}/states/{prefix}":{"get":{"summary":"List states","description":"Returns a list of known states of a country. List will be empty if country has no states.","operationId":"ves.io.schema.signup.CustomAPI.ListStates","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupListStatesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"country_code","description":"country code\n\nx-example: \"US\"\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`","in":"path","required":true,"x-displayname":"Country code","schema":{"type":"string"}},{"name":"prefix","description":"Prefix\n\nx-example: \"AL for Alabama\"\nfirst two or more characters of the state you look for (can be upper or lower case)","in":"path","required":true,"x-displayname":"Prefix","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-liststates"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ListStates"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/no_auth/countries/{country_code}/states/{state_code}/cities/{prefix}":{"get":{"summary":"List cities","description":"Returns a list of known cities of a country/state.","operationId":"ves.io.schema.signup.CustomAPI.ListCities","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupListCitiesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"country_code","description":"country code\n\nx-example: \"US\"\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`","in":"path","required":true,"x-displayname":"Country code","schema":{"type":"string"}},{"name":"state_code","description":"state code\n\nx-example: \"TN\"\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column `code`, excluding the leading country code","in":"path","required":true,"x-displayname":"State","schema":{"type":"string"}},{"name":"prefix","description":"Prefix\n\nx-example: \"DE\"\nfirst two or more characters of the city you look for (can be upper or lower case)","in":"path","required":true,"x-displayname":"Prefix","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-listcities"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ListCities"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/no_auth/countries/{prefix}":{"get":{"summary":"List countries","description":"Returns a list of supported countries along with with additional information such as address validation rules","operationId":"ves.io.schema.signup.CustomAPI.ListCountries","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupListCountriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"prefix","description":"Prefix\n\nx-example: \"US for USA\"\nfirst two or more characters of the country you look for (can be upper or lower case)","in":"path","required":true,"x-displayname":"Prefix","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-listcountries"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ListCountries"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/no_auth/login/validate_registration":{"post":{"summary":"Validate Registration","description":"ValidateRegistration validates if the signup registration request is valid when a new customer attempts to signup","operationId":"ves.io.schema.signup.CustomAPI.ValidateRegistration","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupValidateRegistrationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupValidateRegistrationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-validateregistration"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ValidateRegistration"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/no_auth/send_password_email":{"post":{"summary":"Send Password Email","description":"SendPasswordEmail enables resetting the password at the time of on-boarding new customer","operationId":"ves.io.schema.signup.CustomAPI.SendPasswordEmail","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupSendPasswordEmailResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupSendPasswordEmailRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-sendpasswordemail"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.SendPasswordEmail"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/no_auth/signup/{name}":{"get":{"summary":"Read Signup","description":"Get allows users to query signup and its status. Use this to query for a status of a submitted signup object.","operationId":"ves.io.schema.signup.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"Signup name\n\nx-example: \"signup-1234-5678-9012-3456\"\nName of the signup we want to retrieve . The name is returned after a signup object submission.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.Get"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/no_auth/validate_contact":{"post":{"summary":"Validate contact","description":"It validates that:\n* the provided country and zip code are not empty\n* the provided country is in the configured list of countries\n* a provided zip code matches a regexp for a given country","operationId":"ves.io.schema.signup.CustomAPI.ValidateContact","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupValidateContactResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupValidateContactRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-validatecontact"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ValidateContact"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/countries/{country_code}/states/{prefix}":{"get":{"summary":"List states","description":"Returns a list of known states of a country. List will be empty if country has no states.","operationId":"ves.io.schema.signup.CustomAPI.ListStates","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupListStatesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"country_code","description":"country code\n\nx-example: \"US\"\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`","in":"path","required":true,"x-displayname":"Country code","schema":{"type":"string"}},{"name":"prefix","description":"Prefix\n\nx-example: \"AL for Alabama\"\nfirst two or more characters of the state you look for (can be upper or lower case)","in":"path","required":true,"x-displayname":"Prefix","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-liststates"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ListStates"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/countries/{country_code}/states/{state_code}/cities/{prefix}":{"get":{"summary":"List cities","description":"Returns a list of known cities of a country/state.","operationId":"ves.io.schema.signup.CustomAPI.ListCities","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupListCitiesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"country_code","description":"country code\n\nx-example: \"US\"\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`","in":"path","required":true,"x-displayname":"Country code","schema":{"type":"string"}},{"name":"state_code","description":"state code\n\nx-example: \"TN\"\n2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column `code`, excluding the leading country code","in":"path","required":true,"x-displayname":"State","schema":{"type":"string"}},{"name":"prefix","description":"Prefix\n\nx-example: \"DE\"\nfirst two or more characters of the city you look for (can be upper or lower case)","in":"path","required":true,"x-displayname":"Prefix","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-listcities"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ListCities"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/countries/{prefix}":{"get":{"summary":"List countries","description":"Returns a list of supported countries along with with additional information such as address validation rules","operationId":"ves.io.schema.signup.CustomAPI.ListCountries","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signupListCountriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"prefix","description":"Prefix\n\nx-example: \"US for USA\"\nfirst two or more characters of the country you look for (can be upper or lower case)","in":"path","required":true,"x-displayname":"Prefix","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-signup-customapi-listcountries"},"x-ves-proto-rpc":"ves.io.schema.signup.CustomAPI.ListCountries"},"x-displayname":"Signup","x-ves-proto-service":"ves.io.schema.signup.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Signup","x-ves-proto-package":"ves.io.schema.signup","components":{"schemas":{"contactContactType":{"type":"string","description":"Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)","title":"Contact Type","enum":["MAILING","BILLING","PAYMENT"],"default":"MAILING","x-displayname":"Contact Type","x-ves-proto-enum":"ves.io.schema.contact.ContactType"},"infraprotect_informationPolicer":{"type":"object","description":"Policer config for bandwidth restrictions","title":"Policer Config","x-displayname":"Policer Config","x-ves-proto-message":"ves.io.schema.infraprotect_information.Policer","properties":{"bandwidth_max_mb":{"type":"integer","description":" Bandwidth max allowed for a customer defined by contract\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 9999\n","title":"Bandwidth Max","format":"int64","x-displayname":"Bandwidth Max in MB","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"9999"}}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaCRMInfo":{"type":"object","description":"CRM Information","title":"CRM Information","x-displayname":"CRM Information","x-ves-proto-message":"ves.io.schema.CRMInfo"},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"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\\\"]"}}}},"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"}}},"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"}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"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"}}},"schemaSyncMode":{"type":"string","description":"Sync mode is to specify where the user details are being synced from.\n\n - SELF: Self\nSystem managed user.\n - SCIM: SCIM\nSCIM synced user. Full user life cycle is managed by the SCIM provider.","title":"Sync Mode","enum":["SELF","SCIM"],"default":"SELF","x-displayname":"Sync Mode","x-ves-proto-enum":"ves.io.schema.SyncMode"},"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"}}},"schemaTaxExemptionType":{"type":"string","description":"TaxExemptionType holds possible tax exemption option.\n\nUNKNOWN indicates the field not being set\nTAX_REGULAR indicates customers that are required to pay taxes\nTAX_EXEMPT indicates customers exempt from paying taxes - their status needs to be verified once signup is completed.\nTAX_EXEMPT indicates customers exempt from paying taxes - their status has been verified and the customer is not being taxed by us.\nTAX_EXEMPT_VERIFICATION_FAILED indicates customers that the tax exempt verification process failed - they can contact F5XC to get more details\nTAX_EXEMPT_VERIFICATION_PENDING indicates customers that the tax exempt verification process is ongoing","title":"TaxExemptionType","enum":["TAX_UNKNOWN","TAX_REGULAR","TAX_EXEMPT_UNVERIFIED","TAX_EXEMPT_VERIFIED","TAX_EXEMPT_VERIFICATION_FAILED","TAX_EXEMPT_VERIFICATION_PENDING"],"default":"TAX_UNKNOWN","x-displayname":"Tax Exemption","x-ves-proto-enum":"ves.io.schema.TaxExemptionType"},"schemaTenantType":{"type":"string","description":"TenantType is the type of the customer\n\nUNKNOWN indicates the field not being set\nFREEMIUM are customer that don't have their domain\nENTERPRiISE customer have their domain","title":"TenantType","enum":["UNKNOWN","FREEMIUM","ENTERPRISE"],"default":"UNKNOWN","x-displayname":"Tenant type","x-ves-proto-enum":"ves.io.schema.TenantType"},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"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"}}},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"schemacontactGlobalSpecType":{"type":"object","description":"Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.","title":"Contact","x-displayname":"Contact","x-ves-proto-message":"ves.io.schema.contact.GlobalSpecType","properties":{"address1":{"type":"string","description":"\n\nExample: ` \"1234 Main road\"`","title":"address1","x-displayname":"Address Line 1","x-ves-example":"1234 Main road"},"address2":{"type":"string","description":"\n\nExample: ` \"P.O BOX 56\"`","title":"address2","x-displayname":"Address Line 2","x-ves-example":"P.O BOX 56"},"city":{"type":"string","description":"\n\nExample: ` \"Sunnyvale\"`","title":"city","x-displayname":"City","x-ves-example":"Sunnyvale"},"contact_type":{"$ref":"#/components/schemas/contactContactType"},"country":{"type":"string","description":"\n\nExample: ` \"US\"`","title":"country","x-displayname":"Country","x-ves-example":"US"},"county":{"type":"string","description":"\n\nExample: ` \"Santa Clara\"`","title":"county","x-displayname":"County","x-ves-example":"Santa Clara"},"phone_number":{"type":"string","description":"\n\nExample: ` \"+11234567890\"`","title":"phone_number","x-displayname":"Phone Number","x-ves-example":"+11234567890"},"state":{"type":"string","description":"\n\nExample: ` \"California\"`","title":"state","x-displayname":"State","x-ves-example":"California"},"state_code":{"type":"string","description":"\n\nExample: ` \"CA\"`","title":"state code","x-displayname":"State Code","x-ves-example":"CA"},"zip_code":{"type":"string","description":"\n\nExample: ` \"95054\"`","title":"zip_code","x-displayname":"ZIP code","x-ves-example":"95054"}}},"schemainfraprotect_informationGlobalSpecType":{"type":"object","description":"Organisation information","title":"Information","x-displayname":"Information","x-ves-oneof-field-as_path_choice":"[\"as_path_choice_full\",\"as_path_choice_none\",\"as_path_choice_origin\"]","x-ves-oneof-field-default_tunnel_bgp_secret_choice":"[\"default_tunnel_bgp_secret\",\"default_tunnel_bgp_secret_none\"]","x-ves-oneof-field-route_advertisement_management_choice":"[\"route_advertisement_mgmt_not_specified\",\"route_advertisement_mgmt_not_using_f5xc\",\"route_advertisement_mgmt_using_f5xc\"]","x-ves-oneof-field-tunnel_f5_ip_usage_choice":"[\"reuse_ips\",\"use_dedicated_ips\"]","x-ves-proto-message":"ves.io.schema.infraprotect_information.GlobalSpecType","properties":{"arbor_cid":{"type":"string","description":" L3/L4 provider customer ID\n\nExample: ` \"value\"`","title":"L3/L4 CID","x-displayname":"L3/L4 CID","x-ves-example":"value"},"as_path_choice_full":{"$ref":"#/components/schemas/schemaEmpty"},"as_path_choice_none":{"$ref":"#/components/schemas/schemaEmpty"},"as_path_choice_origin":{"$ref":"#/components/schemas/schemaEmpty"},"asn":{"type":"integer","description":" AS Number\n\nExample: ` \"0\"`","title":"asn","format":"int32","x-displayname":"ASN","x-ves-example":"0"},"default_tunnel_bgp_secret":{"$ref":"#/components/schemas/schemaSecretType"},"default_tunnel_bgp_secret_none":{"$ref":"#/components/schemas/schemaEmpty"},"policer":{"$ref":"#/components/schemas/infraprotect_informationPolicer"},"prefixes":{"type":"array","description":" List of tenant 'super' prefixes noted in CIDR\n\nExample: ` \"value\"`","title":"prefixes","items":{"type":"string"},"x-displayname":"Super prefixes","x-ves-example":"value"},"primary_network_name":{"type":"string","description":" Name of the default customer network\n\nExample: ` \"defensenet_local\"`","title":"Primary Network Name","x-displayname":"Primary network name","x-ves-example":"defensenet_local"},"reuse_ips":{"$ref":"#/components/schemas/schemaEmpty"},"route_advertisement_mgmt_not_specified":{"$ref":"#/components/schemas/schemaEmpty"},"route_advertisement_mgmt_not_using_f5xc":{"$ref":"#/components/schemas/schemaEmpty"},"route_advertisement_mgmt_using_f5xc":{"$ref":"#/components/schemas/schemaEmpty"},"use_dedicated_ips":{"$ref":"#/components/schemas/schemaEmpty"},"uuid":{"type":"string","description":" Organisation UUID\n\nExample: ` \"value\"`","title":"uuid","x-displayname":"Uuid","x-ves-example":"value"}}},"schemasignupErrorCode":{"type":"string","description":"ErrorCode is used to know the specific reason for signup registration failures\n\n - ETOKEN_OK: token related codes go here\n - EUSER_OK: user related codes go here\n - ECONTACT_VALIDATE_OK: contact validation codes go here\nValidation is ok\n - ECONTACT_EMPTY_COUNTRY: Empty country during validation of a contact\n - ECONTACT_EMPTY_ZIP_CODE: Empty zip code during validation of a contact\n - ECONTACT_UNKNOWN_COUNTRY: A given country is not present in the configured list of country-zipCodeRegexp\n - ECONTACT_INVALID_ZIP: A given zip doesn't match a configured regexp for a given country\n - EOK: EOK indicates no error\n - ENO_STATES: ENO_STATES indicates no states in a country\n - ENO_CITIES: ENO_CITIES indicates no cities in country/state","title":"error code","enum":["EUNKNOWN","ETOKEN_OK","ETOKEN_FAILED","ETOKEN_NOTFOUND","ETOKEN_USED","ETOKEN_EXPIRED","EUSER_OK","EUSER_EXISTS","EUSER_FAILED","ECONTACT_VALIDATE_OK","ECONTACT_EMPTY_COUNTRY","ECONTACT_EMPTY_ZIP_CODE","ECONTACT_UNKNOWN_COUNTRY","ECONTACT_INVALID_ZIP","EOK","ENO_STATES","ENO_CITIES"],"default":"EUNKNOWN","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.signup.ErrorCode"},"schemasignupGlobalSpecType":{"type":"object","description":"desired state of Signup","title":"Signup specification","x-displayname":"Signup","x-ves-proto-message":"ves.io.schema.signup.GlobalSpecType","properties":{"billing_address":{"$ref":"#/components/schemas/schemacontactGlobalSpecType"},"billing_provider_account_id":{"type":"string","description":" Id of the billing provider account created to verify the billing info provided with this object.\n The id is then used to ensure no more duplicate billing account is created.","title":"billing_provider_account_id","x-displayname":"Billing provider account id"},"company":{"$ref":"#/components/schemas/schemauserGlobalSpecType"},"company_contact":{"$ref":"#/components/schemas/schemacontactGlobalSpecType"},"company_name":{"type":"string","description":" company name (enterprise only)\n\nExample: ` \"ACME Ltd.\"`","title":"company name","x-displayname":"Company Name","x-ves-example":"ACME Ltd."},"contact_number":{"type":"string","description":" phone contact number\n obsolete\n\nExample: ` \"+11234567890\"`","title":"contact_number","x-displayname":"Contact Number","x-ves-example":"+11234567890"},"crm_details":{"$ref":"#/components/schemas/schemaCRMInfo"},"currency":{"type":"string","description":" preferred currency on the tenant level - individual billing accounts may\n override this.\n\nExample: ` \"USD\"`","title":"currency","x-displayname":"Currency","x-ves-example":"USD"},"customer":{"$ref":"#/components/schemas/schemauserGlobalSpecType"},"customer_contact":{"$ref":"#/components/schemas/schemacontactGlobalSpecType"},"domain":{"type":"string","description":" domain the customer chose to use - enterprise customers only.\n\nExample: ` \"value\"`","title":"domain","x-displayname":"Domain","x-ves-example":"value"},"email":{"type":"string","description":" email of the customer (ideally someone who's responsible for the company\n account)\n obsolete\n\nExample: ` \"customer@email.com\"`","title":"email","x-displayname":"Email","x-ves-example":"customer@email.com"},"first_name":{"type":"string","description":" first name of the customer\n obsolete\n\nExample: ` \"John\"`","title":"first_name","x-displayname":"First Name","x-ves-example":"John"},"infraprotect_info":{"$ref":"#/components/schemas/schemainfraprotect_informationGlobalSpecType"},"last_name":{"type":"string","description":" last name of the customer (the superuser)\n obsolete\n\nExample: ` \"Doe\"`","title":"last_name","x-displayname":"Last Name","x-ves-example":"Doe"},"locale":{"type":"string","description":" locale of this sign up\n\nExample: ` \"en-us\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"locale","x-displayname":"Locale","x-ves-example":"en-us","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"payment_provider_token":{"type":"string","description":" payment provider token (for credit card details)\n\nExample: ` \"tok_1234567890\"`","title":"payment_provider_token","x-displayname":"Payment Provider Token","x-ves-example":"tok_1234567890"},"support_plan_name":{"type":"string","description":" what sort of support plan the customer will be on.\n\nExample: ` \"xxxx-yyyy-zzzz-1111\"`","title":"support_plan_name","x-displayname":"Support Plan Name","x-ves-example":"xxxx-yyyy-zzzz-1111"},"tax_exempt":{"$ref":"#/components/schemas/schemaTaxExemptionType"},"token":{"type":"string","description":" token of the user requesting for.\n Valid tokens are internally generated in the system and shared with respective customers.\n Onboarding of new customers will proceed only when a valid token along with the email is provided during the signup process.\n\nExample: ` \"tok_1234567890\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"token of the user","x-displayname":"Token","x-ves-example":"tok_1234567890","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"tos_accepted":{"type":"string","description":" t&c accepted date as millis from 01/01/1970 UTC\n\nExample: ` \"1569926163000\"`","title":"tos_accepted","format":"int64","x-displayname":"TOS Accepted","x-ves-example":"1569926163000"},"tos_accepted_at":{"type":"string","description":" tos accepted timestamp.\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"tos_accepted_at","format":"date-time","x-displayname":"TosAcceptedAt","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"tos_version":{"type":"string","description":" indicates the version of ToS customer approved during signup. Any new version will require the customer to re-approve during login.\n\nExample: ` \"v1.2\"`","title":"version of terms of services the customer accepted","x-displayname":"TOS version","x-ves-example":"v1.2"},"type":{"$ref":"#/components/schemas/schemaTenantType"},"usage_plan_name":{"type":"string","description":" what sort of usage plan the customer will be on.\n\nExample: ` \"xxxx-yyyy-zzzz-1111\"`","title":"usage_plan_name","x-displayname":"Usage Plan Name","x-ves-example":"xxxx-yyyy-zzzz-1111"}}},"schemauserGlobalSpecType":{"type":"object","title":"GlobalSpecType","x-displayname":"Global Specification","x-ves-proto-message":"ves.io.schema.user.GlobalSpecType","properties":{"contacts":{"type":"array","description":" Contact information for user","title":"contacts","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Contact"},"domain_owner":{"type":"boolean","description":" Domain owner is the first user who registered or signed up the associated Tenant.\n User created via signup flow will have this value set to true.\n Few restrictions apply to this user w.r.t role update and deletion.\n\nExample: ` \"true\"`","title":"Domain Owner","format":"boolean","x-displayname":"Domain Owner","x-ves-example":"true"},"email":{"type":"string","description":" user's email\n\nExample: ` \"value\"`","title":"email","x-displayname":"Email","x-ves-example":"value"},"first_name":{"type":"string","description":" user's first name\n\nExample: ` \"value\"`","title":"first_name","x-displayname":"First Name","x-ves-example":"value"},"groups":{"type":"array","description":" Reference to the user groups.","title":"Groups","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Groups"},"idm_type":{"$ref":"#/components/schemas/userIdmType"},"last_login_timestamp":{"type":"string","description":" Last successful login timestamp of the user.","title":"last_login_timestamp","format":"date-time","x-displayname":"Last Login Timestamp"},"last_name":{"type":"string","description":" user's last name\n\nExample: ` \"value\"`","title":"last_name","x-displayname":"Last Name","x-ves-example":"value"},"locale":{"type":"string","description":" locale of the user (defaults to English)\n\nExample: ` \"value\"`","title":"locale","x-displayname":"Locale","x-ves-example":"value"},"state":{"$ref":"#/components/schemas/userFSMState"},"sync_mode":{"$ref":"#/components/schemas/schemaSyncMode"},"tos_accepted":{"type":"string","description":" tos accepted version, this field is deprecated refer the fields `tos_accepted_at` and `tos_version` instead.\n\nExample: ` \"1.0\"`","title":"tos_accepted","x-displayname":"TOS Accepted","x-ves-example":"1.0"},"tos_accepted_at":{"type":"string","description":" tos accepted timestamp.\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"tos_accepted_at","format":"date-time","x-displayname":"TOS Accepted Timestamp","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"tos_version":{"type":"string","description":" tos accepted version\n\nExample: ` \"v1.0\"`","title":"tos_version","x-displayname":"TOS version","x-ves-example":"v1.0"},"type":{"$ref":"#/components/schemas/userUserType"}}},"signupCityItem":{"type":"object","description":"CityItem contains a single element of city list response.","title":"City item","x-displayname":"City item","x-ves-proto-message":"ves.io.schema.signup.CityItem","properties":{"additional_info":{"type":"object","description":" Any additional information related to the city\n\nExample: ` \"[alternative_name:Madras]\"`","title":"additional information","x-displayname":"additional information","x-ves-example":"[alternative_name:Madras]"},"city_name":{"type":"string","description":" Name of the city in the human readable form (can be used as a description)\n\nExample: ` \"Chennai\"`","title":"city name","x-displayname":"City","x-ves-example":"Chennai"}}},"signupCountryItem":{"type":"object","description":"CountryItem contains a single element of country list response.","title":"Country item","x-displayname":"Country item","x-ves-proto-message":"ves.io.schema.signup.CountryItem","properties":{"additional_info":{"type":"object","description":" Any additional information related to the country\n\nExample: ` \"[zip_code_validation:^.{2,}$]\"`","title":"additional information","x-displayname":"additional information","x-ves-example":"[zip_code_validation:^.{2,}$]"},"country_code":{"type":"string","description":" x-displayName : \"Country code\"\n 2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column `alpha-2`\n\nExample: ` \"US\"`","title":"country code","x-ves-example":"US"},"country_name":{"type":"string","description":" Name of the country in the human readable form (can be used as a description)\n\nExample: ` \"USA\"`","title":"country name","x-displayname":"Country name","x-ves-example":"USA"}}},"signupGetResponse":{"type":"object","description":"Signup object including its status. Use it when you want to see the progress of the signup flow.","title":"Get response","x-displayname":"Signup Get Response","x-ves-proto-message":"ves.io.schema.signup.GetResponse","properties":{"object":{"$ref":"#/components/schemas/signupObject"},"status":{"type":"array","description":" Signup object status, including any failures.","title":"Signup status object","items":{"$ref":"#/components/schemas/signupStatusObject"},"x-displayname":"Signup Status Object"}}},"signupListCitiesResponse":{"type":"object","description":"ListCitiesResponse contains a list of cities (for a country) supported by the platform","title":"City list response","x-displayname":"City response","x-ves-proto-message":"ves.io.schema.signup.ListCitiesResponse","properties":{"cities":{"type":"array","description":" List of all cities in","title":"available cities in the country","items":{"$ref":"#/components/schemas/signupCityItem"},"x-displayname":"Cities"},"error_code":{"$ref":"#/components/schemas/schemasignupErrorCode"}}},"signupListCountriesResponse":{"type":"object","description":"ListCountriesResponse contains a list of countries supported by the platform","title":"Country list response","x-displayname":"Country response","x-ves-proto-message":"ves.io.schema.signup.ListCountriesResponse","properties":{"countries":{"type":"array","description":" List of all countries supported by the platform","title":"available  countries","items":{"$ref":"#/components/schemas/signupCountryItem"},"x-displayname":"Countries"}}},"signupListStatesResponse":{"type":"object","description":"ListStatesResponse contains a list of states supported by the platform","title":"Country list response","x-displayname":"Country response","x-ves-proto-message":"ves.io.schema.signup.ListStatesResponse","properties":{"error_code":{"$ref":"#/components/schemas/schemasignupErrorCode"},"states":{"type":"array","description":" List of all states of a country supported by the platform","title":"available states in a country","items":{"$ref":"#/components/schemas/signupStateItem"},"x-displayname":"States"}}},"signupObject":{"type":"object","description":"signup object","title":"Signup","x-displayname":"Signup","x-ves-proto-message":"ves.io.schema.signup.Object","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectMetaType"},"spec":{"$ref":"#/components/schemas/signupSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectMetaType"}}},"signupSendPasswordEmailRequest":{"type":"object","description":"SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer","title":"Request to resend password email","x-displayname":"Signup Resend Password Email Request","x-ves-proto-message":"ves.io.schema.signup.SendPasswordEmailRequest","properties":{"cname":{"type":"string","description":" domain under which the tenant belongs to\n\nExample: ` \"volterra\"`","title":"cname","x-displayname":"Domain Name","x-ves-example":"volterra"},"email":{"type":"string","description":" email of the user requesting for\n\nExample: ` \"admin@email.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"email of the user","x-displayname":"email","x-ves-example":"admin@email.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"signupSendPasswordEmailResponse":{"type":"object","description":"SendPasswordEmailResponse is an empty response after an email had been sent..","title":"Send password email response","x-displayname":"Send Password Email Response","x-ves-proto-message":"ves.io.schema.signup.SendPasswordEmailResponse"},"signupSpecType":{"type":"object","description":"Shape of the signup specification","title":"Signup specification","x-displayname":"Signup object specification","x-ves-proto-message":"ves.io.schema.signup.SpecType","properties":{"gc_spec":{"$ref":"#/components/schemas/schemasignupGlobalSpecType"}}},"signupStateItem":{"type":"object","description":"CountryItem contains a single element of country list response.","title":"Country item","x-displayname":"Country item","x-ves-proto-message":"ves.io.schema.signup.StateItem","properties":{"additional_info":{"type":"object","description":" Any additional information related to the state\n\nExample: ` \"[zip_code_validation:^.{2,}$]\"`","title":"additional information","x-displayname":"additional information","x-ves-example":"[zip_code_validation:^.{2,}$]"},"state_code":{"type":"string","description":" 2 characters state code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column `code` (excluding the leading country code)\n\nExample: ` \"TN\"`","title":"state code","x-displayname":"State code","x-ves-example":"TN"},"state_name":{"type":"string","description":" Name of the state in the human readable form (can be used as a description)\n\nExample: ` \"Tamil Nadu\"`","title":"state name","x-displayname":"State name","x-ves-example":"Tamil Nadu"}}},"signupStatusObject":{"type":"object","description":"Most recently observed status of signup object","title":"Signup status","x-displayname":"Signup object status","x-ves-proto-message":"ves.io.schema.signup.StatusObject","properties":{"billingAccount":{"type":"array","title":"Billing account reference","items":{"$ref":"#/components/schemas/schemaObjectRefType"}},"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"},"tenant":{"type":"array","title":"Tenant reference","items":{"$ref":"#/components/schemas/schemaObjectRefType"}},"user":{"type":"array","title":"User reference","items":{"$ref":"#/components/schemas/schemaObjectRefType"}}}},"signupValidateContactRequest":{"type":"object","description":"Validate contacts request","title":"Request to validate contact","x-displayname":"Validate contact request","x-ves-proto-message":"ves.io.schema.signup.ValidateContactRequest","properties":{"name":{"type":"string","description":" The name of the configuration object to be fetched. Is not used for now.\n\nExample: ` \"value\"`","title":"name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" The namespace in which the configuration object is present. Is not used for now.\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"spec":{"$ref":"#/components/schemas/schemacontactGlobalSpecType"}}},"signupValidateContactResponse":{"type":"object","description":"ValidateRegistrationResponse is the response that indicates if the contact is valid or not.\nIf the contact is not valid, a corresponding error code is returned.\nA list of supported validation is provided under Validate rpc call documentation.","title":"Response to validate contact","x-displayname":"Validate contact response","x-ves-proto-message":"ves.io.schema.signup.ValidateContactResponse","properties":{"err":{"$ref":"#/components/schemas/schemasignupErrorCode"},"is_valid":{"type":"boolean","description":" flag indicates if the contact is valid\n\nExample: ` \"true\"`","title":"Is a valid contact","format":"boolean","x-displayname":"Is Contact Valid","x-ves-example":"true"},"validation_errors":{"type":"array","description":" x-displayName : \"Validation errors\"\n collection of validation errors","title":"validation errors","items":{"$ref":"#/components/schemas/signupValidationErrorField"}}}},"signupValidateRegistrationRequest":{"type":"object","description":"ValidateRegistrationRequest is the request body parameeters required to validate the registration","title":"Request to validate registration","x-displayname":"Request to Validate Registration","x-ves-proto-message":"ves.io.schema.signup.ValidateRegistrationRequest","properties":{"email":{"type":"string","description":" email of the user requesting for\n\nExample: ` \"admin@email.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"email of the user","x-displayname":"Email","x-ves-example":"admin@email.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"tenant_type":{"$ref":"#/components/schemas/schemaTenantType"},"token":{"type":"string","description":" token of the user requesting for\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"token of the user","x-displayname":"Token","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"signupValidateRegistrationResponse":{"type":"object","description":"ValidateRegistrationResponse is the response that indicates if the registration is valid or not.\nFor a brand new registration, the valid_registration is set to true that indicates that signup flow can flow through.\nIn case of an existing user, the valid_registration is set to false.","title":"Response to validate registration","x-displayname":"Response to Validate Resistration","x-ves-proto-message":"ves.io.schema.signup.ValidateRegistrationResponse","properties":{"err":{"$ref":"#/components/schemas/schemasignupErrorCode"},"valid_registration":{"type":"boolean","description":" valid registration flag indicates if the registration is valid\n\nExample: ` \"true\"`","title":"Valid registration","format":"boolean","x-displayname":"Valid Registration","x-ves-example":"true"}}},"signupValidationErrorField":{"type":"object","description":"Contains information on a single validation error","title":"Validation error field","x-displayname":"Validation error field","x-ves-proto-message":"ves.io.schema.signup.ValidationErrorField","properties":{"error_field":{"type":"string","description":" path indicates the field that is not valid\n\nExample: ` \"zip_code\"`","title":"Error field","x-displayname":"Error field","x-ves-example":"zip_code"},"error_message":{"type":"string","description":" more descriptive error message\n\nExample: ` \"Zip code should be a 000-00000 format\"`","title":"Error message","x-displayname":"Error message","x-ves-example":"Zip code should be a 000-00000 format"}}},"userFSMState":{"type":"string","description":"States describes possible states for user.\n\n - StateUndefined: StateUndefined\n\nUser state when it was created without any state.\n - StateCreating: StateCreating\n\nUser state during initial creation. It includes registering in IDM, creating user-settings object, etc...\n - StateCreateFailed: StateCreateFailed\n\nUser state when initial creation was failed by some reason and must be retried\nafter issue is solved.\n - StateActive: StateActive\n\nUser state of completely created and available to use user.\n - StateDisabled: StateDisabled\n\nUser is currently disabled, login is not possible for this user, but it may become active again in the future.","title":"States","enum":["StateUndefined","StateCreating","StateCreateFailed","StateActive","StateDisabled"],"default":"StateUndefined","x-displayname":"States","x-ves-proto-enum":"ves.io.schema.user.FSMState"},"userIdmType":{"type":"string","description":"IdmType is to identify who is managing the user.\n\n - SSO: SSO User\nExternally managed Single Sign On based user imported into UAM.\n - VOLTERRA_MANAGED: F5XC Managed Local user\nF5XC managed local user. Full user life cycle is managed by volterra UAM and Identity.\n - UNDEFINED: Undefined\nUndefined IDM type","title":"IDM Type","enum":["SSO","VOLTERRA_MANAGED","UNDEFINED"],"default":"SSO","x-displayname":"Identity Management Type","x-ves-proto-enum":"ves.io.schema.user.IdmType"},"userUserType":{"type":"string","description":"UserType is to identify the type of user\n\n - USER: User\nRegular User\n - SERVICE: Service User\nUser for accessing only APIs/services\n - DEBUG: Debug\nUser which was created by tenant admin for volterra-support team.","title":"UserType","enum":["USER","SERVICE","DEBUG"],"default":"USER","x-displayname":"User Type","x-ves-proto-enum":"ves.io.schema.user.UserType"}}}}