@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.srv6_network_slice","description":"An srv6_network_slice represents a network slice in an operator network that uses SRv6.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/srv6_network_slices":{"post":{"summary":"Create SRv6 Network Slice","description":"Create srv6_network_slice creates a new object in the storage backend for metadata.namespace.","operationId":"ves.io.schema.srv6_network_slice.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/srv6_network_sliceCreateResponse"}}}},"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/srv6_network_sliceCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-srv6_network_slice-api-create"},"x-ves-proto-rpc":"ves.io.schema.srv6_network_slice.API.Create"},"x-displayname":"SRv6 Network Slice","x-ves-proto-service":"ves.io.schema.srv6_network_slice.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/srv6_network_slices/{metadata.name}":{"put":{"summary":"Replace SRv6 Network Slice","description":"Replace srv6_network_slice replaces an existing object in the storage backend for metadata.namespace.","operationId":"ves.io.schema.srv6_network_slice.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/srv6_network_sliceReplaceResponse"}}}},"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/srv6_network_sliceReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-srv6_network_slice-api-replace"},"x-ves-proto-rpc":"ves.io.schema.srv6_network_slice.API.Replace"},"x-displayname":"SRv6 Network Slice","x-ves-proto-service":"ves.io.schema.srv6_network_slice.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/srv6_network_slices":{"get":{"summary":"List SRv6 Network Slice","description":"List the set of srv6_network_slice in a namespace","operationId":"ves.io.schema.srv6_network_slice.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/srv6_network_sliceListResponse"}}}},"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 srv6_network_slice","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-srv6_network_slice-api-list"},"x-ves-proto-rpc":"ves.io.schema.srv6_network_slice.API.List"},"x-displayname":"SRv6 Network Slice","x-ves-proto-service":"ves.io.schema.srv6_network_slice.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/srv6_network_slices/{name}":{"get":{"summary":"Get SRv6 Network Slice","description":"Get srv6_network_slice reads a given object from storage backend for metadata.namespace.","operationId":"ves.io.schema.srv6_network_slice.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/srv6_network_sliceGetResponse"}}}},"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-srv6_network_slice-api-get"},"x-ves-proto-rpc":"ves.io.schema.srv6_network_slice.API.Get"},"delete":{"summary":"Delete SRv6 Network Slice","description":"Delete the specified srv6_network_slice","operationId":"ves.io.schema.srv6_network_slice.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/srv6_network_sliceDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-srv6_network_slice-api-delete"},"x-ves-proto-rpc":"ves.io.schema.srv6_network_slice.API.Delete"},"x-displayname":"SRv6 Network Slice","x-ves-proto-service":"ves.io.schema.srv6_network_slice.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"SRv6 Network Slice","x-ves-proto-package":"ves.io.schema.srv6_network_slice","components":{"schemas":{"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"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"}}},"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"}}},"schemasrv6_network_sliceCreateSpecType":{"type":"object","description":"Create srv6_network_slice creates a new object in the storage backend for metadata.namespace.","title":"Create srv6_network_slice","x-displayname":"Create SRv6 Network Slice","x-ves-proto-message":"ves.io.schema.srv6_network_slice.CreateSpecType","properties":{"connect_to_access_networks":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to their corresponding access networks by importing route\n targets specified in the virtual network.","format":"boolean","x-displayname":"Connect To Access Networks"},"connect_to_enterprise_networks":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to their corresponding enterprise networks by importing route\n targets specified in the virtual network.","format":"boolean","x-displayname":"Connect To Enterprise Networks"},"connect_to_internet":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to the Internet by importing route targets specified in the\n virtual network.","format":"boolean","x-displayname":"Connect To Internet"},"sid_prefixes":{"type":"array","description":" A SID Locator from the prefix is allocated automatically for each node in each site.\n\nExample: ` \"cafe:f00d::0/32\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ipv6_prefix: true\n  ves.io.schema.rules.repeated.items.string.max_ip_prefix_length: 32\n  ves.io.schema.rules.repeated.items.string.min_ip_prefix_length: 32\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":1,"items":{"type":"string"},"x-displayname":"IPv6 Prefix for SID Allocation","x-ves-example":"cafe:f00d::0/32","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ipv6_prefix":"true","ves.io.schema.rules.repeated.items.string.max_ip_prefix_length":"32","ves.io.schema.rules.repeated.items.string.min_ip_prefix_length":"32","ves.io.schema.rules.repeated.max_items":"1","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"schemasrv6_network_sliceGetSpecType":{"type":"object","description":"Get srv6_network_slice reads a given object from storage backend for metadata.namespace.","title":"Get srv6_network_slice","x-displayname":"Get SRv6 Network Slice","x-ves-proto-message":"ves.io.schema.srv6_network_slice.GetSpecType","properties":{"connect_to_access_networks":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to their corresponding access networks by importing route\n targets specified in the virtual network.","format":"boolean","x-displayname":"Connect To Access Networks"},"connect_to_enterprise_networks":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to their corresponding enterprise networks by importing route\n targets specified in the virtual network.","format":"boolean","x-displayname":"Connect To Enterprise Networks"},"connect_to_internet":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to the Internet by importing route targets specified in the\n virtual network.","format":"boolean","x-displayname":"Connect To Internet"},"sid_prefixes":{"type":"array","description":" A SID Locator from the prefix is allocated automatically for each node in each site.\n\nExample: ` \"cafe:f00d::0/32\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ipv6_prefix: true\n  ves.io.schema.rules.repeated.items.string.max_ip_prefix_length: 32\n  ves.io.schema.rules.repeated.items.string.min_ip_prefix_length: 32\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":1,"items":{"type":"string"},"x-displayname":"IPv6 Prefix for SID Allocation","x-ves-example":"cafe:f00d::0/32","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ipv6_prefix":"true","ves.io.schema.rules.repeated.items.string.max_ip_prefix_length":"32","ves.io.schema.rules.repeated.items.string.min_ip_prefix_length":"32","ves.io.schema.rules.repeated.max_items":"1","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"schemasrv6_network_sliceReplaceSpecType":{"type":"object","description":"Replace srv6_network_slice replaces an existing object in the storage backend for metadata.namespace.","title":"Replace srv6_network_slice","x-displayname":"Replace SRv6 Network Slice","x-ves-proto-message":"ves.io.schema.srv6_network_slice.ReplaceSpecType","properties":{"connect_to_access_networks":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to their corresponding access networks by importing route\n targets specified in the virtual network.","format":"boolean","x-displayname":"Connect To Access Networks"},"connect_to_enterprise_networks":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to their corresponding enterprise networks by importing route\n targets specified in the virtual network.","format":"boolean","x-displayname":"Connect To Enterprise Networks"},"connect_to_internet":{"type":"boolean","description":" Connect all SRv6 Virtual Networks in this slice to the Internet by importing route targets specified in the\n virtual network.","format":"boolean","x-displayname":"Connect To Internet"},"sid_prefixes":{"type":"array","description":" A SID Locator from the prefix is allocated automatically for each node in each site.\n\nExample: ` \"cafe:f00d::0/32\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ipv6_prefix: true\n  ves.io.schema.rules.repeated.items.string.max_ip_prefix_length: 32\n  ves.io.schema.rules.repeated.items.string.min_ip_prefix_length: 32\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":1,"items":{"type":"string"},"x-displayname":"IPv6 Prefix for SID Allocation","x-ves-example":"cafe:f00d::0/32","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ipv6_prefix":"true","ves.io.schema.rules.repeated.items.string.max_ip_prefix_length":"32","ves.io.schema.rules.repeated.items.string.min_ip_prefix_length":"32","ves.io.schema.rules.repeated.max_items":"1","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"srv6_network_sliceCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of srv6_network_slice","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.srv6_network_slice.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemasrv6_network_sliceCreateSpecType"}}},"srv6_network_sliceCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.srv6_network_slice.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemasrv6_network_sliceGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"srv6_network_sliceDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a srv6_network_slice","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.srv6_network_slice.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"srv6_network_sliceGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read srv6_network_slice","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.srv6_network_slice.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/srv6_network_sliceCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/srv6_network_sliceReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemasrv6_network_sliceGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/srv6_network_sliceStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"srv6_network_sliceGetResponseFormatCode":{"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"},"srv6_network_sliceListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of srv6_network_slice","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.srv6_network_slice.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/srv6_network_sliceListResponseItem"},"x-displayname":"Items"}}},"srv6_network_sliceListResponseItem":{"type":"object","description":"By default a summary of srv6_network_slice 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 srv6_network_slice","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.srv6_network_slice.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this srv6_network_slice","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this srv6_network_slice","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates srv6_network_slice is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemasrv6_network_sliceGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this srv6_network_slice","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this srv6_network_slice\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/srv6_network_sliceStatusObject"},"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 srv6_network_slice\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"srv6_network_sliceReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a srv6_network_slice","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.srv6_network_slice.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemasrv6_network_sliceReplaceSpecType"}}},"srv6_network_sliceReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.srv6_network_slice.ReplaceResponse"},"srv6_network_sliceStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Status for srv6_network_slice","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.srv6_network_slice.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":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.oidc_provider","description":"F5XC Identity supports identity brokering and third-party identity can be added to\nprovide Single Sign-On (SSO) login for user to access tenant via VoltConsole. \nUsing Volterra's OIDC Provider config object API(s), tenant admin can configure and manage\nSSO providers such as Google, Microsoft, Okta or any provider that supports\nOpenIDConnect(OIDC) V1.0 protocol. It is required that the OIDC provider application that will \nbe integrated must have the support enabled for Authorization Code flow as defined by the specification.\n\nBefore proceeding, admin needs to have access to organization's authentication application\nor has permission to create a new one. Create API require entering details of well-known\nOpenID configuration of authentication application and once successful creation, admin should\nenable the redirect URL provided by volterra identity in application's allowed list of URLs. \nMore details of this can be found under create request/response.\n\nWith OIDC provider configured, admin of a tenant can make use of Single Sign On (SSO)\nfunctionality for users to access F5XC service using same email address and admin has the\nflexibility to re-use the authentication/identity provider that may be already using \nwithin their organization. Once SSO is enabled, except tenant admin (owner) all users in the tenant \nwill be converted to SSO user and will lose existing email/password login created with Volterra\nand can only use SSO to login.","version":""},"paths":{"/api/web/custom/namespaces/{namespace}/oidc_provider/{name}":{"get":{"summary":"Get","description":"Get implements oidc provider query by name.\nReturns oidc provider object. Query will look into current tenants `system` namespace for oidc provider by name.","operationId":"ves.io.schema.oidc_provider.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaoidc_providerGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"value\"\nName of OIDC provider object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.Get"},"x-displayname":"SSO/OIDC Provider","x-ves-proto-service":"ves.io.schema.oidc_provider.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/namespaces/{namespace}/oidc_provider/{name}/delete":{"post":{"summary":"Delete","description":"Delete deletes oidc provider by name. This would also disable SCIM integration for the tenant, if at all, it was enabled.\nReturns oidc provider object that gets deleted. Query will look into current tenants `system` namespace for oidc provider by name.","operationId":"ves.io.schema.oidc_provider.CustomAPI.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerDeleteResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"value\"\nName of OIDC provider object.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/schemaoidc_providerDeleteRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-delete"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.Delete"},"x-displayname":"SSO/OIDC Provider","x-ves-proto-service":"ves.io.schema.oidc_provider.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/namespaces/{namespace}/oidc_providers":{"get":{"summary":"List","description":"List implements oidc provider query.\nReturns list of oidc provider of all types. Query will look into current tenants `system` namespace.","operationId":"ves.io.schema.oidc_provider.CustomAPI.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaoidc_providerListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-list"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.List"},"post":{"summary":"Create","description":"Create creates an OIDC provider in F5XC Identity.\nCurrently we support creating provider for brokering Google identity provider and \nany generic OIDC provider that support OpenID Connect protocol V1.0.\nTo configure type Google (provider_type 1), user is not required to provide well-known URL \ndetails as its already pre-configured. Parameters such as client ID, client secret and additional\noptional parameters as specified in the create schema needs to be provided.\nTo configure default type (provider_type 0), user needs to provide well-known URLs and additional\nfields as required part of create schema. \nCheck create response section for the details on action that needs to be taken post\nsending a successful create request.","operationId":"ves.io.schema.oidc_provider.CustomAPI.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaoidc_providerCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaoidc_providerCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-create"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.Create"},"x-displayname":"SSO/OIDC Provider","x-ves-proto-service":"ves.io.schema.oidc_provider.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/namespaces/{namespace}/oidc_providers/{name}":{"get":{"summary":"Get","description":"Get implements oidc provider query by name.\nReturns oidc provider object. Query will look into current tenants `system` namespace for oidc provider by name.","operationId":"ves.io.schema.oidc_provider.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaoidc_providerGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"value\"\nName of OIDC provider object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.Get"},"post":{"summary":"Replace","description":"Replace updates OIDC provider parameters for a given provider instance.\nsince we never store client secret, any time this operation is performed,\nuser will need to input the original/new client secret along with other existing\nfields as delta operations is not supported.\n\n`NOTE`: Operations performed via API client is encouraged to issue a detail GET on the current \noidc_provider resource to retrieve all configured fields and this can be used in constructing payload\nfor the update operation. Params which are not sent as part of replace operation will get removed/unset\nif those params were configured prior to this operation. so its important that replace operation payload \nneeds to have complete fields with their values as required in your final configuration.\nfor example: admin needs to update client secret of an existing SSO configuation - first issue detail get on the\ncurrent oidc_provider resource, use all of the fields in `spec.gc_spec` from response and construct the replace\nrequest spec. Now update only client_secret field with the new value as required and send request.","operationId":"ves.io.schema.oidc_provider.CustomAPI.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"google\"\nName of the oidc_provider object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/oidc_providerReplaceRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-replace"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.Replace"},"put":{"summary":"Replace","description":"Replace updates OIDC provider parameters for a given provider instance.\nsince we never store client secret, any time this operation is performed,\nuser will need to input the original/new client secret along with other existing\nfields as delta operations is not supported.\n\n`NOTE`: Operations performed via API client is encouraged to issue a detail GET on the current \noidc_provider resource to retrieve all configured fields and this can be used in constructing payload\nfor the update operation. Params which are not sent as part of replace operation will get removed/unset\nif those params were configured prior to this operation. so its important that replace operation payload \nneeds to have complete fields with their values as required in your final configuration.\nfor example: admin needs to update client secret of an existing SSO configuation - first issue detail get on the\ncurrent oidc_provider resource, use all of the fields in `spec.gc_spec` from response and construct the replace\nrequest spec. Now update only client_secret field with the new value as required and send request.","operationId":"ves.io.schema.oidc_provider.CustomAPI.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"google\"\nName of the oidc_provider object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/oidc_providerReplaceRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-replace"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.Replace"},"x-displayname":"SSO/OIDC Provider","x-ves-proto-service":"ves.io.schema.oidc_provider.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/delete":{"post":{"summary":"Delete","description":"Delete deletes oidc provider by name. This would also disable SCIM integration for the tenant, if at all, it was enabled.\nReturns oidc provider object that gets deleted. Query will look into current tenants `system` namespace for oidc provider by name.","operationId":"ves.io.schema.oidc_provider.CustomAPI.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerDeleteResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"value\"\nName of OIDC provider object.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/schemaoidc_providerDeleteRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-delete"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.Delete"},"x-displayname":"SSO/OIDC Provider","x-ves-proto-service":"ves.io.schema.oidc_provider.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers":{"get":{"summary":"Get OIDC mappers","description":"Get OIDC mappers gets OIDC mappers from underlying IDM provider.","operationId":"ves.io.schema.oidc_provider.CustomAPI.GetOIDCMappers","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerOIDCMappers"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace contains namespace of OIDC provider. Namespace should be system.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"OIDC provider name\n\nx-example: \"[oidc, google, azure-oidc]\"\nName contains name/alias of underlying OIDC provider.","in":"path","required":true,"x-displayname":"OIDC provider name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-getoidcmappers"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.GetOIDCMappers"},"post":{"summary":"Update OIDC mappers","description":"Update OIDC mappers updates OIDC mappers in underlying IDM provider.","operationId":"ves.io.schema.oidc_provider.CustomAPI.UpdateOIDCMappers","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace contains namespace of OIDC provider. Namespace should be system.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"OIDC provider name\n\nx-example: \"[oidc, google, azure-oidc]\"\nName contains name/alias of underlying OIDC provider.","in":"path","required":true,"x-displayname":"OIDC provider name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerUpdateOIDCMappersRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-updateoidcmappers"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.UpdateOIDCMappers"},"x-displayname":"SSO/OIDC Provider","x-ves-proto-service":"ves.io.schema.oidc_provider.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/scim":{"put":{"summary":"Update OIDC provider SCIM Integration","description":"Enables / Disables the SCIM integration for the OIDC provider.","operationId":"ves.io.schema.oidc_provider.CustomAPI.UpdateScimIntegration","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerUpdateScimIntegrationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nSupports only system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"value\"\nName of OIDC provider object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerUpdateScimIntegrationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-oidc_provider-customapi-updatescimintegration"},"x-ves-proto-rpc":"ves.io.schema.oidc_provider.CustomAPI.UpdateScimIntegration"},"x-displayname":"SSO/OIDC Provider","x-ves-proto-service":"ves.io.schema.oidc_provider.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"SSO/OIDC Provider","x-ves-proto-package":"ves.io.schema.oidc_provider","components":{"requestBodies":{"oidc_providerReplaceRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oidc_providerReplaceRequest"}}},"required":true},"schemaoidc_providerDeleteRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaoidc_providerDeleteRequest"}}},"required":true}},"schemas":{"api_credentialRecreateScimTokenRequest":{"type":"object","description":"RecreateScimTokenRequest is the request format for generating SCIM api credential.","title":"Recreate SCIM Token Request","x-displayname":"Recreate SCIM Token Request","x-ves-proto-message":"ves.io.schema.api_credential.RecreateScimTokenRequest","properties":{"expiration_days":{"type":"integer","description":" Qty of days of service credential expiration. Default value is 180.\n Expiration days value can range between 1 and 730.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 730\n","title":"Expiry in days","format":"int64","x-displayname":"Expiry in days","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"730"}},"namespace":{"type":"string","description":" Value of namespace is always \"system\".\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"ioschemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"oidc_providerAzureOIDCSpecType":{"type":"object","description":"AzureOIDCSpecType specifies the attributes required to configure Azure provider","title":"AzureOIDCSpecType","x-displayname":"Azure OIDC Spec Type","x-ves-displayorder":"1,2,3,4,5,6,7,8,9,10","x-ves-proto-message":"ves.io.schema.oidc_provider.AzureOIDCSpecType","properties":{"authorization_url":{"type":"string","description":" The authorization url of your OIDC application.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"authorization url","x-displayname":"Authorization URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"backchannel_logout":{"type":"boolean","description":" Does the external IDP support backchannel logout?","title":"backchannel logout","format":"boolean","x-displayname":"Backchannel Logout"},"client_id":{"type":"string","description":" Client ID of the OIDC application registered with azure provider.\n REQUIRED field\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client ID","x-displayname":"Client ID","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"client_secret":{"type":"string","description":" Secret of the OIDC application registered with azure provider.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client secret","x-displayname":"Client Secret","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"default_scopes":{"type":"string","description":" The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.\n\nExample: ` \"openid profile email\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"default scopes","maxLength":256,"x-displayname":"Default Scopes","x-ves-example":"openid profile email","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}},"issuer":{"type":"string","description":" The issuer identifier for the issuer of the response. If not provided, no validation will be performed\n\nExample: ` \"value\"`","title":"issuer","x-displayname":"Issuer","x-ves-example":"value"},"jwks_url":{"type":"string","description":" URL where identity provider keys in JWK format are stored.\n\nExample: ` \"value\"`","title":"JWKS URL","x-displayname":"JWKS URL","x-ves-example":"value"},"logout_url":{"type":"string","description":" Logout URL specified in your OIDC application.\n\nExample: ` \"value\"`","title":"logout url","x-displayname":"Logout URL","x-ves-example":"value"},"prompt":{"$ref":"#/components/schemas/oidc_providerPromptType"},"token_url":{"type":"string","description":" The token URL of your OIDC application.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"token url","x-displayname":"Token URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"user_info_url":{"type":"string","description":" The User Info Url specified in your OIDC application.\n\nExample: ` \"value\"`","title":"user info url","x-displayname":"User Info URL","x-ves-example":"value"}}},"oidc_providerDeleteResponse":{"type":"object","description":"Shape of delete response for OIDC provider delete request.","title":"Delete Response","x-displayname":"Delete Response","x-ves-proto-message":"ves.io.schema.oidc_provider.DeleteResponse","properties":{"err":{"$ref":"#/components/schemas/schemaoidc_providerErrorCode"}}},"oidc_providerGoogleOIDCSpecType":{"type":"object","description":"GoogleOIDCSpecType specifies the attributes required to configure google provider","title":"GoogleOIDCSpecType","x-displayname":"Google OIDC Spec Type","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.oidc_provider.GoogleOIDCSpecType","properties":{"client_id":{"type":"string","description":" Client ID of the OIDC application registered with google provider.\n REQUIRED field\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client ID","x-displayname":"Client ID","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"client_secret":{"type":"string","description":" Secret of the OIDC application registered with google provider.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client secret","x-displayname":"Client Secret","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"hosted_domain":{"type":"string","description":" set hosted domain to restrict user input on login form to use email address from this email domain.\n for example, setting value company.com will enforce user email input to have only username@company.com\n leave empty if no restriction is required for email address. ie for example allow user@company1.com and user@company2.com\n\nExample: ` \"value\"`","title":"hosted domain","x-displayname":"Hosted Domain","x-ves-example":"value"}}},"oidc_providerOIDCMappers":{"type":"object","description":"When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right\nattributes for user object. Use this mapper to map values from authentication token to user attributes.","title":"OIDC Mappers","x-displayname":"OIDC Mappers","x-ves-proto-message":"ves.io.schema.oidc_provider.OIDCMappers","properties":{"email":{"type":"string","description":" Set authentication token field name to be used by F5XC for identifying user's email.\n Please ensure the field name using here is set as part of authentication token from corresponding\n provider's authentication application.\n\nExample: ` \"upn\"`","title":"Email","x-displayname":"Email","x-ves-example":"upn"}}},"oidc_providerOIDCV10SpecType":{"type":"object","description":"OIDCV10SpecType specifies the attributes required to configure OIDC provider","title":"OIDCV10SpecType","x-displayname":"OpenID Connect v1.0 Spec Type","x-ves-displayorder":"1,11,12,3,6,4,5,7,8,9,10,13,19,14,15,16,17,18","x-ves-proto-message":"ves.io.schema.oidc_provider.OIDCV10SpecType","properties":{"allowed_clock_skew":{"type":"string","description":" Clock skew in seconds that is tolerated when validating identity provider tokens. Default value is zero.\n\nExample: ` \"0\"`","title":"allowed clock skew","format":"int64","x-displayname":"Allowed Clock Skew","x-ves-example":"0"},"authorization_url":{"type":"string","description":" The authorization url of your OIDC application.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"authorization url","x-displayname":"Authorization URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"backchannel_logout":{"type":"boolean","description":" Does the external IDP support backchannel logout?","title":"backchannel logout","format":"boolean","x-displayname":"Backchannel Logout"},"client_id":{"type":"string","description":" Client ID of the OIDC application registered with your identity/OIDC provider.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client ID","x-displayname":"Client ID","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"client_secret":{"type":"string","description":" Secret of the OIDC application registered with your identity/OIDC provider.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client secret","x-displayname":"Client Secret","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"default_scopes":{"type":"string","description":" The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.\n\nExample: ` \"openid profile email\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"default scopes","maxLength":256,"x-displayname":"Default Scopes","x-ves-example":"openid profile email","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}},"disable_user_info":{"type":"boolean","description":" Disable fetching of user info information.","title":"disable user info","format":"boolean","x-displayname":"Disable User Info"},"display_name":{"type":"string","description":" Friendly name for identity provider\n\nExample: ` \"value\"`","title":"display name","x-displayname":"Display Name","x-ves-example":"value"},"forwarded_query_parameters":{"type":"string","description":" Non OpenID Connect/OAuth standard query parameters to be forwarded to external IDP from the initial application request\n to Authorization Endpoint. Multiple parameters can be entered, separated by comma (,).\n\nExample: ` \"value\"`","title":"forwarded query parameters","x-displayname":"Forwarded Query Parameters","x-ves-example":"value"},"issuer":{"type":"string","description":" The issuer identifier for the issuer of the response. If not provided, no validation will be performed.\n\nExample: ` \"value\"`","title":"issuer","x-displayname":"Issuer","x-ves-example":"value"},"jwks_url":{"type":"string","description":" URL where identity provider keys in JWK format are stored.\n\nExample: ` \"value\"`","title":"JWKS URL","x-displayname":"JWKS URL","x-ves-example":"value"},"logout_url":{"type":"string","description":" Logout URL specified in your OIDC application.\n\nExample: ` \"value\"`","title":"logout url","x-displayname":"Logout URL","x-ves-example":"value"},"pass_current_locale":{"type":"boolean","description":" Pass the current locale to the identity provider.","title":"pass current locale","format":"boolean","x-displayname":"Pass Current Locale"},"pass_login_hint":{"type":"boolean","description":" Pass login_hint to identity provider.","title":"pass login hint","format":"boolean","x-displayname":"Pass Login Hint"},"prompt":{"$ref":"#/components/schemas/oidc_providerPromptType"},"token_url":{"type":"string","description":" The token URL of your OIDC application.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"token url","x-displayname":"Token URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"user_info_url":{"type":"string","description":" The User Info Url specified in your OIDC application.\n\nExample: ` \"value\"`","title":"user info url","x-displayname":"User Info URL","x-ves-example":"value"},"validate_signatures":{"type":"boolean","description":" Enable/disable signature validation of external IDP signatures.","title":"validate signatures","format":"boolean","x-displayname":"Validate Signatures"}}},"oidc_providerOKTAOIDCSpecType":{"type":"object","description":"OKTAOIDCSpecType specifies the attributes required to configure okta OIDC provider","title":"OKTAOIDCSpecType","x-displayname":"Okta OpenID Connect Spec Type","x-ves-displayorder":"1,2,3,4,5,6,7,8,10,11","x-ves-proto-message":"ves.io.schema.oidc_provider.OKTAOIDCSpecType","properties":{"authorization_url":{"type":"string","description":" The authorization url of your OIDC application.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"authorization url","x-displayname":"Authorization URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"backchannel_logout":{"type":"boolean","description":" Does the external IDP support backchannel logout?","title":"backchannel logout","format":"boolean","x-displayname":"Backchannel Logout"},"client_id":{"type":"string","description":" Client ID of the OIDC application registered with azure provider.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client ID","x-displayname":"Client ID","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"client_secret":{"type":"string","description":" Secret of the OIDC application registered with azure provider.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"client secret","x-displayname":"Client Secret","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"default_scopes":{"type":"string","description":" The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.\n\nExample: ` \"openid profile email\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"default scopes","maxLength":256,"x-displayname":"Default Scopes","x-ves-example":"openid profile email","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}},"issuer":{"type":"string","description":" The issuer identifier for the issuer of the response. If not provided, no validation will be performed\n\nExample: ` \"value\"`","title":"issuer","x-displayname":"Issuer","x-ves-example":"value"},"jwks_url":{"type":"string","description":" URL where identity provider keys in JWK format are stored.\n\nExample: ` \"value\"`","title":"JWKS URL","x-displayname":"JWKS URL","x-ves-example":"value"},"logout_url":{"type":"string","description":" Logout URL specified in your OIDC application.\n\nExample: ` \"value\"`","title":"logout url","x-displayname":"Logout URL","x-ves-example":"value"},"prompt":{"$ref":"#/components/schemas/oidc_providerPromptType"},"token_url":{"type":"string","description":" The token URL of your OIDC application.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"token url","x-displayname":"Token URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"user_info_url":{"type":"string","description":" The User Info Url specified in your OIDC application.\n\nExample: ` \"value\"`","title":"user info url","x-displayname":"User Info URL","x-ves-example":"value"}}},"oidc_providerPromptType":{"type":"string","description":"Type of prompt authorization server for end-user reauthentication and consent\n\ndefault value for no prompt. when this is set, no prompt parameter will be set on authorization request.\nThe Authorization Server will not display any authentication or consent user interface page.\nThe Authorization Server prompts the End-User for consent before returning information to the Client\nThe Authorization Server prompts the End-User for reauthentication.\nThe Authorization Server prompts the End-User to select a user account.\nThis enables an End-User who has multiple accounts at the Authorization Server to select amongst\nthe multiple accounts that they might have current sessions for.","title":"PromptType","enum":["UNSPECIFIED","NONE","CONSENT","LOGIN","SELECT_ACCOUNT"],"default":"UNSPECIFIED","x-displayname":"Prompt Type","x-ves-proto-enum":"ves.io.schema.oidc_provider.PromptType"},"oidc_providerProviderType":{"type":"string","description":"Types of OIDC providers\n\nDefault provider. use this for standard OpenIDConnect v1.0\nAuthenticate with Google OIDC\nAuthenticate with Azure OIDC\nAuthenticate with Okta OIDC","title":"ProviderType","enum":["DEFAULT","GOOGLE","AZURE","OKTA"],"default":"DEFAULT","x-displayname":"Provider Type","x-ves-proto-enum":"ves.io.schema.oidc_provider.ProviderType"},"oidc_providerReplaceRequest":{"type":"object","description":"ReplaceRequest is the request format for replacing an oidc provider in IAM","title":"Replace Request","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.oidc_provider.ReplaceRequest","properties":{"name":{"type":"string","description":"Name of the oidc_provider object\n\nExample: `\"google\"`","title":"name","x-displayname":"Name","x-ves-example":"google"},"namespace":{"type":"string","description":"Supports only system namespace.\n\nExample: `\"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"},"spec":{"$ref":"#/components/schemas/schemaoidc_providerCustomCreateSpecType"}}},"oidc_providerReplaceResponse":{"type":"object","description":"ReplaceResponse is the response format for replacing an oidc provider in IAM.\nresponse body is empty.","title":"Replace Response","x-displayname":"Replace Response","x-ves-proto-message":"ves.io.schema.oidc_provider.ReplaceResponse","properties":{"err":{"$ref":"#/components/schemas/schemaoidc_providerErrorCode"}}},"oidc_providerScimSpecType":{"type":"object","title":"ScimSpecType","x-displayname":"Scim Specification","x-ves-proto-message":"ves.io.schema.oidc_provider.ScimSpecType","properties":{"scim_client_uri":{"type":"string","description":" SCIM Client URI","title":"SCIMClientUri","x-displayname":"SCIM Client URI"},"scim_enabled":{"type":"boolean","description":" If true, SCIM integration is enabled for the tenant.","title":"scim_enabled","format":"boolean","x-displayname":"SCIM enabled"}}},"oidc_providerUpdateOIDCMappersRequest":{"type":"object","description":"When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right\nattributes for user object. Use this mapper to map values from authentication token to user attributes.","title":"UpdateOIDCMappersRequest","x-displayname":"UpdateOIDCMappersRequest","x-ves-proto-message":"ves.io.schema.oidc_provider.UpdateOIDCMappersRequest","properties":{"name":{"type":"string","description":" Name contains name/alias of underlying OIDC provider.\n\nExample: ` \"[oidc, google, azure-oidc]\"`","title":"OIDC provider name","x-displayname":"OIDC provider name","x-ves-example":"[oidc, google, azure-oidc]"},"namespace":{"type":"string","description":" Namespace contains namespace of OIDC provider. Namespace should be system.\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"oidc_mappers":{"$ref":"#/components/schemas/oidc_providerOIDCMappers"}}},"oidc_providerUpdateScimIntegrationRequest":{"type":"object","description":"Request for updating the SCIM integration status for an OIDC provider.","title":"UpdateScimIntegrationRequest","x-displayname":"Update SCIM Integration Request","x-ves-proto-message":"ves.io.schema.oidc_provider.UpdateScimIntegrationRequest","properties":{"name":{"type":"string","description":" Name of OIDC provider object\n\nExample: ` \"value\"`","title":"name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" Supports only system namespace.\n\nExample: ` \"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"},"scim_enabled":{"type":"boolean","description":" Update the SCIM integration, either enables/disables for the oidc provider on the basis of the provided value.","title":"scim_enabled","format":"boolean","x-displayname":"SCIM enabled"},"scim_token_meta":{"$ref":"#/components/schemas/api_credentialRecreateScimTokenRequest"}}},"oidc_providerUpdateScimIntegrationResponse":{"type":"object","description":"Response for the SCIM enablement request for an OIDC provider","title":"UpdateScimIntegrationResponse","x-displayname":"Update Scim Integration Response","x-ves-proto-message":"ves.io.schema.oidc_provider.UpdateScimIntegrationResponse","properties":{"error":{"$ref":"#/components/schemas/schemaErrorType"},"scim_enabled":{"type":"boolean","description":" This is for representing the status of scim integration\n\nExample: ` true`","title":"scim_enabled","format":"boolean","x-displayname":"SCIM Enabled"},"scim_token":{"$ref":"#/components/schemas/schemaapi_credentialCreateResponse"},"url":{"type":"string","description":" This is the root URL that needs to be used in the external identity providers SCIM client which will be used for all API requests.\n As an example, if root URL is https://customer.domain/api/scim/namespaces/system/v2/ actual API request client will need make for user resource is via endpoint https://customer.domain/api/scim/namespaces/system/v2/Users\n\nExample: ` \"https://customer.domain/api/scim/namespaces/system/v2/\"`","title":"url","x-displayname":"URL","x-ves-example":"https://customer.domain/api/scim/namespaces/system/v2/"}}},"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"}}},"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/ioschemaErrorCode"},"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"}}},"schemaObjectMetaType":{"type":"object","description":"ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.\nThe information in this type can be specified by user during create and replace APIs.","title":"ObjectMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.ObjectMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. Object create will fail if\n provided by the client and the value exists in the system. Typically generated by the\n server on successful creation of an object and is not allowed to change once populated.\n Shadowed by SystemObjectMeta's uid field.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectMetaType":{"type":"object","description":"SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"value"},"creator_cookie":{"type":"string","description":" This can used by the creator of the object for later audit for e.g. by storing the\n version identifying information of the object so at future it can be determined if\n version present at remote end is current or stale.\n\nExample: ` \"value\"`","title":"creator_cookie","x-displayname":"Creator Cookie","x-ves-example":"value"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"value"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"direct_ref_hash":{"type":"string","description":" A hash of the UIDs of  direct references on this object. This can be used to determine if \n this object hash has had references become resolved/unresolved","title":"direct_ref_hash","x-displayname":"Direct Reference Hash"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"namespace":{"type":"array","description":" The namespace this object belongs to. This is populated by the service based on the\n metadata.namespace field when an object is created.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"namespace","maxItems":1,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Namespace Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"revision":{"type":"string","description":" A revision number which always increases with each modification of the object in storage\n This doesn't necessarily increase sequentially, but should always increase.\n This will be 0 when first created, and before any modifications.","title":"revision","format":"int64","x-displayname":"Revision"},"sre_disable":{"type":"boolean","description":" This should be set to true If VES/SRE operator wants to suppress an object from being\n presented to business-logic of a daemon(e.g. due to bad-form/issue-causing Object).\n This is meant only to be used in temporary situations for operational continuity till\n a fix is rolled out in business-logic.\n\nExample: ` \"true\"`","title":"sre_disable","format":"boolean","x-displayname":"SRE Disable","x-ves-example":"true"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"trace_info":{"type":"string","description":" trace_info holds information(<trace-id>:<span-id>:<parent-span-id>) of the request doing\n the object modification. This can be used on the watch side to create subsequent spans.\n This information can be used to co-relate activities across services (modulo state compression)\n for a synchronous API.\n\nExample: ` \"value\"`","title":"trace_info","x-displayname":"Trace Info","x-ves-example":"value"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Indicate origin of this object.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaapi_credentialCreateResponse":{"type":"object","description":"CreateResponse is the response format for the credential's create request.","title":"Create response","x-displayname":"Create Response","x-ves-displayorder":"1","x-ves-proto-message":"ves.io.schema.api_credential.CreateResponse","properties":{"active":{"type":"boolean","format":"boolean"},"data":{"type":"string","description":" data is the response format based on the API credential type.\n In case of API_CERTIFICATES, the response is the base64 encoded value of \n certificate in PKCS12 format.\n In case of KUBE_CONFIG, the response is the base64 encoded value of the K8s kubeconfig file\n with contents as requested - cluster,namespace and base64 encoded certificate, key and CA.\n\nExample: ` \"value\"`","title":"Credentials","x-displayname":"Credentials","x-ves-example":"value"},"expiration_timestamp":{"type":"string","format":"date-time"},"name":{"type":"string"}}},"schemaoidc_providerCreateRequest":{"type":"object","description":"Create request shape for creating an OIDC provider in IAM.","title":"Create Request","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.oidc_provider.CreateRequest","properties":{"namespace":{"type":"string","description":"Supports only system namespace.\n\nExample: `\"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"},"spec":{"$ref":"#/components/schemas/schemaoidc_providerCustomCreateSpecType"}}},"schemaoidc_providerCreateResponse":{"type":"object","description":"Create response is the response format for the response of request to create an OIDC provider in IAM.","title":"Create Response","x-displayname":"Create Response","x-ves-proto-message":"ves.io.schema.oidc_provider.CreateResponse","properties":{"err":{"$ref":"#/components/schemas/schemaoidc_providerErrorCode"},"post_logout_redirect_uri":{"type":"string","description":" x-displayName : \"Logout Redirect URI\"\n After successful logout, OIDC application may require redirect URI to be white-listed. configure this URI in your\n OIDC app so user logout is correctly sent back our identity which will then redirect back to console app's redirect.","title":"Post logout redirect URI"},"redirect_uri":{"type":"string","description":" Upon successful creation of OIDC provider object, User needs to whitelist/allow value of this redirect\n URI in their OIDC application's allowed redirect URLs.\n This is required as part of the OIDC authentication process, F5XC identity will be brokering the\n request for authentication and will be sending authentication request with url set in the redirect_uri.\n Post successful authentication of client browser and your identity provider, identity provider sends response\n back to volterra identity as per this redirect URI. So its a must that user has updated their OIDC application\n with this redirect URL as valid for authentication to go through.\n\nExample: ` \"value\"`","title":"redirect uri","x-displayname":"Redirect URI","x-ves-example":"value"}}},"schemaoidc_providerCustomCreateSpecType":{"type":"object","description":"CustomCreateSpecType is the spec to create oidc provider","title":"Custom Create Spec","x-displayname":"Create OIDC Provider","x-ves-oneof-field-oidcproviderspec":"[\"azure_oidc_spec_type\",\"google_oidc_spec_type\",\"oidc_v10_spec_type\",\"okta_oidc_spec_type\"]","x-ves-proto-message":"ves.io.schema.oidc_provider.CustomCreateSpecType","properties":{"azure_oidc_spec_type":{"$ref":"#/components/schemas/oidc_providerAzureOIDCSpecType"},"google_oidc_spec_type":{"$ref":"#/components/schemas/oidc_providerGoogleOIDCSpecType"},"oidc_v10_spec_type":{"$ref":"#/components/schemas/oidc_providerOIDCV10SpecType"},"okta_oidc_spec_type":{"$ref":"#/components/schemas/oidc_providerOKTAOIDCSpecType"},"provider_type":{"$ref":"#/components/schemas/oidc_providerProviderType"}}},"schemaoidc_providerDeleteRequest":{"type":"object","description":"DeleteRequest is the request payload for deleting an OIDC provider/SSO configuration.","title":"Delete Request","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.oidc_provider.DeleteRequest","properties":{"name":{"type":"string","description":" Name of OIDC provider object.\n\nExample: ` \"value\"`","title":"name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" Supports only system namespace.\n\nExample: ` \"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"}}},"schemaoidc_providerErrorCode":{"type":"string","description":"ErrorCode is used to know the outcome of the specific CRUD operation for OIDC provider","title":"error code","enum":["EUNKNOWN","EOK","EEXISTS","EFAILED","ENOTFOUND"],"default":"EUNKNOWN","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.oidc_provider.ErrorCode"},"schemaoidc_providerGetResponse":{"type":"object","description":"GetResponse is the response format for fetching oidc provider information","title":"Get Response","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.oidc_provider.GetResponse","properties":{"object":{"$ref":"#/components/schemas/schemaoidc_providerObject"}}},"schemaoidc_providerGlobalSpecType":{"type":"object","description":"GlobalSpecType has specification field and values about the oidc provider","title":"Global Spec Type","x-displayname":"Global Specification Type","x-ves-oneof-field-oidcproviderspec":"[\"azure_oidc_spec_type\",\"google_oidc_spec_type\",\"oidc_v10_spec_type\",\"okta_oidc_spec_type\"]","x-ves-proto-message":"ves.io.schema.oidc_provider.GlobalSpecType","properties":{"azure_oidc_spec_type":{"$ref":"#/components/schemas/oidc_providerAzureOIDCSpecType"},"google_oidc_spec_type":{"$ref":"#/components/schemas/oidc_providerGoogleOIDCSpecType"},"oidc_v10_spec_type":{"$ref":"#/components/schemas/oidc_providerOIDCV10SpecType"},"okta_oidc_spec_type":{"$ref":"#/components/schemas/oidc_providerOKTAOIDCSpecType"},"provider_type":{"$ref":"#/components/schemas/oidc_providerProviderType"},"redirect_uri":{"type":"string","description":" Redirect URI","title":"RedirectUri","x-displayname":"Redirect URI"},"scim_spec":{"$ref":"#/components/schemas/oidc_providerScimSpecType"}}},"schemaoidc_providerListResponse":{"type":"object","description":"Format of the response body to list OIDC providers configured for the tenant under a namespace.","title":"ListResponse","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.oidc_provider.ListResponse","properties":{"items":{"type":"array","description":" List of OIDC providers.","title":"items","items":{"$ref":"#/components/schemas/schemaoidc_providerListResponseItem"},"x-displayname":"Items"}}},"schemaoidc_providerListResponseItem":{"type":"object","description":"Shape of the OIDC provider object in a list request's response body.","title":"List response item","x-displayname":"List Response Item","x-ves-proto-message":"ves.io.schema.oidc_provider.ListResponseItem","properties":{"create_timestamp":{"type":"string","description":" Create timestamp of the OIDC provider object.","title":"create timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"name":{"type":"string","description":" Name of OIDC provider.\n\nExample: ` \"value\"`","title":"name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" Namespace of OIDC provider object.\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"provider_type":{"$ref":"#/components/schemas/oidc_providerProviderType"},"uid":{"type":"string","description":" UID of OIDC provider object.\n\nExample: ` \"value\"`","title":"uid","x-displayname":"UID","x-ves-example":"value"}}},"schemaoidc_providerObject":{"type":"object","description":"OIDC Provider object","title":"OIDC provider","x-displayname":"OIDC Provider","x-ves-proto-message":"ves.io.schema.oidc_provider.Object","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectMetaType"},"spec":{"$ref":"#/components/schemas/schemaoidc_providerSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectMetaType"}}},"schemaoidc_providerSpecType":{"type":"object","description":"Shape of the oidc provider specification","title":"Specification for OIDC provider","x-displayname":"Specification","x-ves-proto-message":"ves.io.schema.oidc_provider.SpecType","properties":{"gc_spec":{"$ref":"#/components/schemas/schemaoidc_providerGlobalSpecType"}}}}}}