@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.tenant","description":"Package for working with Tenant representation.","version":""},"paths":{"/no_auth/cname/lookup":{"get":{"summary":"Lookup cname","description":"Checks if a cname is available.","operationId":"ves.io.schema.tenant.CustomAPI.LookupCname","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"cname","description":"x-example: \"domain1\"\nCname to look-uo","in":"query","required":false,"x-displayname":"Cname","schema":{"type":"string"}},{"name":"namespace","description":"x-example: \"system\"\nNamespace to query","in":"query","required":false,"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-tenant-customapi-lookupcname"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.LookupCname"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/no_auth/tenant/idm/settings/password_policy":{"get":{"summary":"GetPasswordPolicy","description":"GetPasswordPolicy returns password policy for tenant.","operationId":"ves.io.schema.tenant.CustomAPI.GetPasswordPolicy","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantPasswordPolicyPublicAccess"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"realm_id","description":"x-example: \"3d05688b-f560-4f70-9af1-384a0ec0ff15\"\nuser's email","in":"query","required":false,"x-displayname":"Email","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getpasswordpolicy"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetPasswordPolicy"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/domain_owner/assign":{"post":{"summary":"Assign domain owner","description":"Assign domain owner tries to assign domain owner to user in the request. It checks that requester is domain owner as well.\nIt implies such steps:\n1) mark user as domain owner\n2) if user is SSO\n - mark user as volterra managed\n - send update password email\n3) set admin roles in system, shared, * namespaces\nNOTE: previous roles (which was explicitly assigned to this user) will be deleted","operationId":"ves.io.schema.tenant.CustomAPI.AssignDomainOwner","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenantAssignDomainOwnerRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-assigndomainowner"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.AssignDomainOwner"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/domain_owner/unassign":{"post":{"summary":"Unassign domain owner","description":"Unassign domain owner tries to remove domain owner privilege from user in the request.\nIt checks that requester is domain owner.\nIt implies such steps:\n1) remove domain owner boolean flag\n2) if tenant has SSO enabled:\n - mark user as SSO\n - delete password credential\n - delete OTP credential (if exists)\nNOTE: previously granted roles (including admin roles) will be retained","operationId":"ves.io.schema.tenant.CustomAPI.UnassignDomainOwner","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenantUnassignDomainOwnerRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-unassigndomainowner"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.UnassignDomainOwner"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/idm/events/last_login":{"get":{"summary":"GetLastLoginMap","description":"GetLastLoginMap returns last login timestamp for each user within a tenant.","operationId":"ves.io.schema.tenant.CustomAPI.GetLastLoginMap","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantLastLoginMap"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getlastloginmap"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetLastLoginMap"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/idm/events/login":{"get":{"summary":"GetLoginEvents","description":"GetLoginEvents returns login events for specified in config period of time. It consider all users within current tenant.\nLogin events are extracted directly from IDM.","operationId":"ves.io.schema.tenant.CustomAPI.GetLoginEvents","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantLoginEventsMap"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"first","description":"x-example: \"100\"\nStart offset","in":"query","required":false,"x-displayname":"First","schema":{"type":"integer","format":"int64"}},{"name":"max","description":"x-example: \"25\"\nRecords per page","in":"query","required":false,"x-displayname":"Max","schema":{"type":"integer","format":"int64"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getloginevents"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetLoginEvents"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/idm/events/login_in_time":{"post":{"summary":"GetLoginEventsInTimeFrame","description":"GetLoginEventsInTimeFrame returns login events for specified period of time. It consider all users specified by context tenant.","operationId":"ves.io.schema.tenant.CustomAPI.GetLoginEventsInTimeFrame","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantLoginEventsMap"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenantGetLoginEventsInTimeFrameRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getlogineventsintimeframe"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetLoginEventsInTimeFrame"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/idm/settings":{"get":{"summary":"GetIDMSettings","description":"GetIDMSettings returns IDM settings for tenant. IDM settings contains info like password policy,\nbrute-force detection policy, etc...","operationId":"ves.io.schema.tenant.CustomAPI.GetIDMSettings","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewstenant_configurationGlobalSpecType"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getidmsettings"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetIDMSettings"},"put":{"summary":"UpdateIDMSettings","description":"UpdateIDMSettings allows to adjust IDM settings for tenant, like password policy, brute-force detection policy, etc...","operationId":"ves.io.schema.tenant.CustomAPI.UpdateIDMSettings","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/viewstenant_configurationGlobalSpecType"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-updateidmsettings"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.UpdateIDMSettings"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/idm/users/inactive":{"get":{"summary":"ListInactiveUsers","description":"Returns list of users for which no login events was found for last 90 days of time.\nIt consider all users within current tenant.","operationId":"ves.io.schema.tenant.CustomAPI.ListInactiveUsers","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantUserList"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-listinactiveusers"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.ListInactiveUsers"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/lookup":{"get":{"summary":"Lookup cname","description":"Checks if a cname is available.","operationId":"ves.io.schema.tenant.CustomAPI.LookupCname","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"cname","description":"x-example: \"domain1\"\nCname to look-uo","in":"query","required":false,"x-displayname":"Cname","schema":{"type":"string"}},{"name":"namespace","description":"x-example: \"system\"\nNamespace to query","in":"query","required":false,"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-tenant-customapi-lookupcname"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.LookupCname"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/request-delete":{"post":{"summary":"Delete Tenant","description":"Request to mark Tenant for deletion queue, after approve it will completely removed from the system.","operationId":"ves.io.schema.tenant.CustomAPI.DeleteTenant","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenantDeleteTenantRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-deletetenant"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.DeleteTenant"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/settings":{"get":{"summary":"Tenant Settings","description":"Receive current tenant settings.","operationId":"ves.io.schema.tenant.CustomAPI.GetTenantSettings","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantTenantSettingsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-gettenantsettings"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetTenantSettings"},"put":{"summary":"Tenant Settings","description":"Tenant settings","operationId":"ves.io.schema.tenant.CustomAPI.UpdateTenantSettings","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantUpdateTenantSettingsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenantUpdateTenantSettingsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-updatetenantsettings"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.UpdateTenantSettings"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/settings/otp/disable":{"put":{"summary":"Disable tenant level OTP","description":"Disable tenant level OTP disables OTP on tenant-level. After it's disabled it's up to user whether to enable OTP.","operationId":"ves.io.schema.tenant.CustomAPI.DisableTenantLevelOTP","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/schematenantEmpty"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-disabletenantlevelotp"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.DisableTenantLevelOTP"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/settings/otp/enable":{"put":{"summary":"Enable tenant level OTP","description":"Enable tenant level OTP enables OTP on tenant-level. It enforces each user within a tenant to enable OTP.","operationId":"ves.io.schema.tenant.CustomAPI.EnableTenantLevelOTP","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/schematenantEmpty"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-enabletenantlevelotp"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.EnableTenantLevelOTP"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/settings/tenant/favicon":{"get":{"summary":"Tenant favicon","description":"Receive current tenant favicon.","operationId":"ves.io.schema.tenant.CustomAPI.GetFavIcon","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getfavicon"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetFavIcon"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/settings/tenant/image":{"get":{"summary":"Tenant profile image","description":"Receive current tenant profile image.","operationId":"ves.io.schema.tenant.CustomAPI.GetImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getimage"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetImage"},"delete":{"summary":"Delete tenant profile image","description":"Delete profile image for the tenant entity.","operationId":"ves.io.schema.tenant.CustomAPI.DeleteImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-deleteimage"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.DeleteImage"},"put":{"summary":"Update tenant profile image","description":"Uploads new profile image for the tenant entity.","operationId":"ves.io.schema.tenant.CustomAPI.UpdateImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenantUpdateImageRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-updateimage"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.UpdateImage"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/settings/tenant/logo":{"get":{"summary":"Tenant logo","description":"Receive current tenant logo.","operationId":"ves.io.schema.tenant.CustomAPI.GetLogo","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getlogo"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetLogo"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/support-info":{"get":{"summary":"Support Info","description":"Receive support information for tenant","operationId":"ves.io.schema.tenant.CustomAPI.GetSupportInfo","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantSupportInfo"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getsupportinfo"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetSupportInfo"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant/tenant-escalation-doc":{"get":{"summary":"Tenant escalation document","description":"Receive current tenant escalation document.","operationId":"ves.io.schema.tenant.CustomAPI.GetTenantEscalationDoc","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-gettenantescalationdoc"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetTenantEscalationDoc"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/saas/namespaces/system/v2/tenant/deactivate":{"put":{"summary":"DeactivateTenant","description":"This API mark tenant for deletion queue, after approve it will completely removed from the system. This API proxies the request to eywa’s tenant disable API.","operationId":"ves.io.schema.tenant.CustomAPIEywaprime.DeactivateTenant","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantDeactivateTenantResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenantDeactivateTenantRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapieywaprime-deactivatetenant"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPIEywaprime.DeactivateTenant"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPIEywaprime","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/static/namespaces/system/tenant/settings/tenant/favicon":{"get":{"summary":"Tenant favicon","description":"Receive current tenant favicon.","operationId":"ves.io.schema.tenant.CustomAPI.GetFavIcon","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getfavicon"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetFavIcon"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/static/namespaces/system/tenant/settings/tenant/image":{"get":{"summary":"Tenant profile image","description":"Receive current tenant profile image.","operationId":"ves.io.schema.tenant.CustomAPI.GetImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-customapi-getimage"},"x-ves-proto-rpc":"ves.io.schema.tenant.CustomAPI.GetImage"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/tenants/{tenant}/summary":{"get":{"summary":"Summary","description":"This API returns tenant summary","operationId":"ves.io.schema.tenant.TenantSummaryCustomAPI.Summary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantSummaryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"tenant","description":"Tenant ID\n\nTenant ID","in":"path","required":true,"x-displayname":"Tenant ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant-tenantsummarycustomapi-summary"},"x-ves-proto-rpc":"ves.io.schema.tenant.TenantSummaryCustomAPI.Summary"},"x-displayname":"Tenant","x-ves-proto-service":"ves.io.schema.tenant.TenantSummaryCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Tenant","x-ves-proto-package":"ves.io.schema.tenant","components":{"requestBodies":{"schematenantEmpty":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenantEmpty"}}},"required":true}},"schemas":{"apiHttpBody":{"type":"object","description":"Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n    message GetResourceRequest {\n      // A unique request id.\n      string request_id = 1;\n\n      // The raw HTTP body is bound to this field.\n      google.api.HttpBody http_body = 2;\n    }\n\n    service ResourceService {\n      rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n      rpc UpdateResource(google.api.HttpBody) returns\n      (google.protobuf.Empty);\n    }\n\nExample with streaming methods:\n\n    service CaldavService {\n      rpc GetCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n      rpc UpdateCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n    }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.","properties":{"content_type":{"type":"string","description":"The HTTP Content-Type header value specifying the content type of the body."},"data":{"type":"string","description":"The HTTP request/response body as raw binary.","format":"byte"},"extensions":{"type":"array","description":"Application specific response metadata. Must be set in the first response\nfor streaming APIs.","items":{"$ref":"#/components/schemas/protobufAny"}}}},"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"}}},"schematenantEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.tenant.Empty"},"schematenantFSMState":{"type":"string","description":"Tenant states https://gitlab.com/volterra/ves.io/eywa/-/wikis/Tenant-State-Machine.\n\n - StateUndefined: StateUndefined\n\nTenant state when it was created without any state.\n - StateCreating: StateCreating\n\nTenant state of initial bootstrapping tenant, registering tenant in other service and\npre-create default objects for the tenant like default namespaces, default roles etc.\n - StateCreateFailed: StateCreateFailed\n\nTenant state when initial bootstrapping was failed by some reason and must be retried\nafter issue is solved.\n - StateInactive: StateInactive\n\nTenant state when initial creation is completed and we have trigger next stage of tenant\nregistration like creating support account, billing account in third party services.\n - StateActive: StateActive\n\nTenant state of completely registered tenant and available to use.\n - StateSuspended: StateSuspended\n\nTenant state of suspended tenant by some reason like not finished billing payments,\nmanually suspended by administrator, etc.\n - StateDisabled: StateDisabled\n\nTenant state of disabled tenant which are in pre-deletion state.\n - StateConfiguring: StateConfiguring\n\nConfiguring state of the specific tenant, can be set for instance if tenant is setting up billing account, etc..\n - StateConfiguringFailed: StateConfiguringFailed\n\nConfiguring state of the specific tenant, can be set for instance if tenant is setting up billing account, etc..","title":"States","enum":["StateUndefined","StateCreating","StateCreateFailed","StateInactive","StateActive","StateSuspended","StateDisabled","StateConfiguring","StateConfiguringFailed"],"default":"StateUndefined","x-displayname":"States","x-ves-proto-enum":"ves.io.schema.tenant.FSMState"},"tenantAssignDomainOwnerRequest":{"type":"object","description":"Domain owner assignment request","title":"Domain owner assignment request","x-displayname":"Domain owner assignment request","x-ves-proto-message":"ves.io.schema.tenant.AssignDomainOwnerRequest","properties":{"email":{"type":"string","description":" assign domain owner to user with this email\n\nExample: ` \"joe.doe@acme.com\"`","title":"Email","x-displayname":"Email","x-ves-example":"joe.doe@acme.com"}}},"tenantCredentialsExpiry":{"type":"object","description":"CredentialsExpiry is a struct that holds max expiration days setting for the different credentials.","title":"CredentialsExpiry","x-displayname":"CredentialsExpiry","x-ves-proto-message":"ves.io.schema.tenant.CredentialsExpiry","properties":{"max_api_certificate_expiry_days":{"type":"integer","description":" Certificate expiry period as days\n\nExample: ` \"90\"`","title":"Certificate expiry period","format":"int32","x-displayname":"Certificate expiry period","x-ves-example":"90"},"max_api_token_expiry_days":{"type":"integer","description":" Token expiry period as days\n\nExample: ` \"90\"`","title":"Token expiry period","format":"int32","x-displayname":"Token expiry period","x-ves-example":"90"},"max_kube_config_expiry_days":{"type":"integer","description":" TokeKubeconfign expiry period as days\n\nExample: ` \"90\"`","title":"Kubeconfig expiry period","format":"int32","x-displayname":"Kubeconfig expiry period","x-ves-example":"90"}}},"tenantDeactivateTenantRequest":{"type":"object","description":"Request to deactivate the tenant.","title":"DeactivateTenantRequest","x-displayname":"Deactivate Tenant Request","x-ves-proto-message":"ves.io.schema.tenant.DeactivateTenantRequest","properties":{"feedback":{"type":"string","description":" Feedback from the customer related to reason of account deactivation.\n\nExample: ` \"Customers feedback\"`","title":"Feedback","x-displayname":"Feedback","x-ves-example":"Customers feedback"},"reason":{"$ref":"#/components/schemas/tenantDeletionReason"}}},"tenantDeactivateTenantResponse":{"type":"object","title":"DeactivateTenantResponse","x-displayname":"Deactivate Tenant Response","x-ves-proto-message":"ves.io.schema.tenant.DeactivateTenantResponse","properties":{"job_id":{"type":"string","description":" Job id of the async job that triggered to process the tenant deactivation.","title":"Job Id","x-displayname":"Job Id"}}},"tenantDeleteTenantRequest":{"type":"object","description":"Request for marking Tenant for deletion.","title":"DeleteTenantRequest","x-displayname":"DeleteTenantRequest","x-ves-proto-message":"ves.io.schema.tenant.DeleteTenantRequest","properties":{"email":{"type":"string","description":" Email of freemium account which need to be deleted.\n\nExample: ` \"test@test.com\"`","title":"Email","x-displayname":"Email","x-ves-example":"test@test.com"},"feedback":{"type":"string","description":" Feedback from the customer related to reason of account deletion.\n\nExample: ` \"Customers feedback\"`","title":"Feedback","x-displayname":"Feedback","x-ves-example":"Customers feedback"},"name":{"type":"string","description":" Tenant name marked for deletion.\n\nExample: ` \"tenant-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"tenant-1"},"reason":{"$ref":"#/components/schemas/tenantDeletionReason"}}},"tenantDeletionReason":{"type":"string","description":"List of available reason for account deletion.\n\n - REASON_UNKNOWN: Unknown reason\n\nUnknown reason\n - REASON_SWITCH_TO_FREE_PLAN: Switch to free plan\n\nSwitch to free plan\n - REASON_NO_LONGER_NEEDED: No longer needed\n\nNo longer needed\n - REASON_NOT_JUSTIFY_COSTS: Too expensive\n\nToo expensive\n - REASON_DIFFICULT_TO_USE: Difficult to use\n\nDifficult to use","title":"DeletionReason","enum":["REASON_UNKNOWN","REASON_SWITCH_TO_FREE_PLAN","REASON_NO_LONGER_NEEDED","REASON_NOT_JUSTIFY_COSTS","REASON_DIFFICULT_TO_USE"],"default":"REASON_UNKNOWN","x-displayname":"DeletionReason","x-ves-proto-enum":"ves.io.schema.tenant.DeletionReason"},"tenantGetLoginEventsInTimeFrameRequest":{"type":"object","description":"Contains fields to retrieve events in timeframe","title":"GetLoginEventsInTimeFrameRequest","x-displayname":"GetLoginEventsInTimeFrameRequest","x-ves-proto-message":"ves.io.schema.tenant.GetLoginEventsInTimeFrameRequest","properties":{"end":{"type":"string","description":" End time\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"End","format":"date-time","x-displayname":"End","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"first":{"type":"integer","description":" Records per page\n\nExample: ` \"25\"`","title":"Max","format":"int64","x-displayname":"Max","x-ves-example":"25"},"max":{"type":"integer","description":" Records per page\n\nExample: ` \"25\"`","title":"Max","format":"int64","x-displayname":"Max","x-ves-example":"25"},"start":{"type":"string","description":" Start time\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Start","format":"date-time","x-displayname":"Start","x-ves-example":"2020-04-20T12:32:51.341959216Z"}}},"tenantLastLoginMap":{"type":"object","description":"Last login map","title":"Last login map","x-displayname":"Last login map","x-ves-proto-message":"ves.io.schema.tenant.LastLoginMap","properties":{"last_login_map":{"type":"object","description":" Login map username->timestamp","title":"Last login map","x-displayname":"Last login map"}}},"tenantLoginEvent":{"type":"object","description":"x-displayName: \"LoginEvent\"\nContains information about specific login event, like when exactly it happened, from which IP address, etc...","title":"LoginEvent","properties":{"auth_method":{"type":"string","description":"x-displayName: \"Authentication method\"\nx-example: \"SSO\"\nAuthentication method","title":"Authentication method"},"error":{"type":"string","description":"x-displayName: \"Error\"\nx-example: \"OK\"\nLogin error (if any)","title":"Error"},"ip_address":{"type":"string","description":"x-displayName: \"IP address\"\nx-example: \"127.0.0.1\"\nIP address the login accessed from","title":"IP address"},"session_id":{"type":"string","description":"x-displayName: \"Session\"\nx-example: \"55cabe9e-9e10-486f-97bf-05c655d6fea9\"\nSession","title":"Session"},"time":{"type":"string","description":"x-displayName: \"Time\"\nx-example: \"2020-04-20T12:32:51.341959216Z\"\nLogin event time","title":"Time","format":"date-time"},"username":{"type":"string","description":"x-displayName: \"Username\"\nx-example: \"joe.doe\"\nUsername of the login","title":"Username"}}},"tenantLoginEvents":{"type":"object","description":"x-displayName: \"LoginEvents\"\nContains list of login events.","title":"LoginEvents","properties":{"login_events":{"type":"array","description":"x-displayName: \"Login events\"\nCollection of login events based on input filter","title":"Login events","items":{"$ref":"#/components/schemas/tenantLoginEvent"}}}},"tenantLoginEventsMap":{"type":"object","description":"LoginEventsMap is a map from username to list of login events. In can be useful have login events grouped by usernames.","title":"LoginEventsMap","x-displayname":"LoginEventsMap","x-ves-proto-message":"ves.io.schema.tenant.LoginEventsMap","properties":{"login_events_map":{"type":"object","description":" Map of login events based on input filter group by username","title":"Login map","x-displayname":"Login map"}}},"tenantOtpStatus":{"type":"string","description":"OtpStatus can be either enabled/disabled or processing.\nApplying new policy can take time, especially if tenant has many users so for this purpose processing state is introduced.\n\n - OTP_DISABLED: OTP_DISABLED\n\nOTP disabled\n - OTP_ENABLED: OTP_ENABLED\n\nOTP enabled\n - OTP_PROCESSING: OTP_PROCESSING\n\nOTP is being updated\n - OTP_PROCESS_DISABLING: OTP_PROCESSING\n\nOTP is being updated to be disabled","title":"OtpStatus","enum":["OTP_DISABLED","OTP_ENABLED","OTP_PROCESSING","OTP_PROCESS_DISABLING"],"default":"OTP_DISABLED","x-displayname":"OtpStatus","x-ves-proto-enum":"ves.io.schema.tenant.OtpStatus"},"tenantPasswordPolicyPublicAccess":{"type":"object","description":"PasswordPolicyPublicAccess contains subset of password policy settings. This settings will be available publicly\nwithout authentication.","title":"PasswordPolicyPublicAccess","x-displayname":"PasswordPolicyPublicAccess","x-ves-proto-message":"ves.io.schema.tenant.PasswordPolicyPublicAccess","properties":{"digits":{"type":"integer","description":" Number of digits\n\nExample: ` \"1\"`","title":"Digits","format":"int64","x-displayname":"Digits","x-ves-example":"1"},"lowercase_characters":{"type":"integer","description":" Number of lowercase characters\n\nExample: ` \"1\"`","title":"lowercase_characters","format":"int64","x-displayname":"lowercase_characters","x-ves-example":"1"},"minimum_length":{"type":"integer","description":" Minimum password length\n\nExample: ` \"1\"`","title":"minimum_length","format":"int64","x-displayname":"minimum_length","x-ves-example":"1"},"not_recently_used":{"type":"integer","description":" Number of previous passwords to check for equality - if match found the password is rejected\n\nExample: ` \"1\"`","title":"not_recently_used","format":"int64","x-displayname":"not_recently_used","x-ves-example":"1"},"not_username":{"type":"boolean","description":" If true then username must not appear in the password string","title":"not_username","format":"boolean","x-displayname":"not_username"},"special_characters":{"type":"integer","description":" Number of special characters\n\nExample: ` \"1\"`","title":"special_characters","format":"int64","x-displayname":"special_characters","x-ves-example":"1"},"uppercase_characters":{"type":"integer","description":" Number of uppercase characters\n\nExample: ` \"1\"`","title":"uppercase_characters","format":"int64","x-displayname":"uppercase_characters","x-ves-example":"1"}}},"tenantStatusResponse":{"type":"object","description":"LookupCnameResponse sets the response format based on the availability of cname.\n\nIt can return any of these three types of errors.\nEEXISTS => cname exists.\nEOK => valid request. However, cname does not exist.\nEUNKNOWN => internal error in fetching tenants info.","x-displayname":"LookupCnameResponse","x-ves-proto-message":"ves.io.schema.tenant.StatusResponse"},"tenantSummaryResponse":{"type":"object","description":"Tenant Summary Response","title":"SummaryResponse","x-displayname":"Tenant Summary Response","x-ves-proto-message":"ves.io.schema.tenant.SummaryResponse","properties":{"type":{"type":"string","description":" Default VIP Type (dedicated/shared)","title":"Type","x-displayname":"Default VIP Type"},"vip":{"type":"string","description":" Default VIP","title":"VIP","x-displayname":"Default VIP"}}},"tenantSupportInfo":{"type":"object","description":"Support Info contains support information for tenant","title":"Support Info","x-displayname":"Support Info","x-ves-proto-message":"ves.io.schema.tenant.SupportInfo","properties":{"support_email_address":{"type":"string","description":" Support Email address for tenant","title":"Support email address","x-displayname":"Support email address"}}},"tenantTenantSettingsResponse":{"type":"object","description":"Defines tenant specific settings.","title":"TenantSettingsResponse","x-displayname":"TenantSettingsResponse","x-ves-proto-message":"ves.io.schema.tenant.TenantSettingsResponse","properties":{"active_plan_transition_id":{"type":"string","description":" Id of the plan transition request which is currently in state CREATING.\n\nExample: ` \"7e1ba0f9-26dc-4397-97b3-b600df2097d3\"`","x-displayname":"ActivePlanTransitionId","x-ves-example":"7e1ba0f9-26dc-4397-97b3-b600df2097d3"},"company_name":{"type":"string","description":" Company name of the tenant.","title":"CompanyName","x-displayname":"Company Name"},"domain":{"type":"string","description":" Domain of the tenant.","title":"Domain","x-displayname":"Domain"},"max_credentials_expiry":{"$ref":"#/components/schemas/tenantCredentialsExpiry"},"name":{"type":"string","description":" name will represent name of the tenant that is being accessed\n\nExample: ` \"tenant1\"`","title":"Name","x-displayname":"Name","x-ves-example":"tenant1"},"original_tenant":{"type":"string","description":" orginal_tenant represent tenant id where the user belongs to\n\nExample: ` \"tenant1\"`","title":"Original Tenant","x-displayname":"Original Tenant","x-ves-example":"tenant1"},"otp_enabled":{"type":"boolean","description":" OTP configuration for tenant scope.","title":"OTP Enabled","format":"boolean","x-displayname":"OTP Enabled"},"otp_status":{"$ref":"#/components/schemas/tenantOtpStatus"},"scim_enabled":{"type":"boolean","description":" Flag to show SCIM is enabled for specific tenant.","title":"scim_enabled","format":"boolean","x-displayname":"SCIM Enabled"},"sso_enabled":{"type":"boolean","description":" Flag to show SSO is enabled for specific tenant.","title":"SSO Enabled","format":"boolean","x-displayname":"SSO Enabled"},"state":{"$ref":"#/components/schemas/schematenantFSMState"}}},"tenantUnassignDomainOwnerRequest":{"type":"object","description":"Domain owner assignment request","title":"Domain owner un-assignment request","x-displayname":"Domain owner un-assignment request","x-ves-proto-message":"ves.io.schema.tenant.UnassignDomainOwnerRequest","properties":{"email":{"type":"string","description":" remove domain owner privilege from user with this email\n\nExample: ` \"joe.doe@acme.com\"`","title":"Email","x-displayname":"Email","x-ves-example":"joe.doe@acme.com"}}},"tenantUpdateImageRequest":{"type":"object","description":"Update user image request","title":"Update user image request","x-displayname":"Update user image request","x-ves-proto-message":"ves.io.schema.tenant.UpdateImageRequest","properties":{"content_type":{"type":"string","description":" Type of uploading image.\n\nExample: ` \"image/jpeg\"`","x-displayname":"ContentType","x-ves-example":"image/jpeg"},"image":{"type":"string","description":" Blob of the tenant profile image.\n\nExample: ` \"dXNlci1pbWFnZS5qcGVn\"`","format":"byte","x-displayname":"Image","x-ves-example":"dXNlci1pbWFnZS5qcGVn"}}},"tenantUpdateTenantSettingsRequest":{"type":"object","description":"Request to update tenant settings for specific tenant.","title":"UpdateTenantSettingsRequest","x-displayname":"UpdateTenantSettingsRequest","x-ves-proto-message":"ves.io.schema.tenant.UpdateTenantSettingsRequest","properties":{"max_credentials_expiry":{"$ref":"#/components/schemas/tenantCredentialsExpiry"},"otp_enabled":{"type":"boolean","description":" OTP configuration for tenant scope.","title":"OTP Enabled","format":"boolean","x-displayname":"OTP Enabled"}}},"tenantUpdateTenantSettingsResponse":{"type":"object","description":"Defines tenant specific settings.","title":"TenantSettingsResponse","x-displayname":"TenantSettingsResponse","x-ves-proto-message":"ves.io.schema.tenant.UpdateTenantSettingsResponse","properties":{"max_credentials_expiry":{"$ref":"#/components/schemas/tenantCredentialsExpiry"},"otp_enabled":{"type":"boolean","description":" OTP configuration for tenant scope.","title":"OTP Enabled","format":"boolean","x-displayname":"OTP Enabled"},"otp_status":{"$ref":"#/components/schemas/tenantOtpStatus"},"scim_enabled":{"type":"boolean","description":" Flag to show SCIM is enabled for specific tenant.","title":"scim_enabled","format":"boolean","x-displayname":"SCIM Enabled"},"sso_enabled":{"type":"boolean","description":" Flag to show SSO is enabled for specific tenant.","title":"SSO Enabled","format":"boolean","x-displayname":"SSO Enabled"},"validation_errors":{"type":"array","description":" x-displayName : \"Validation errors\"\n collection of validation errors","title":"validation errors","items":{"$ref":"#/components/schemas/tenantValidationErrorField"}}}},"tenantUser":{"type":"object","description":"Login user representation. Currently users are identified by their email.","title":"User","x-displayname":"User","x-ves-proto-message":"ves.io.schema.tenant.User","properties":{"email":{"type":"string","description":" user's email\n\nExample: ` \"joe.doe@acme.com\"`","title":"email","x-displayname":"Email","x-ves-example":"joe.doe@acme.com"}}},"tenantUserList":{"type":"object","description":"Collection of users","title":"User list","x-displayname":"User list","x-ves-proto-message":"ves.io.schema.tenant.UserList","properties":{"users":{"type":"array","description":" Collection of users","title":"Users","items":{"$ref":"#/components/schemas/tenantUser"},"x-displayname":"Users"}}},"tenantValidationErrorField":{"type":"object","description":"Contains information on a single validation error","title":"Validation error field","x-displayname":"Validation error field","x-ves-proto-message":"ves.io.schema.tenant.ValidationErrorField","properties":{"error_field":{"type":"string","description":" path indicates the field that is not valid\n\nExample: ` \"max_credentials_expiry\"`","title":"Error field","x-displayname":"Error field","x-ves-example":"max_credentials_expiry"},"error_message":{"type":"string","description":" more descriptive error message\n\nExample: ` \"max_credentials_expiry code should be less < 0 \"`","title":"Error message","x-displayname":"Error message","x-ves-example":"max_credentials_expiry code should be less < 0 "}}},"tenant_configurationBasicConfiguration":{"type":"object","title":"BasicConfiguration","x-displayname":"BasicConfiguration","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.BasicConfiguration","properties":{"display_name":{"type":"string","description":" Tenant display name in the login screen\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.k8s_label_value: true\n  ves.io.schema.rules.string.max_len: 255\n","title":"Display Name","maxLength":255,"x-displayname":"Display Name","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.k8s_label_value":"true","ves.io.schema.rules.string.max_len":"255"}}}},"tenant_configurationBruteForceDetectionSettings":{"type":"object","title":"BruteForceDetectionSettings","x-displayname":"BruteForceDetectionSettings","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.BruteForceDetectionSettings","properties":{"max_login_failures":{"type":"integer","description":" How many failures before wait is triggered.\n When login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.\n\nExample: ` \"5\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 30\n","title":"Max Login Failures","format":"int64","x-displayname":"Max Login Failures","x-ves-example":"5","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"30"}}}},"tenant_configurationPasswordPolicy":{"type":"object","title":"PasswordPolicy","x-displayname":"PasswordPolicy","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.PasswordPolicy","properties":{"digits":{"type":"integer","description":" The number of digits required to be in the password string.\n\nExample: ` \"1\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Digits","format":"int64","x-displayname":"Min Number Of Digits","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}},"expire_password":{"type":"integer","description":" The number of days for which the password is valid.\n After the number of days has expired, the user is required to change their password.\n\nExample: ` \"30\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 1080\n","title":"Expire Password","format":"int64","x-displayname":"Expire Password","x-ves-example":"30","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"1080"}},"lowercase_characters":{"type":"integer","description":" The number of lower case letters required to be in the password string.\n\nExample: ` \"8\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Lowercase Characters","format":"int64","x-displayname":"Min Number Of Lowercase Characters","x-ves-example":"8","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}},"minimum_length":{"type":"integer","description":" Minimum length of password.\n\nExample: ` \"12\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 7\n","title":"Minimum Length","format":"int64","x-displayname":"Minimum Length","x-ves-example":"12","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"7"}},"not_recently_used":{"type":"integer","description":" This policy is used to restrict user from using previously used passwords.\n Number that's set determines number of last passwords which user cannot use as new password.\n\nExample: ` \"2\"`","title":"Not Recently Used","format":"int64","x-displayname":"Not Recently Used","x-ves-example":"2"},"not_username":{"type":"boolean","description":" When set, the password is not allowed to be the same as the username.","title":"Not Username","format":"boolean","x-displayname":"Not Username"},"special_characters":{"type":"integer","description":" The number of special characters like '?!#%$' required to be in the password string.\n\nExample: ` \"1\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Special Characters","format":"int64","x-displayname":"Min Number Of Special Characters","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}},"uppercase_characters":{"type":"integer","description":" The number of upper case letters required to be in the password string.\n\nExample: ` \"2\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Uppercase Characters","format":"int64","x-displayname":"Min Number Of Uppercase Characters","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}}}},"tenant_configurationSessionManagement":{"type":"object","description":"x-displayName: \"SessionManagement\"","title":"SessionManagement","properties":{"cookie_expiry":{"type":"integer","description":"x-displayName: \"Session Cookie Expiry\"\nx-required\nx-example: \"900\"\nSession cookie expiry in seconds.\nThe user will be logged-out after these many seconds, if inactive on the console.","title":"Session Cookie Expiry","format":"int64"},"cookie_refresh_interval":{"type":"integer","description":"x-displayName: \"Session Cookie Refresh Interval\"\nx-example: \"840\"\nSession cookie refresh interval in seconds.\nThe session cookie will be renewed when (expiry - current_timestamp < cookie_refresh_interval) and (max_session_expiry - expiry > cookie_refresh_interval ), otherwise, the existing cookie will be re-used","title":"Session Cookie Refresh Interval","format":"int64"},"session_expiry":{"type":"integer","description":"x-displayName: \"Maximum Session Expiry\"\nx-required\nx-example: \"86400\"\nMaximum session expiry in seconds.\nThe user will be prompted for a re-login after this interval in spite of being active on the console","title":"Maximum Session Expiry","format":"int64"}}},"viewstenant_configurationGlobalSpecType":{"type":"object","description":"Shape of the tenant configuration specification","title":"GlobalSpecType","x-displayname":"Global Specification","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.GlobalSpecType","properties":{"basic_configuration":{"$ref":"#/components/schemas/tenant_configurationBasicConfiguration"},"brute_force_detection_settings":{"$ref":"#/components/schemas/tenant_configurationBruteForceDetectionSettings"},"password_policy":{"$ref":"#/components/schemas/tenant_configurationPasswordPolicy"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0234.public.ves.io.schema.views.tenant_configuration.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.views.tenant_configuration","description":"Tenant configuration consists of three main parts:\n- Basic Configuration\n- Brute Force Detection Settings\n- Password Policy\nBasic configuration contains general parameters which can be adjusted within tenant.\nBrute force detection settings can be used to adjust some parameters of the brute force detection system.\nPassword policy allows you to configure your own password policy within tenant.\nEach user within tenant will have to comply with the configured policy when set or update the password.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/tenant_configurations":{"post":{"summary":"Create tenant configuration","description":"Shape of the tenant configuration specification","operationId":"ves.io.schema.views.tenant_configuration.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_configurationCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_configurationCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-tenant_configuration-api-create"},"x-ves-proto-rpc":"ves.io.schema.views.tenant_configuration.API.Create"},"x-displayname":"Tenant Configuration","x-ves-proto-service":"ves.io.schema.views.tenant_configuration.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/tenant_configurations/{metadata.name}":{"put":{"summary":"Replace tenant configuration","description":"Shape of the tenant configuration specification","operationId":"ves.io.schema.views.tenant_configuration.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_configurationReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_configurationReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-tenant_configuration-api-replace"},"x-ves-proto-rpc":"ves.io.schema.views.tenant_configuration.API.Replace"},"x-displayname":"Tenant Configuration","x-ves-proto-service":"ves.io.schema.views.tenant_configuration.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/tenant_configurations":{"get":{"summary":"List Tenant Configuration","description":"List the set of tenant_configuration in a namespace","operationId":"ves.io.schema.views.tenant_configuration.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_configurationListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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 tenant_configuration","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-views-tenant_configuration-api-list"},"x-ves-proto-rpc":"ves.io.schema.views.tenant_configuration.API.List"},"x-displayname":"Tenant Configuration","x-ves-proto-service":"ves.io.schema.views.tenant_configuration.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/tenant_configurations/{name}":{"get":{"summary":"Get tenant configuration","description":"Shape of the tenant configuration specification","operationId":"ves.io.schema.views.tenant_configuration.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_configurationGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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 CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-tenant_configuration-api-get"},"x-ves-proto-rpc":"ves.io.schema.views.tenant_configuration.API.Get"},"delete":{"summary":"Delete Tenant Configuration","description":"Delete the specified tenant_configuration","operationId":"ves.io.schema.views.tenant_configuration.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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 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\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_configurationDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-tenant_configuration-api-delete"},"x-ves-proto-rpc":"ves.io.schema.views.tenant_configuration.API.Delete"},"x-displayname":"Tenant Configuration","x-ves-proto-service":"ves.io.schema.views.tenant_configuration.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Tenant Configuration","x-ves-proto-package":"ves.io.schema.views.tenant_configuration","components":{"schemas":{"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\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"}}},"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"}}},"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"}}},"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"}}},"schemaObjectCreateMetaType":{"type":"object","description":"x-displayName: \"Create Metadata\"\nObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":"x-displayName: \"Annotation\"\nAnnotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.","title":"annotations"},"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Virtual Host for acmecorp website\"\nHuman readable description for the object","title":"description"},"disable":{"type":"boolean","description":"x-displayName: \"Disable\"\nA value of true will administratively disable the object","title":"disable","format":"boolean"},"labels":{"type":"object","description":"x-displayName: \"Labels\"\nMap of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression","title":"labels"},"name":{"type":"string","description":"x-displayName: \"Name\"\nx-example: \"acmecorp-web\"\nx-required\nThe configuration object will be created with name. It has to be unique within the namespace.\nThe value of name has to follow DNS-1035 format.","title":"name"},"namespace":{"type":"string","description":"x-displayName: \"Namespace\"\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","title":"namespace"}}},"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"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"x-displayName: \"Replace Metadata\"\nObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":"x-displayName: \"Annotations\"\nx-example: \"value\"\nAnnotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.","title":"annotations"},"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Virtual Host for acmecorp website\"\nHuman readable description for the object","title":"description"},"disable":{"type":"boolean","description":"x-displayName: \"Disable\"\nA value of true will administratively disable the object","title":"disable","format":"boolean"},"labels":{"type":"object","description":"x-displayName: \"Labels\"\nx-example: \"value\"\nMap of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression","title":"labels"},"name":{"type":"string","description":"x-displayName: \"Name\"\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","title":"name"},"namespace":{"type":"string","description":"x-displayName: \"Namespace\"\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","title":"namespace"}}},"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"}}},"tenant_configurationBasicConfiguration":{"type":"object","title":"BasicConfiguration","x-displayname":"BasicConfiguration","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.BasicConfiguration","properties":{"display_name":{"type":"string","description":" Tenant display name in the login screen\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.k8s_label_value: true\n  ves.io.schema.rules.string.max_len: 255\n","title":"Display Name","maxLength":255,"x-displayname":"Display Name","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.k8s_label_value":"true","ves.io.schema.rules.string.max_len":"255"}}}},"tenant_configurationBruteForceDetectionSettings":{"type":"object","title":"BruteForceDetectionSettings","x-displayname":"BruteForceDetectionSettings","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.BruteForceDetectionSettings","properties":{"max_login_failures":{"type":"integer","description":" How many failures before wait is triggered.\n When login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.\n\nExample: ` \"5\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 30\n","title":"Max Login Failures","format":"int64","x-displayname":"Max Login Failures","x-ves-example":"5","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"30"}}}},"tenant_configurationCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of tenant_configuration","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.CreateRequest","properties":{"spec":{"$ref":"#/components/schemas/tenant_configurationCreateSpecType"}}},"tenant_configurationCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/tenant_configurationGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"tenant_configurationCreateSpecType":{"type":"object","description":"Shape of the tenant configuration specification","title":"CreateSpecType","x-displayname":"Create tenant configuration","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.CreateSpecType","properties":{"basic_configuration":{"$ref":"#/components/schemas/tenant_configurationBasicConfiguration"},"brute_force_detection_settings":{"$ref":"#/components/schemas/tenant_configurationBruteForceDetectionSettings"},"password_policy":{"$ref":"#/components/schemas/tenant_configurationPasswordPolicy"}}},"tenant_configurationDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a tenant_configuration","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"tenant_configurationGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read tenant_configuration","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/tenant_configurationCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"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/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/tenant_configurationReplaceRequest"},"spec":{"$ref":"#/components/schemas/tenant_configurationGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/tenant_configurationStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"tenant_configurationGetResponseFormatCode":{"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_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\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_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"tenant_configurationGetSpecType":{"type":"object","description":"Shape of the tenant configuration specification","title":"GetSpecType","x-displayname":"Get tenant configuration","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.GetSpecType","properties":{"basic_configuration":{"$ref":"#/components/schemas/tenant_configurationBasicConfiguration"},"brute_force_detection_settings":{"$ref":"#/components/schemas/tenant_configurationBruteForceDetectionSettings"},"password_policy":{"$ref":"#/components/schemas/tenant_configurationPasswordPolicy"}}},"tenant_configurationListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of tenant_configuration","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/tenant_configurationListResponseItem"},"x-displayname":"Items"}}},"tenant_configurationListResponseItem":{"type":"object","description":"By default a summary of tenant_configuration is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of tenant_configuration","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this tenant_configuration","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this tenant_configuration","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates tenant_configuration is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/tenant_configurationGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this tenant_configuration","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this tenant_configuration\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/tenant_configurationStatusObject"},"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 tenant_configuration\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"tenant_configurationPasswordPolicy":{"type":"object","title":"PasswordPolicy","x-displayname":"PasswordPolicy","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.PasswordPolicy","properties":{"digits":{"type":"integer","description":" The number of digits required to be in the password string.\n\nExample: ` \"1\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Digits","format":"int64","x-displayname":"Min Number Of Digits","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}},"expire_password":{"type":"integer","description":" The number of days for which the password is valid.\n After the number of days has expired, the user is required to change their password.\n\nExample: ` \"30\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 1080\n","title":"Expire Password","format":"int64","x-displayname":"Expire Password","x-ves-example":"30","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"1080"}},"lowercase_characters":{"type":"integer","description":" The number of lower case letters required to be in the password string.\n\nExample: ` \"8\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Lowercase Characters","format":"int64","x-displayname":"Min Number Of Lowercase Characters","x-ves-example":"8","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}},"minimum_length":{"type":"integer","description":" Minimum length of password.\n\nExample: ` \"12\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 7\n","title":"Minimum Length","format":"int64","x-displayname":"Minimum Length","x-ves-example":"12","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"7"}},"not_recently_used":{"type":"integer","description":" This policy is used to restrict user from using previously used passwords.\n Number that's set determines number of last passwords which user cannot use as new password.\n\nExample: ` \"2\"`","title":"Not Recently Used","format":"int64","x-displayname":"Not Recently Used","x-ves-example":"2"},"not_username":{"type":"boolean","description":" When set, the password is not allowed to be the same as the username.","title":"Not Username","format":"boolean","x-displayname":"Not Username"},"special_characters":{"type":"integer","description":" The number of special characters like '?!#%$' required to be in the password string.\n\nExample: ` \"1\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Special Characters","format":"int64","x-displayname":"Min Number Of Special Characters","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}},"uppercase_characters":{"type":"integer","description":" The number of upper case letters required to be in the password string.\n\nExample: ` \"2\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 16\n","title":"Uppercase Characters","format":"int64","x-displayname":"Min Number Of Uppercase Characters","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"16"}}}},"tenant_configurationReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a tenant_configuration","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.ReplaceRequest","properties":{"spec":{"$ref":"#/components/schemas/tenant_configurationReplaceSpecType"}}},"tenant_configurationReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.ReplaceResponse"},"tenant_configurationReplaceSpecType":{"type":"object","description":"Shape of the tenant configuration specification","title":"ReplaceSpecType","x-displayname":"Replace tenant configuration","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.ReplaceSpecType","properties":{"basic_configuration":{"$ref":"#/components/schemas/tenant_configurationBasicConfiguration"},"brute_force_detection_settings":{"$ref":"#/components/schemas/tenant_configurationBruteForceDetectionSettings"},"password_policy":{"$ref":"#/components/schemas/tenant_configurationPasswordPolicy"}}},"tenant_configurationStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.views.tenant_configuration.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions represent the normalized status values for configuration object","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Tenant configuration view object direct reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.tenant_management","description":"Public APIs for Tenant Management feature.","version":""},"paths":{"/api/web/namespaces/system/tenant_management/delegated_access/subscribe":{"post":{"summary":"Subscribe Delegated Access Addon Service","description":"Subscribe Delegated Access addon service feature. A support request will be created and feature will be enabled upon approval.","operationId":"ves.io.schema.tenant_management.CustomAPI.DelegatedAccessSubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementSubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenant_managementSubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-customapi-delegatedaccesssubscribe"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.CustomAPI.DelegatedAccessSubscribe"},"x-displayname":"Tenant Management","x-ves-proto-service":"ves.io.schema.tenant_management.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/tenant_management/delegated_access/unsubscribe":{"post":{"summary":"Unsubscribe Delegated Access Addon Service","description":"Unsubscribe Delegated Access addon service feature. A support request will be created and request will be processed upon approval.","operationId":"ves.io.schema.tenant_management.CustomAPI.DelegatedAccessUnsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementUnsubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/tenant_managementUnsubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-customapi-delegatedaccessunsubscribe"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.CustomAPI.DelegatedAccessUnsubscribe"},"x-displayname":"Tenant Management","x-ves-proto-service":"ves.io.schema.tenant_management.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Tenant Management","x-ves-proto-package":"ves.io.schema.tenant_management","components":{"schemas":{"tenant_managementSubscribeRequest":{"type":"object","description":"Request to subscribe to Tenant Management Service","title":"SubscribeRequest","x-displayname":"Subscribe Request","x-ves-proto-message":"ves.io.schema.tenant_management.SubscribeRequest"},"tenant_managementSubscribeResponse":{"type":"object","description":"Response of subscribe to Tenant Management Service","title":"SubscribeResponse","x-displayname":"Subscribe Response","x-ves-proto-message":"ves.io.schema.tenant_management.SubscribeResponse"},"tenant_managementUnsubscribeRequest":{"type":"object","description":"Request to unsubscribe to Tenant Management Service","title":"UnsubscribeRequest","x-displayname":"Unsubscribe Request","x-ves-proto-message":"ves.io.schema.tenant_management.UnsubscribeRequest"},"tenant_managementUnsubscribeResponse":{"type":"object","description":"Response of unsubscribe to Tenant Management Service","title":"UnsubscribeResponse","x-displayname":"Unsubscribe Response","x-ves-proto-message":"ves.io.schema.tenant_management.UnsubscribeResponse"}}}}