@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.scim","description":"This schema specification details Volterra's support for SCIM protocol.\nAdmin can use SCIM feature on top of SSO to enable automated provisioning of\nuser and user groups from external identity provider into the F5 saas platform.\nWith this feature, complete life cycle management of user and groups can be\nachieved from single source of truth which is managed by tenant's admin.\n\ncurrent protocol support is using schema version v2.0 https://datatracker.ietf.org/doc/html/rfc7643 \n\nSCIM feature can be enabled part of SSO configuration (using RPC `UpdateScimIntegration` under oidc_provider resource)\nBy default, F5XC will not sync groups and users. Admin is required to set object identifier of group \nin external identity provider to corresponding user_group resource in volterra. Users with corresponding\ngroup membership if exist in external identity provider will be synced.","version":""},"paths":{"/api/scim/namespaces/system/v2/Groups":{"get":{"summary":"List group based on filters","description":"List groups based on the given filter.","operationId":"ves.io.schema.scim.CustomPublicAPI.ListGroups","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimListGroupResources"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"filter","description":"x-example: \"externalId\"\nFilter to be used for filtering objects.","in":"query","required":false,"x-displayname":"filter","schema":{"type":"string"}},{"name":"count","description":"x-example: \"8\"\nThe number of entries after filter.","in":"query","required":false,"x-displayname":"count","schema":{"type":"string","format":"uint64"}},{"name":"page","description":"x-example: \"1\"\nStart offset","in":"query","required":false,"x-displayname":"page","schema":{"type":"string","format":"uint64"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-listgroups"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.ListGroups"},"post":{"summary":"Create group with users","description":"Create group with given users.","operationId":"ves.io.schema.scim.CustomPublicAPI.CreateGroup","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimGroup"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/scimCreateGroupRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-creategroup"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.CreateGroup"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/Groups/{id}":{"get":{"summary":"List group based on Id","description":"List group based on the given Id.","operationId":"ves.io.schema.scim.CustomPublicAPI.GetGroupById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimGroup"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"sam.smith@gmail.com\"\nx-required\nId with which the request will find entry.","in":"path","required":true,"x-displayname":"Email","schema":{"type":"string"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-getgroupbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.GetGroupById"},"delete":{"summary":"Delete group based on Id","description":"Delete group based on the given Id.","operationId":"ves.io.schema.scim.CustomPublicAPI.DeleteGroupById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"sam.smith@gmail.com\"\nx-required\nId with which the request will find entry.","in":"path","required":true,"x-displayname":"Email","schema":{"type":"string"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-deletegroupbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.DeleteGroupById"},"put":{"summary":"Replace group based on Id","description":"Replace group based on the given Id.","operationId":"ves.io.schema.scim.CustomPublicAPI.ReplaceGroupById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimGroup"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"id\n\nx-example: \"value\"\nunique Id for the group.","in":"path","required":true,"x-displayname":"id","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimGroup"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-replacegroupbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.ReplaceGroupById"},"patch":{"summary":"Patch group based on Id","description":"Patch group based on the given Id.","operationId":"ves.io.schema.scim.CustomPublicAPI.PatchGroupById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimGroup"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"id\n\nx-example: \"value\"\nx-required\nunique Id for the group.","in":"path","required":true,"x-displayname":"id","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimPatchGroupRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-patchgroupbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.PatchGroupById"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/ResourceTypes":{"get":{"summary":"Get supported resources type","operationId":"ves.io.schema.scim.CustomPublicAPI.ListResourceTypes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimResourceTypesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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-scim-custompublicapi-listresourcetypes"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.ListResourceTypes"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/ResourceTypes/{id}":{"get":{"summary":"Get supported resources type","operationId":"ves.io.schema.scim.CustomPublicAPI.GetResourceTypesById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimResource"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"sam.smith@gmail.com\"\nx-required\nId with which the request will find entry.","in":"path","required":true,"x-displayname":"Email","schema":{"type":"string"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-getresourcetypesbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.GetResourceTypesById"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/Schemas":{"get":{"summary":"Schemas","operationId":"ves.io.schema.scim.CustomPublicAPI.ListSchemas","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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-scim-custompublicapi-listschemas"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.ListSchemas"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/Schemas/{id}":{"get":{"summary":"Schemas By ID","operationId":"ves.io.schema.scim.CustomPublicAPI.GetSchemaById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"sam.smith@gmail.com\"\nx-required\nId with which the request will find entry.","in":"path","required":true,"x-displayname":"Email","schema":{"type":"string"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-getschemabyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.GetSchemaById"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/ServiceProviderConfig":{"get":{"summary":"List service provider configs","operationId":"ves.io.schema.scim.CustomPublicAPI.ListServiceProviderConfig","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimServiceProviderConfigResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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-scim-custompublicapi-listserviceproviderconfig"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.ListServiceProviderConfig"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/Users":{"get":{"summary":"Get all users","description":"Get all users.","operationId":"ves.io.schema.scim.CustomPublicAPI.ListUsers","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimListUserResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"filter","description":"x-example: \"externalId\"\nFilter to be used for filtering objects.","in":"query","required":false,"x-displayname":"filter","schema":{"type":"string"}},{"name":"count","description":"x-example: \"8\"\nThe number of entries after filter.","in":"query","required":false,"x-displayname":"count","schema":{"type":"string","format":"uint64"}},{"name":"page","description":"x-example: \"1\"\nStart offset","in":"query","required":false,"x-displayname":"page","schema":{"type":"string","format":"uint64"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-listusers"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.ListUsers"},"post":{"summary":"Create User with Role Assignment","description":"Create creates a user and namespace roles binding for this user","operationId":"ves.io.schema.scim.CustomPublicAPI.CreateUser","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimUser"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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/scimCreateUserRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-createuser"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.CreateUser"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/scim/namespaces/system/v2/Users/{id}":{"get":{"summary":"Get User with Id","description":"Get user by means of ID","operationId":"ves.io.schema.scim.CustomPublicAPI.GetUserById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimUser"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"sam.smith@gmail.com\"\nx-required\nId with which the request will find entry.","in":"path","required":true,"x-displayname":"Email","schema":{"type":"string"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-getuserbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.GetUserById"},"delete":{"summary":"Delete user by Id","description":"Delete user by Id.","operationId":"ves.io.schema.scim.CustomPublicAPI.DeleteUserById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"sam.smith@gmail.com\"\nx-required\nId with which the request will find entry.","in":"path","required":true,"x-displayname":"Email","schema":{"type":"string"}},{"name":"excludedAttributes","description":"x-example: \"[\"members\"]\"\nA multi-valued list of strings indicating the names of resource attributes\nto be removed from the default set of attributes to return.","in":"query","required":false,"x-displayname":"excludedAttributes","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-deleteuserbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.DeleteUserById"},"put":{"summary":"Update User and Role Assignments","description":"Replace updates user and namespace roles for this user","operationId":"ves.io.schema.scim.CustomPublicAPI.ReplaceUserById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimUser"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"id\n\nx-required\nx-example: \"123-456-789012\"\nid for user object.","in":"path","required":true,"x-displayname":"id","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimUser"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-replaceuserbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.ReplaceUserById"},"patch":{"summary":"Patch User","description":"Patch patches the fields for this user","operationId":"ves.io.schema.scim.CustomPublicAPI.PatchUserById","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimUser"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"id\n\nx-example: \"\"id\": \"1234-5678-901234\"\"\nx-required\nid of the user object that needs patching.","in":"path","required":true,"x-displayname":"id","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scimPatchUserRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-scim-custompublicapi-patchuserbyid"},"x-ves-proto-rpc":"ves.io.schema.scim.CustomPublicAPI.PatchUserById"},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-service":"ves.io.schema.scim.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"System for Cross-domain Identity Management (SCIM)","x-ves-proto-package":"ves.io.schema.scim","components":{"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"}}},"protobufNullValue":{"type":"string","description":"`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.","enum":["NULL_VALUE"],"default":"NULL_VALUE"},"scimCreateGroupRequest":{"type":"object","description":"Request for creating group.","title":"CreateGroupRequest","x-displayname":"CreateGroupRequest","x-ves-proto-message":"ves.io.schema.scim.CreateGroupRequest","properties":{"displayName":{"type":"string","description":" Group display name.\n\nExample: ` \"display name\"`","title":"displayName","x-displayname":"displayName","x-ves-example":"display name"},"externalId":{"type":"string","description":" external Id for the group.\n\nExample: ` \"external Id\"`","title":"ExternalId","x-displayname":"ExternalId","x-ves-example":"external Id"},"id":{"type":"string","description":" Defines id of the obj\n\nExample: ` \"id of object in external identity provider\"`","title":"Id","x-displayname":"id","x-ves-example":"id of object in external identity provider"},"members":{"type":"array","description":" List of group members reference.\n\nExample: ` \"List group members i.e users\"`","title":"members","items":{"$ref":"#/components/schemas/scimGroupMembers"},"x-displayname":"members","x-ves-example":"List group members i.e users"},"meta":{"$ref":"#/components/schemas/scimMeta"},"schemas":{"type":"array","description":" schemas defined as per scim spec.\n\nExample: ` \"scim spec defined schemas\"`","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"scim spec defined schemas"}}},"scimCreateUserRequest":{"type":"object","description":"CreateUserRequest is the request for creating a user.","title":"CreateUserRequest","x-displayname":"CreateUserRequest","x-ves-proto-message":"ves.io.schema.scim.CreateUserRequest","properties":{"active":{"type":"boolean","description":" active is boolean representing if user is active or not.\n\nExample: ` \"true/false\"`","title":"active","format":"boolean","x-displayname":"active","x-ves-example":"true/false"},"displayName":{"type":"string","description":" displayName refers to the name to be displayed for the user. default is name.\n\nExample: ` \"Rod Rob\"`","title":"displayName","x-displayname":"displayName","x-ves-example":"Rod Rob"},"emails":{"type":"array","description":" emails can be list of emails to be used by user work, personal etc.\n\nExample: ` \"sam@test.com\"`","title":"emails","items":{"$ref":"#/components/schemas/scimEmail"},"x-displayname":"emails","x-ves-example":"sam@test.com"},"externalId":{"type":"string","description":" externalId refers to the id for user represented in the external system like azure etc.\n\nExample: ` \"rod_123\"`","title":"externalId","x-displayname":"externalId","x-ves-example":"rod_123"},"groups":{"type":"array","description":" groups to which user belongs to.\n\nExample: ` \"groupid\"`","title":"groups","items":{"$ref":"#/components/schemas/scimUserGroup"},"x-displayname":"groups","x-ves-example":"groupid"},"meta":{"$ref":"#/components/schemas/scimMeta"},"name":{"$ref":"#/components/schemas/scimName"},"roles":{"type":"array","description":" roles defined for the user.\n\nExample: ` \"roles\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"roles","items":{"type":"string"},"x-displayname":"roles","x-ves-example":"roles","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" schemas represent the schema from scim spec to be used for creating the user.\n\nExample: ` \"urn:ietf:params:scim:schemas:core:2.0:User\"`","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"urn:ietf:params:scim:schemas:core:2.0:User"},"userName":{"type":"string","description":" userName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.\n\nExample: ` \"rod_123\"`","title":"userName","x-displayname":"userName","x-ves-example":"rod_123"},"userType":{"$ref":"#/components/schemas/userUserType"}}},"scimEmail":{"type":"object","description":"Email for user can be primary or secondary","title":"Email","x-displayname":"Email","x-ves-proto-message":"ves.io.schema.scim.Email","properties":{"primary":{"type":"boolean","description":" primary boolean describing whether it is primary or not.\n\nExample: ` \"true\"`","title":"primary","format":"boolean","x-displayname":"primary","x-ves-example":"true"},"type":{"type":"string","description":" type of email describing whether it is work or personal.\n\nExample: ` \"work\"`","title":"type","x-displayname":"type","x-ves-example":"work"},"value":{"type":"string","description":" value.\n\nExample: ` \"newEmail@domain.com\"`","title":"value","x-displayname":"value","x-ves-example":"newEmail@domain.com"}}},"scimFilter":{"type":"object","description":"Filter.","title":"Filter","x-displayname":"Filter","x-ves-proto-message":"ves.io.schema.scim.Filter","properties":{"maxResults":{"type":"string","description":" maximum results to be displayed.\n\nExample: ` \"5\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"maxResults","format":"uint64","x-displayname":"schemas","x-ves-example":"5","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"supported":{"type":"boolean","description":" is filtering supported.\n\nExample: ` \"true/false\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"supported","format":"boolean","x-displayname":"supported","x-ves-example":"true/false","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimGroup":{"type":"object","description":"Group.","title":"Group","x-displayname":"Group","x-ves-proto-message":"ves.io.schema.scim.Group","properties":{"displayName":{"type":"string","description":" display name for the group.\n\nExample: ` \"group display name\"`","title":"displayName","x-displayname":"displayName","x-ves-example":"group display name"},"externalId":{"type":"string","description":" external Id for the group.\n\nExample: ` \"external Id\"`","title":"ExternalId","x-displayname":"ExternalId","x-ves-example":"external Id"},"id":{"type":"string","description":" unique Id for the group.\n\nExample: ` \"value\"`","title":"id","x-displayname":"id","x-ves-example":"value"},"members":{"type":"array","description":" users with unique Id.\n\nExample: ` \"Users with unique Id\"`","title":"GroupMembers","items":{"$ref":"#/components/schemas/scimGroupMembers"},"x-displayname":"GroupMembers","x-ves-example":"Users with unique Id"},"meta":{"$ref":"#/components/schemas/scimMeta"},"name":{"type":"string","description":" display name for the group.\n\nExample: ` \"group name\"`","title":"Name","x-displayname":"Name","x-ves-example":"group name"},"schemas":{"type":"array","description":" schemas per scim spec.\n\nExample: ` \"schema per scim spec.\"`","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"schema per scim spec."}}},"scimGroupMembers":{"type":"object","description":"GroupMembers.","title":"GroupMembers","x-displayname":"GroupMembers","x-ves-proto-message":"ves.io.schema.scim.GroupMembers","properties":{"ref":{"type":"string","description":" url of the users or groups\n\nExample: ` \"$ref\"`","title":"$ref","x-displayname":"$ref","x-ves-example":"$ref"},"value":{"type":"string","description":" unique Id of the users or groups\n\nExample: ` \"value\"`","title":"value","x-displayname":"value","x-ves-example":"value"}}},"scimListGroupResources":{"type":"object","description":"List group objects.","title":"ListGroup;resources","x-displayname":"ListGroupResources","x-ves-proto-message":"ves.io.schema.scim.ListGroupResources","properties":{"Resources":{"type":"array","description":" List of available groups.\n\nExample: ` \"list of groups\"`","title":"groups","items":{"$ref":"#/components/schemas/scimGroup"},"x-displayname":"groups","x-ves-example":"list of groups"},"itemsPerPage":{"type":"string","description":" itemsPerPage The number of resources returned in a list response page\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"itemsPerPage","format":"uint64","x-displayname":"itemsPerPage","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" schema defined as per scim spec.\n\nExample: ` \"scim spec referred schema\"`","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"scim spec referred schema"},"startIndex":{"type":"string","description":" startIndex The 1-based index of the first result in the current set of list results.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startIndex","format":"uint64","x-displayname":"startIndex","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"totalResults":{"type":"string","description":" totalGroup objects available.\n\nExample: ` \"10 15\"`","title":"id","format":"uint64","x-displayname":"totalResults","x-ves-example":"10 15"}}},"scimListUserResponse":{"type":"object","description":"ListUserResources list all the user objects.","title":"ListUserResources","x-displayname":"ListUserResources","x-ves-proto-message":"ves.io.schema.scim.ListUserResponse","properties":{"Resources":{"type":"array","description":" Resources representing all the user objects.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Resources","items":{"$ref":"#/components/schemas/scimUser"},"x-displayname":"Resources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemsPerPage":{"type":"string","description":" itemsPerPage The number of resources returned in a list response page\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"itemsPerPage","format":"uint64","x-displayname":"itemsPerPage","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" schemas for listing the user.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"startIndex":{"type":"string","description":" startIndex The 1-based index of the first result in the current set of list results.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startIndex","format":"uint64","x-displayname":"startIndex","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"totalResults":{"type":"string","description":" totalResults for the search criteria.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"totalResults","format":"uint64","x-displayname":"totalResults","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimMeta":{"type":"object","description":"x-example: \"Meta\"\nx-required\nResource meta information..","title":"Meta","x-displayname":"Meta","x-ves-proto-message":"ves.io.schema.scim.Meta","properties":{"created":{"type":"string","description":" create date.\n\nExample: ` \"2011-08-08T04:56:22Z\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"created","x-displayname":"created","x-ves-example":"2011-08-08T04:56:22Z","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"lastModified":{"type":"string","description":" last modification date and time.\n\nExample: ` \"2011-08-08T08:00:12Z\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"lastModified","x-displayname":"lastModified","x-ves-example":"2011-08-08T08:00:12Z","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"location":{"type":"string","description":" [x-required]\n location for resource.\n\nExample: ` \"/ResourceType/Users\"`\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"location","x-displayname":"location","x-ves-example":"/ResourceType/Users","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"resourceType":{"type":"string","description":" type of resource.\n\nExample: ` \"User\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"resourceType","x-displayname":"schemas","x-ves-example":"User","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"version":{"type":"string","description":" version for resource type.\n\nExample: ` \"2.0\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"version","x-displayname":"version","x-ves-example":"2.0","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimName":{"type":"object","description":"Name is the name of user.","title":"Name","x-displayname":"Name","x-ves-proto-message":"ves.io.schema.scim.Name","properties":{"familyName":{"type":"string","description":" Family name.\n\nExample: ` \"Downey\"`","title":"familyName","x-displayname":"familyName","x-ves-example":"Downey"},"formatted":{"type":"string","description":" Formatted name is detailed name of person.\n\nExample: ` \"R Downey Jr\"`","title":"formatted","x-displayname":"formatted","x-ves-example":"R Downey Jr"},"givenName":{"type":"string","description":" Given name of the person.\n\nExample: ` \"Robert J Downey Jr\"`","title":"givenName","x-displayname":"givenName","x-ves-example":"Robert J Downey Jr"},"honorificPrefix":{"type":"string","description":" Prefix for the name. Mr Ms. etc.\n\nExample: ` \"Mr\"`","title":"honorificPrefix","x-displayname":"honorificPrefix","x-ves-example":"Mr"},"honorificSuffix":{"type":"string","description":" Suffix for the name like Jr Sr I II III etc.\n\nExample: ` \"IV\"`","title":"honorificSuffix","x-displayname":"honorificSuffix","x-ves-example":"IV"},"middleName":{"type":"string","description":" Middle name of the person.\n\nExample: ` \"K\"`","title":"middleName","x-displayname":"middleName","x-ves-example":"K"}}},"scimPatchGroupRequest":{"type":"object","description":"Patch operation to modify group.","title":"PatchGroupOperation","x-displayname":"PatchGroupOperation","x-ves-proto-message":"ves.io.schema.scim.PatchGroupRequest","properties":{"Operations":{"type":"array","description":" Operations to modify or delete group.\n\nExample: ` \"add, remove, replace, delete\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Operations","items":{"$ref":"#/components/schemas/scimPatchOperation"},"x-displayname":"Operations","x-ves-example":"add, remove, replace, delete","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"id":{"type":"string","description":" unique Id for the group.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"id","x-displayname":"id","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" schemas as per scim spec.\n\nExample: ` \"schemas per scim spec\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"schemas per scim spec","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimPatchOperation":{"type":"object","description":"PatchOperation is the patch operation where user can be  updated replaced or remove..\nsupported op types are add, remove, replace\nremove is remove a specific entry.","title":"PatchOperation","x-displayname":"Patch Operation","x-ves-proto-message":"ves.io.schema.scim.PatchOperation","properties":{"op":{"type":"string","description":" op \"add\", \"replace\", \"remove\", \"delete\"\n\nExample: ` \"\"op\"\"add\"\"`","title":"op","x-displayname":"op","x-ves-example":"\"op\": \"add\""},"path":{"type":"string","description":" path to the field where the change needs to happen.\n\nExample: ` \"\"path\"\"name.formatted\"\"`","title":"path","x-displayname":"path","x-ves-example":"\"path\": \"name.formatted\""},"value":{"type":"object","description":" value to be used for modifying the object. In case of delete nothing needs to be specified.\n\nExample: ` \"\"value\"\"New Formatted Name\"\"`","title":"value","x-displayname":"value","x-ves-example":"\"value\": \"New Formatted Name\""}}},"scimPatchUserRequest":{"type":"object","description":"x-example: {\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n   operation\": [{\n    \"op\": \"add\",\n    \"path\": \"name.preferredName\",\n    \"value\": \"New preferred Name\"\n    }]\n},\n\"id\": \"1234-5678-901234\"\n\n}\nPatchUserRequest patches the user object or deletes it.","title":"PatchUserRequest","x-displayname":"PatchUserRequest","x-ves-proto-message":"ves.io.schema.scim.PatchUserRequest","properties":{"Operations":{"type":"array","description":"     \"op\": \"add\",\n     \"path\": \"name.preferredName\",\n     \"value\": \"new name\"\n     }]\n }\"\"\n operations that will modify or delete the user object.\n\nExample: ` \"\"operations\"[{`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"operations","items":{"$ref":"#/components/schemas/scimPatchOperation"},"x-displayname":"operations","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"id":{"type":"string","description":" id of the user object that needs patching.\n\nExample: ` \"\"id\"\"1234-5678-901234\"\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"id","x-displayname":"id","x-ves-example":"\"id\": \"1234-5678-901234\"","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" schemas for patch.\n\nExample: ` \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"urn:ietf:params:scim:api:messages:2.0:PatchOp","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimResource":{"type":"object","description":"Resource","title":"Resource","x-displayname":"Resource","x-ves-proto-message":"ves.io.schema.scim.Resource","properties":{"endpoint":{"type":"string","description":" [x-example: \"/Groups\"]\n [x-required]\n endpoint for the resource..\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endpoint","x-displayname":"endPoint","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"id":{"type":"string","description":" [x-example: \"Group\"]\n [x-required]\n Id of the resource.\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Id","x-displayname":"id","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"meta":{"$ref":"#/components/schemas/scimResourceMeta"},"name":{"type":"string","description":" [x-example: \"Group\"]\n [x-required]\n name of the resource.\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schema":{"type":"string","description":" [x-example: \"urn:ietf:params:scim:schemas:core:2.0:ResourceType]\n [x-required]\n Schema defined in scim spec..\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schema","x-displayname":"schema","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" [x-example: \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"]\n [x-required]\n schemas defined in scim spec.\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimResourceMeta":{"type":"object","description":"ResourceMeta.","title":"ResourceMeta","x-displayname":"ResourceMeta","x-ves-proto-message":"ves.io.schema.scim.ResourceMeta","properties":{"location":{"type":"string","description":" location of resource.\n\nExample: ` \"/Resurce/User\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"location","x-displayname":"location","x-ves-example":"/Resurce/User","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"resourceType":{"type":"string","description":" resourceType represents resource.\n\nExample: ` \"User\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"resourceType","x-displayname":"resourceType","x-ves-example":"User","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimResourceTypesResponse":{"type":"object","description":"ResourceTypesResponse","title":"ResourceTypesResponse","x-displayname":"ResourceTypesResponse","x-ves-proto-message":"ves.io.schema.scim.ResourceTypesResponse","properties":{"detail":{"type":"string","description":" detail defines the details of the response status","title":"detail","x-displayname":"status"},"resources":{"type":"array","description":" [x-example: \"resources\"]\n [x-required]\n Resources for the query.\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"resources","items":{"$ref":"#/components/schemas/scimResource"},"x-displayname":"resources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" [x-example: \"urn:ietf:params:scim:schemas:core:2.0:ResourceType\"]\n [x-required]\n schemas defined by scim spec..\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"status":{"type":"string","description":" status defines the status code of the response","title":"status","x-displayname":"status"},"totalResults":{"type":"string","description":" [x-example: \"8\"]\n [x-required]\n No of results for the query.\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"totalResults","format":"uint64","x-displayname":"totalResults","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimServiceProviderConfigResponse":{"type":"object","description":"ServiceProviderConfigResponse.","title":"ServiceProviderConfigResponse","x-displayname":"ServiceProviderConfigResponse","x-ves-proto-message":"ves.io.schema.scim.ServiceProviderConfigResponse","properties":{"authenticationSchemes":{"type":"array","description":" supported authenticationSchemes for the resource.\n\nExample: ` \"--\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"authenticationSchemes","items":{"type":"string"},"x-displayname":"authenticationSchemes","x-ves-example":"--","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"bulk":{"$ref":"#/components/schemas/scimSupport"},"changePassword":{"$ref":"#/components/schemas/scimSupport"},"documentationUri":{"type":"string","description":" uri for documentation.\n\nExample: ` \"https://example.com./scumentation/uri\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"documentationUri","x-displayname":"documentationUri","x-ves-example":"https://example.com./scumentation/uri","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"etag":{"$ref":"#/components/schemas/scimSupport"},"filter":{"$ref":"#/components/schemas/scimFilter"},"patch":{"$ref":"#/components/schemas/scimSupport"},"schemas":{"type":"array","description":" schemas scim spec.\n\nExample: ` \"urn:ietf:params:scim:schemas:core:2.0:ResourceType\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"urn:ietf:params:scim:schemas:core:2.0:ResourceType","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"sort":{"$ref":"#/components/schemas/scimSupport"}}},"scimSupport":{"type":"object","description":"Support.","title":"Support","x-displayname":"Support","x-ves-proto-message":"ves.io.schema.scim.Support","properties":{"supported":{"type":"boolean","description":" is support supported.\n\nExample: ` \"true/false\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"supported","format":"boolean","x-displayname":"supported","x-ves-example":"true/false","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"scimUser":{"type":"object","description":"User object representing the user created.","title":"User","x-displayname":"User","x-ves-proto-message":"ves.io.schema.scim.User","properties":{"active":{"type":"boolean","description":" active specifies if user is active or not.\n\nExample: ` \"true/false\"`","title":"active","format":"boolean","x-displayname":"active","x-ves-example":"true/false"},"displayName":{"type":"string","description":" displayName for the user.\n\nExample: ` \"Rodney\"`","title":"displayName","x-displayname":"displayName","x-ves-example":"Rodney"},"emails":{"type":"array","description":" emails for the user whether primary or secondary.\n\nExample: ` \"test@email.com\"`","title":"emails","items":{"$ref":"#/components/schemas/scimEmail"},"x-displayname":"emails","x-ves-example":"test@email.com"},"externalId":{"type":"string","description":" externalId specifies the id for the user object in external system.\n\nExample: ` \"rod_1234\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"externalId","x-displayname":"externalId","x-ves-example":"rod_1234","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"groups":{"type":"array","description":" groups to which user is part of.\n\nExample: ` \"group-id\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"groups","items":{"$ref":"#/components/schemas/scimUserGroup"},"x-displayname":"groups","x-ves-example":"group-id","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"id":{"type":"string","description":" id for user object.\n\nExample: ` \"123-456-789012\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"id","x-displayname":"id","x-ves-example":"123-456-789012","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"meta":{"$ref":"#/components/schemas/scimMeta"},"name":{"$ref":"#/components/schemas/scimName"},"nickName":{"type":"string","description":" nickName for the user.\n\nExample: ` \"Rod\"`","title":"nickName","x-displayname":"nickName","x-ves-example":"Rod"},"roles":{"type":"array","description":" roles defined for the user.\n\nExample: ` \"roles\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"roles","items":{"type":"string"},"x-displayname":"roles","x-ves-example":"roles","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"schemas":{"type":"array","description":" schemas for user object as per scim spec 2.0.\n\nExample: ` \"urn:ietf:params:scim:schemas:core:2.0:User\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"schemas","items":{"type":"string"},"x-displayname":"schemas","x-ves-example":"urn:ietf:params:scim:schemas:core:2.0:User","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"userName":{"type":"string","description":" userName for the user.\n\nExample: ` \"rod_1234\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"userName","x-displayname":"userName","x-ves-example":"rod_1234","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"userType":{"$ref":"#/components/schemas/userUserType"}}},"scimUserGroup":{"type":"object","description":"UserGroup.","title":"UserGroup","x-displayname":"UserGroup","x-ves-proto-message":"ves.io.schema.scim.UserGroup","properties":{"display":{"type":"string","description":" display for the user group name.\n\nExample: ` \"Group-1\"`","title":"display","x-displayname":"display","x-ves-example":"Group-1"},"id":{"type":"string","description":" Id of the group to which user belongs.\n\nExample: ` \"1234-2345-123456\"`","title":"id","x-displayname":"id","x-ves-example":"1234-2345-123456"}}},"userUserType":{"type":"string","description":"UserType is to identify the type of user\n\n - USER: User\nRegular User\n - SERVICE: Service User\nUser for accessing only APIs/services\n - DEBUG: Debug\nUser which was created by tenant admin for volterra-support team.","title":"UserType","enum":["USER","SERVICE","DEBUG"],"default":"USER","x-displayname":"User Type","x-ves-proto-enum":"ves.io.schema.user.UserType"}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.tpm_api_key","description":"TPM API Keys are used by TPM provisioning tool during manufacturing to call in to F5XC TPM provisioning service to generate\nEK certificates and provision them in the Volterra's Customer Edge(CE) devices' TPM chip.","version":""},"paths":{"/api/tpm/namespaces/{metadata.namespace}/tpm_api_keys":{"post":{"summary":"Create TPM API Key","description":"APIKey object when successfully created returns actual APIKey bytes which is used by the users to call in to\nTPM provisioning API.","operationId":"ves.io.schema.tpm_api_key.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tpm_api_keyCreateResponse"}}}},"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/tpm_api_keyCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tpm_api_key-api-create"},"x-ves-proto-rpc":"ves.io.schema.tpm_api_key.API.Create"},"x-displayname":"TPM API Key","x-ves-proto-service":"ves.io.schema.tpm_api_key.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/tpm/namespaces/{metadata.namespace}/tpm_api_keys/{metadata.name}":{"put":{"summary":"Replace TPM API Key","description":"Replace a APIKey object's revocation or enable/disable status. A revoked APIKey is not considered disabled.\nCertificates minted using disabled APIKeys are rejected during system bring-up/verification stage,\nwhereas certificates minted using revoked APIKeys are only rejected if they were minted after revocation date","operationId":"ves.io.schema.tpm_api_key.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tpm_api_keyReplaceResponse"}}}},"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/tpm_api_keyReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tpm_api_key-api-replace"},"x-ves-proto-rpc":"ves.io.schema.tpm_api_key.API.Replace"},"x-displayname":"TPM API Key","x-ves-proto-service":"ves.io.schema.tpm_api_key.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/tpm/namespaces/{namespace}/tpm_api_keys":{"get":{"summary":"List TPM API Key","description":"List the set of tpm_api_key in a namespace","operationId":"ves.io.schema.tpm_api_key.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tpm_api_keyListResponse"}}}},"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 tpm_api_key","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-tpm_api_key-api-list"},"x-ves-proto-rpc":"ves.io.schema.tpm_api_key.API.List"},"x-displayname":"TPM API Key","x-ves-proto-service":"ves.io.schema.tpm_api_key.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/tpm/namespaces/{namespace}/tpm_api_keys/{name}":{"get":{"summary":"Get TPM API Key","description":"Retrieve an APIKey object","operationId":"ves.io.schema.tpm_api_key.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tpm_api_keyGetResponse"}}}},"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-tpm_api_key-api-get"},"x-ves-proto-rpc":"ves.io.schema.tpm_api_key.API.Get"},"x-displayname":"TPM API Key","x-ves-proto-service":"ves.io.schema.tpm_api_key.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"TPM API Key","x-ves-proto-package":"ves.io.schema.tpm_api_key","components":{"schemas":{"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":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\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-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"},"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"},"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"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"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-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"}}},"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"}}},"tpm_api_keyCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of tpm_api_key","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.tpm_api_key.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/tpm_api_keyCreateSpecType"}}},"tpm_api_keyCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.tpm_api_key.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/tpm_api_keyGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"tpm_api_keyCreateSpecType":{"type":"object","description":"APIKey object when successfully created returns actual APIKey bytes which is used by the users to call in to\nTPM provisioning API.","title":"Create APIKey","x-displayname":"Create TPM API Key","x-ves-proto-message":"ves.io.schema.tpm_api_key.CreateSpecType","properties":{"category_ref":{"type":"array","description":" APIKey needs a reference to an existing TPM category object\n TPM category is used for grouping customer owned APIKeys and manage them as one entity\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"reference to category","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"TPM Category","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1","ves.io.schema.rules.repeated.min_items":"1"}},"need_mtls":{"type":"boolean","description":" is mTLS required when using this APIKey?\n\nExample: ` \"true\"`","title":"need mTLS","format":"boolean","x-displayname":"Need mTLS","x-ves-example":"true"}}},"tpm_api_keyGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read tpm_api_key","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.tpm_api_key.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/tpm_api_keyCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/tpm_api_keyReplaceRequest"},"spec":{"$ref":"#/components/schemas/tpm_api_keyGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/tpm_api_keyStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"tpm_api_keyGetResponseFormatCode":{"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"},"tpm_api_keyGetSpecType":{"type":"object","description":"Retrieve an APIKey object","title":"Get APIKey","x-displayname":"Get TPM API Key","x-ves-proto-message":"ves.io.schema.tpm_api_key.GetSpecType","properties":{"category_ref":{"type":"array","description":" APIKey needs a reference to an existing TPM category object\n TPM category is used for grouping customer owned APIKeys and manage them as one entity\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"reference to category","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"TPM Category","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1","ves.io.schema.rules.repeated.min_items":"1"}},"is_disabled":{"type":"boolean","description":" if true that indicates that this APIKey is disabled\n\nExample: ` \"true\"`","title":"is disabled","format":"boolean","x-displayname":"is_disabled","x-ves-example":"true"},"need_mtls":{"type":"boolean","description":" is mTLS required when using this APIKey?\n\nExample: ` \"true\"`","title":"is mTLS required?","format":"boolean","x-displayname":"Need mTLS","x-ves-example":"true"},"revoke_reason":{"type":"string","description":" if the APIKey is revoked then this value stores date and time after which the revocation is enforced.\n\nExample: ` \"value\"`","title":"revocation reason","x-displayname":"revoke_reason","x-ves-example":"value"},"revoked_timestamp":{"type":"string","description":" if the APIKey is revoked then this value stores date and time after which the revocation is enforced.","title":"revocation timestamp","format":"date-time","x-displayname":"revoked_timestamp"}}},"tpm_api_keyListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of tpm_api_key","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.tpm_api_key.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/tpm_api_keyListResponseItem"},"x-displayname":"Items"}}},"tpm_api_keyListResponseItem":{"type":"object","description":"By default a summary of tpm_api_key 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 tpm_api_key","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.tpm_api_key.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this tpm_api_key","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this tpm_api_key","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates tpm_api_key is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/tpm_api_keyGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this tpm_api_key","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this tpm_api_key\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/tpm_api_keyStatusObject"},"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 tpm_api_key\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"tpm_api_keyReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a tpm_api_key","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.tpm_api_key.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/tpm_api_keyReplaceSpecType"}}},"tpm_api_keyReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.tpm_api_key.ReplaceResponse"},"tpm_api_keyReplaceSpecType":{"type":"object","description":"Replace a APIKey object's revocation or enable/disable status. A revoked APIKey is not considered disabled.\nCertificates minted using disabled APIKeys are rejected during system bring-up/verification stage,\nwhereas certificates minted using revoked APIKeys are only rejected if they were minted after revocation date","title":"Replace APIKey","x-displayname":"Replace TPM API Key","x-ves-proto-message":"ves.io.schema.tpm_api_key.ReplaceSpecType","properties":{"is_disabled":{"type":"boolean","description":" if true that indicates that this APIKey is disabled\n\nExample: ` \"true\"`","title":"is disabled","format":"boolean","x-displayname":"is_disabled","x-ves-example":"true"},"revoke_reason":{"type":"string","description":" if the APIKey is revoked then this value stores date and time after which the revocation is enforced.\n\nExample: ` \"value\"`","title":"revocation reason","x-displayname":"revoke_reason","x-ves-example":"value"},"revoked_timestamp":{"type":"string","description":" if the APIKey is revoked then this value stores date and time after which the revocation is enforced.","title":"timestamp when this apikey was revoked","format":"date-time","x-displayname":"revoked_timestamp"}}},"tpm_api_keyStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status Object","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.tpm_api_key.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Reference to object for current status","title":"object_refs","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Config Object"}}}}}}