{"openapi":"3.0.1","info":{"title":"API7 Enterprise Developer Portal APIs","description":"API7 Enterprise Developer Portal APIs are RESTful APIs that allow you to create and manage developer portal resources. ","version":"3.8.24"},"servers":[],"security":[],"paths":{"/api/api_products":{"get":{"tags":["Provider Portal - API Product"],"summary":"List all API products for Developer Portal","operationId":"listAPIProducts-DeveloperPortal","parameters":[{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Order to list the resources by. The sorting index follows the configuration of `order_by`.","in":"query"},{"name":"order_by","in":"query","description":"Index to order resources by.","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at"],"description":"Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`."}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Condition to search resources by.","example":"version%3Dv2"},{"name":"subscription_status","in":"query","schema":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}},{"name":"application_id","in":"query","required":false,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"An array of APIProduct.","items":{"allOf":[{"description":"The API product fields.","allOf":[{"oneOf":[{"title":"Gateway API Product","type":"object","allOf":[{"type":"object","required":["type","name","linked_gateway_services"],"properties":{"type":{"type":"string","enum":["gateway"],"default":"gateway"},"name":{"example":"Weather Insights API","description":"The object name.","type":"string","minLength":1,"maxLength":100},"logo":{"type":"string","description":"The base64-encoded logo image of the API product."},"desc":{"type":"string","description":"The description of the API product.","example":"The Weather Insights API provides real-time and historical weather data for any location worldwide."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}},"auth":{"type":"object","description":"The authentication configuration of the API product.","additionalProperties":false,"minProperties":1,"example":{"key-auth":{"header":"apikey","hide_credentials":false,"query":"apikey"}},"properties":{"key-auth":{"type":"object","additionalProperties":false,"description":"Key authentication configurations.","properties":{"hide_credentials":{"type":"boolean","default":false,"description":"If true, do not pass the header or query string with key to upstream services."},"query":{"type":"string","default":"apikey","description":"The query string to get the key from. Lower priority than header."},"header":{"type":"string","default":"apikey","description":"The header to get the key from."}}},"basic-auth":{"type":"object","additionalProperties":false,"description":"Basic authentication configurations.","properties":{"hide_credentials":{"type":"boolean","default":false,"description":"If true, do not pass the header or query string with key to upstream services."}}},"dcr":{"type":"object","additionalProperties":false,"description":"DCR authentication configurations.","required":["dcr_provider_id"],"properties":{"dcr_provider_id":{"description":"ID of the DCR provider.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}}}},"linked_gateway_services":{"type":"array","description":"An array of gateway groups and services that the API product is linked to.","minItems":1,"items":{"type":"object","properties":{"gateway_group_id":{"description":"The gateway group ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bc1b95c9-b348-4832-acc3-e257d2342df1"},"service_id":{"description":"The service template ID of the published service.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"b32e678e-7f6b-4a50-b113-550621ed4c01"},"linked_hosts":{"type":"array","description":"Select one or more hosts configured for the gateway service to be published to the API portal. If not set, it means using all hosts of the gateway service.","uniqueItems":true,"minItems":1,"maxItems":32,"items":{"type":"string","description":"The HTTP host.","pattern":"^\\*?[0-9a-zA-Z-._]+$","example":"httpbin.org"}}}}},"status":{"type":"string","description":"Status of the API product.","enum":["draft","published"],"default":"draft"},"subscription_auto_approval":{"type":"boolean","default":false,"description":"If true, the subscription is automatically approved."},"can_view_unsubscribed":{"type":"boolean","description":"If true, developers can view the unsubscribed API.","default":true},"visibility":{"type":"string","enum":["public","logged_in"],"default":"public","description":"The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers."}}},{"type":"object","properties":{"linked_gateway_services":{"type":"array","description":"An array of gateway groups and services that the API product is linked to.","items":{"type":"object","description":"The gateway group and service that the API product is linked to.","properties":{"gateway_group_id":{"description":"The gateway group ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bc1b95c9-b348-4832-acc3-e257d2342df1"},"gateway_group_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"service_id":{"description":"The service ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"b32e678e-7f6b-4a50-b113-550621ed4c01"},"name":{"description":"The service name.","example":"Weather Insights API","type":"string","minLength":1,"maxLength":100},"version":{"type":"string","description":"The version of the published service.","example":"1.3.2"},"status":{"description":"The object status. 1 means the object is active while 0 means it's inactive.\n","type":"integer","enum":[0,1]},"hosts":{"type":"array","items":{"example":"weatherinsights.com","type":"string","description":"The HTTP host.","pattern":"^\\*?[0-9a-zA-Z-._]+$"}},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0,"example":1742288230},"openapi_title":{"type":"string","description":"The title of the OpenAPI file.","example":"Weather Insights API - OpenAPI 3.0"}}}}}}]},{"title":"External API Product","type":"object","allOf":[{"type":"object","required":["name","type","raw_openapi"],"anyOf":[{"required":["server_url"]},{"required":["server_urls"]}],"properties":{"type":{"type":"string","description":"Type of API product.","enum":["external"],"default":"external"},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"raw_openapi":{"type":"string","minLength":1,"description":"The content of the OpenAPI YAML file.","example":"Raw OpenAPI spec"},"server_url":{"deprecated":true,"type":"string","minLength":1,"maxLength":4096,"description":"The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.","example":"http://localhost:8080"},"server_urls":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"maxLength":4096},"description":"The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.","example":["http://localhost:8080","http://localhost:8081"]},"status":{"type":"string","description":"Status of the API product.","enum":["draft","published"],"default":"draft"},"visibility":{"type":"string","enum":["public","logged_in"],"default":"public","description":"The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers."}}},{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"desc":{"type":"string","description":"Description."},"api_desc":{"type":"string","description":"API description."},"api_count":{"type":"number","format":"int64","description":"API count.","example":10}}}]}]},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]},{"type":"object","properties":{"subscription_status":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}}]}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/api_products/{api_product_id}":{"get":{"tags":["Provider Portal - API Product"],"summary":"Get an API Product for Developer Portal","operationId":"getAPIProduct-DeveloperPortal","parameters":[{"name":"api_product_id","description":"The unique identifier of the API product.","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"allOf":[{"description":"The API product fields.","allOf":[{"oneOf":[{"title":"Gateway API Product","type":"object","allOf":[{"type":"object","required":["type","name","linked_gateway_services"],"properties":{"type":{"type":"string","enum":["gateway"],"default":"gateway"},"name":{"example":"Weather Insights API","description":"The object name.","type":"string","minLength":1,"maxLength":100},"logo":{"type":"string","description":"The base64-encoded logo image of the API product."},"desc":{"type":"string","description":"The description of the API product.","example":"The Weather Insights API provides real-time and historical weather data for any location worldwide."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}},"auth":{"type":"object","description":"The authentication configuration of the API product.","additionalProperties":false,"minProperties":1,"example":{"key-auth":{"header":"apikey","hide_credentials":false,"query":"apikey"}},"properties":{"key-auth":{"type":"object","additionalProperties":false,"description":"Key authentication configurations.","properties":{"hide_credentials":{"type":"boolean","default":false,"description":"If true, do not pass the header or query string with key to upstream services."},"query":{"type":"string","default":"apikey","description":"The query string to get the key from. Lower priority than header."},"header":{"type":"string","default":"apikey","description":"The header to get the key from."}}},"basic-auth":{"type":"object","additionalProperties":false,"description":"Basic authentication configurations.","properties":{"hide_credentials":{"type":"boolean","default":false,"description":"If true, do not pass the header or query string with key to upstream services."}}},"dcr":{"type":"object","additionalProperties":false,"description":"DCR authentication configurations.","required":["dcr_provider_id"],"properties":{"dcr_provider_id":{"description":"ID of the DCR provider.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}}}},"linked_gateway_services":{"type":"array","description":"An array of gateway groups and services that the API product is linked to.","minItems":1,"items":{"type":"object","properties":{"gateway_group_id":{"description":"The gateway group ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bc1b95c9-b348-4832-acc3-e257d2342df1"},"service_id":{"description":"The service template ID of the published service.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"b32e678e-7f6b-4a50-b113-550621ed4c01"},"linked_hosts":{"type":"array","description":"Select one or more hosts configured for the gateway service to be published to the API portal. If not set, it means using all hosts of the gateway service.","uniqueItems":true,"minItems":1,"maxItems":32,"items":{"type":"string","description":"The HTTP host.","pattern":"^\\*?[0-9a-zA-Z-._]+$","example":"httpbin.org"}}}}},"status":{"type":"string","description":"Status of the API product.","enum":["draft","published"],"default":"draft"},"subscription_auto_approval":{"type":"boolean","default":false,"description":"If true, the subscription is automatically approved."},"can_view_unsubscribed":{"type":"boolean","description":"If true, developers can view the unsubscribed API.","default":true},"visibility":{"type":"string","enum":["public","logged_in"],"default":"public","description":"The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers."}}},{"type":"object","properties":{"linked_gateway_services":{"type":"array","description":"An array of gateway groups and services that the API product is linked to.","items":{"type":"object","description":"The gateway group and service that the API product is linked to.","properties":{"gateway_group_id":{"description":"The gateway group ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bc1b95c9-b348-4832-acc3-e257d2342df1"},"gateway_group_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"service_id":{"description":"The service ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"b32e678e-7f6b-4a50-b113-550621ed4c01"},"name":{"description":"The service name.","example":"Weather Insights API","type":"string","minLength":1,"maxLength":100},"version":{"type":"string","description":"The version of the published service.","example":"1.3.2"},"status":{"description":"The object status. 1 means the object is active while 0 means it's inactive.\n","type":"integer","enum":[0,1]},"hosts":{"type":"array","items":{"example":"weatherinsights.com","type":"string","description":"The HTTP host.","pattern":"^\\*?[0-9a-zA-Z-._]+$"}},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0,"example":1742288230},"openapi_title":{"type":"string","description":"The title of the OpenAPI file.","example":"Weather Insights API - OpenAPI 3.0"}}}}}}]},{"title":"External API Product","type":"object","allOf":[{"type":"object","required":["name","type","raw_openapi"],"anyOf":[{"required":["server_url"]},{"required":["server_urls"]}],"properties":{"type":{"type":"string","description":"Type of API product.","enum":["external"],"default":"external"},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"raw_openapi":{"type":"string","minLength":1,"description":"The content of the OpenAPI YAML file.","example":"Raw OpenAPI spec"},"server_url":{"deprecated":true,"type":"string","minLength":1,"maxLength":4096,"description":"The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.","example":"http://localhost:8080"},"server_urls":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"maxLength":4096},"description":"The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.","example":["http://localhost:8080","http://localhost:8081"]},"status":{"type":"string","description":"Status of the API product.","enum":["draft","published"],"default":"draft"},"visibility":{"type":"string","enum":["public","logged_in"],"default":"public","description":"The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers."}}},{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"desc":{"type":"string","description":"Description."},"api_desc":{"type":"string","description":"API description."},"api_count":{"type":"number","format":"int64","description":"API count.","example":10}}}]}]},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]},{"type":"object","properties":{"subscription_status":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/api_products/{api_product_id}/oas":{"get":{"tags":["Provider Portal - API Product"],"summary":"Get the OpenAPI Specification of a published service on a gateway group","operationId":"getPublishedServiceOASByServiceTemplateID","description":"Get API Product Linked Gateway Service OAS","parameters":[{"name":"api_product_id","description":"The unique identifier of the API product.","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"service_id","description":"The unique identifier of the service template.","in":"query","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"type":"object","properties":{"raw_openapi":{"type":"string","description":"The raw OpenAPI spec of the service.","example":"Raw OpenAPI spec"},"api_count":{"type":"integer","description":"The number of APIs in the service.","example":10},"api_desc":{"type":"string","description":"The description of the OAS.","example":"OAS description."}}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/api_products/{api_product_id}/subscriptions":{"post":{"tags":["API Product Subscription"],"summary":"Create a subscription for an API Product.","operationId":"createAPIProductSubscription","parameters":[{"name":"api_product_id","description":"The unique identifier of the API product.","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"The request body for creating a subscription.","type":"object","properties":{"application_id":{"description":"Application ID.","example":"default"}},"required":["application_id"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/subscriptions":{"get":{"tags":["API Product Subscription"],"summary":"List subscriptions for the API Product.","operationId":"listSubscriptionsForAPIProduct","parameters":[{"name":"api_product_id","description":"the api product id.","in":"query","required":false,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"application_id","in":"query","required":false,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"status","in":"query","schema":{"type":"array","items":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Condition to search resources by.","example":"version%3Dv2"},{"name":"order_by","in":"query","schema":{"type":"string","default":"subscribed_at","enum":["developer_name","subscribed_at"]}},{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Order to list the resources by. The sorting index follows the configuration of `order_by`.","in":"query"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"An array of DeveloperCredential.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subscription."},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"developer_id":{"type":"string"},"developer_name":{"type":"string"},"subscribed_at":{"description":"The object timestamp.","type":"integer","minimum":0,"example":1742288230},"application_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"application_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"api_product_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"api_product_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"status":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}},"post":{"tags":["API Product Subscription"],"summary":"Create a subscription for an API Product","operationId":"createSubscription","requestBody":{"content":{"application/json":{"schema":{"description":"The request body for creating subscriptions.","type":"object","properties":{"applications":{"type":"array","minItems":1,"items":{"description":"The applications ids","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},"api_products":{"type":"array","minItems":1,"items":{"description":"The api products ids","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},"required":["applications","api_products"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/subscriptions/{subscription_id}":{"delete":{"tags":["API Product Subscription"],"summary":"Unsubscribe an API product for the given application","operationId":"deleteApplicationSubscription","parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/login":{"post":{"tags":["User"],"summary":"Log in to Developer Portal","operationId":"userLogin","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["username","password"],"properties":{"username":{"description":"The username of the user.","type":"string","minLength":1,"maxLength":128,"example":"john"},"password":{"type":"string","description":"The password of the user.","minLength":1,"maxLength":128,"example":"safe-password"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/logout":{"post":{"tags":["User"],"summary":"Logout from Developer Portal","operationId":"userLogout","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/sign_up":{"post":{"tags":["User"],"summary":"Sign up to Developer Portal user","operationId":"userSignUp","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["username","password"],"properties":{"username":{"description":"The username of the user.","type":"string","minLength":1,"maxLength":128,"example":"john"},"password":{"type":"string","description":"The password of the user.","minLength":1,"maxLength":128,"example":"safe-password"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/password":{"put":{"tags":["User"],"summary":"Update my user password","operationId":"updateUserPassword","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["new_password"],"properties":{"old_password":{"type":"string","minLength":1,"maxLength":128,"example":"old-password"},"new_password":{"type":"string","minLength":1,"maxLength":128,"example":"new-password"}}}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string","example":""}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/me":{"get":{"tags":["User"],"summary":"Get my user detail","operationId":"getUserMe","responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The user.","allOf":[{"type":"object","properties":{"username":{"type":"string","description":"Unique developer username.","example":"dev1"},"name":{"type":"string","description":"Developer name.","example":"dev one"},"last_active_at":{"type":"integer","description":"Developer last active timestamp.","example":1742288233},"email":{"type":"string","description":"Developer email address.","example":"developer-test@email.com"},"email_verified":{"type":"boolean","description":"If true, the developer's email is verified."}}},{"type":"object","properties":{"id":{"description":"Developer ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235},"state":{"type":"string","description":"The state of the member.\n- Pending: The user is pending approval.\n- Active: The user had been approved.","enum":["Pending","Active"]}}}]}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}},"put":{"tags":["User"],"summary":"Update my user profile","operationId":"updateUserMe","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200}}}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string","example":""}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/me/email":{"put":{"tags":["User"],"summary":"Update the user email","operationId":"putUserEmail","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","minLength":1,"maxLength":128}}}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string","example":""}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}},"delete":{"tags":["User"],"summary":"Delete the user email","operationId":"deleteUserEmail","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string","example":""}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/email_verified":{"get":{"tags":["Email"],"summary":"Check if an email is verified","operationId":"checkEmailVerified","parameters":[{"name":"email","in":"query","required":true,"description":"Email address.","schema":{"type":"string","format":"email","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"type":"object","properties":{"verified":{"type":"boolean"}}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/verify_email":{"get":{"tags":["Email"],"summary":"Get email verification","operationId":"getEmailVerification","parameters":[{"name":"token","description":"The token of the request.","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024}}],"responses":{"302":{"description":"Redirect to IdP.","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/allow_access":{"post":{"tags":["Role","User"],"summary":"Check if a user has permissions on specific resources","operationId":"checkAllowAccess","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"title":"properties","type":"object","properties":{"resource":{"type":"string","description":"An ARN-style identifier that specifies one or multiple resources."},"action":{"type":"string","description":"A specific permission that defines what operation can be performed on the resource."},"context":{"type":"object","description":"Additional conditions or labels used to further narrow down which resources the action applies to, in combination with the resource definition.","anyOf":[{"title":"Context for Gateway Group","type":"object","properties":{"gateway_group_label":{"description":"Gateway group label.","type":"object","additionalProperties":{"type":"string"}}},"example":{"gateway_group_label":{"env":"prod"}}},{"title":"Context for Service","type":"object","properties":{"service_label":{"description":"Service label.","type":"object","additionalProperties":{"type":"string"}}},"example":{"service_label":{"version":"v1"}}},{"title":"Context for Published Service","type":"object","properties":{"gateway_group_label":{"description":"Gateway group label.","type":"object","additionalProperties":{"type":"string"}},"service_label":{"description":"Service label.","type":"object","additionalProperties":{"type":"string"}}},"example":{"gateway_group_label":{"env":"prod"},"service_label":{"version":"v2"}}},{"title":"Context for Role","type":"object","properties":{"role_label":{"description":"Role label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for Permission Policy","type":"object","properties":{"permission_policy_label":{"description":"Permission policy label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for User","type":"object","properties":{"user_label":{"description":"User label.","type":"object","additionalProperties":{"type":"string"}},"permission_boundaries":{"description":"A list of permission boundaries.","type":"array","items":{"type":"string"}}}},{"title":"Context for Consumer","type":"object","properties":{"gateway_group_label":{"description":"Gateway group label.","type":"object","additionalProperties":{"type":"string"}},"consumer_label":{"description":"Consumer label.","type":"object","additionalProperties":{"type":"string"}}},"example":{"gateway_group_label":{"env":"prod"},"consumer_label":{"team":"frontend"}}},{"title":"Context for Secret","type":"object","properties":{"gateway_group_label":{"description":"Gateway group label.","type":"object","additionalProperties":{"type":"string"}},"secret_provider_label":{"description":"Secret provider label.","type":"object","additionalProperties":{"type":"string"}}},"example":{"gateway_group_label":{"env":"prod"},"secret_provider_label":{"provider":"aws"}}},{"title":"Context for Contact Point","type":"object","properties":{"contact_point_label":{"description":"Contact point label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for Alert Policy","type":"object","properties":{"alert_policy_label":{"description":"Alert policy label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for Developer","type":"object","properties":{"developer_label":{"description":"Developer label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for API Product","type":"object","properties":{"api_product_label":{"description":"API product label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for CA Certificate","type":"object","properties":{"ca_certificate_label":{"description":"CA certificate label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for Certificate","type":"object","properties":{"certificate_label":{"description":"Certificate label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for SNI","type":"object","properties":{"sni_label":{"description":"SNI label.","type":"object","additionalProperties":{"type":"string"}}}},{"title":"Context for Portal","type":"object","properties":{"portal_label":{"description":"Portal label.","type":"object","additionalProperties":{"type":"string"}}}}]}},"required":["resource","action"]},"example":{"hasAccess":{"resource":"arn:api7:iam:role/767ff422-614b-4c0c-a4ea-287c26c773ba","action":"iam:UpdateCustomRole","context":{"role_label":{"platform":"external"}}}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"boolean"}}}}]},"example":{"value":{"hasAccess":true}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/applications":{"post":{"tags":["Application"],"summary":"Create a application by the logged in developer.","operationId":"createDeveloperApplication","requestBody":{"content":{"application/json":{"schema":{"description":"Create an application request.","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The developer application with management fields.","allOf":[{"type":"object","properties":{"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"description":"The developer application basic fields.","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}},"get":{"tags":["Application"],"summary":"List all applications for the logged in developer.","operationId":"listDeveloperApplications","parameters":[{"name":"api_product_id","description":"the api product id.","in":"query","required":false,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Condition to search resources by.","example":"version%3Dv2"},{"name":"labels","in":"query","required":false,"description":"Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.","schema":{"type":"string","minLength":1,"example":"labels%5Bversion%5D=v2"}},{"name":"order_by","in":"query","description":"Index to order resources by.","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at"],"description":"Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`."}},{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Order to list the resources by. The sorting index follows the configuration of `order_by`.","in":"query"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"The array of developer application","items":{"description":"The developer application list with subscription fields.","allOf":[{"type":"object","properties":{"subscription_status":{"description":"Indicates the subscription status of the application for a specific api_product. \nIt is only returned when it is necessary to check the subscription status of applications for a specific api_product.\n","type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}},{"description":"The developer application with management fields.","allOf":[{"type":"object","properties":{"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"description":"The developer application basic fields.","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}]}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/applications/{application_id}":{"get":{"tags":["Application"],"summary":"Get a application for the logged in developer.","operationId":"getDeveloperApplication","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The developer application with management fields.","allOf":[{"type":"object","properties":{"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"description":"The developer application basic fields.","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}},"put":{"tags":["Application"],"summary":"Update a application basic information by the logged in developer.","operationId":"updateDeveloperApplication","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Create an application request.","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The developer application with management fields.","allOf":[{"type":"object","properties":{"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"description":"The developer application basic fields.","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}},"delete":{"tags":["Application"],"summary":"Delete a application by the logged in developer.","operationId":"deleteDeveloperApplication","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/applications/{application_id}/credentials":{"post":{"tags":["Credential"],"summary":"Create a developer credential","operationId":"createDeveloperCredential","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Create an application credential request.","type":"object","allOf":[{"type":"object","properties":{"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"oneOf":[{"title":"Key Auth","required":["name","plugins"],"properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["key-auth"],"properties":{"key-auth":{"type":"object","nullable":true,"additionalProperties":false}}}}},{"title":"Basic Auth","required":["name","plugins"],"properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["basic-auth"],"properties":{"basic-auth":{"type":"object","additionalProperties":false,"required":["username","password"],"properties":{"username":{"type":"string","description":"Username."},"password":{"type":"string","description":"User password."}}}}}}},{"title":"OAuth","required":["oauth"],"properties":{"oauth":{"type":"object","required":["dcr_provider_id"],"properties":{"dcr_provider_id":{"type":"string","description":"The DCR provider ID."},"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","allOf":[{"type":"object","properties":{"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"developer_id":{"description":"Developer ID.","example":"7e4d29f5-a4bc-4e0d-9c02-5a0d8e1c3427","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"Application ID.","example":"default","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"oneOf":[{"title":"Key Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["key-auth"],"properties":{"key-auth":{"type":"object"}}}}},{"title":"Basic Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["basic-auth"],"properties":{"basic-auth":{"type":"object"}}}}},{"title":"OAuth","properties":{"oauth":{"type":"object","properties":{"dcr_provider_id":{"type":"string","description":"The DCR provider ID."},"dcr_provider":{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"name":{"type":"string","description":"The name of the Dynamic Client Registration (DCR) Provider."},"issuer":{"type":"string","description":"The issuer URL of the Authorization Server."}}},"client_id":{"type":"string","description":"The client ID."},"client_secret":{"type":"string","description":"The client secret is only returned upon creation."},"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}]},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}},"get":{"tags":["Credential"],"summary":"List all credentials for the logged in developer","operationId":"listDeveloperCredentials","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"auth_method","description":"the authentication method of the developer credential.","in":"query","required":false,"schema":{"type":"string","enum":["key-auth","basic-auth","oauth"]}},{"name":"plugin_name","description":"the plugin name of the developer credential, recommended to use `auth_method` instead.","in":"query","required":false,"deprecated":true,"schema":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"}},{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Order to list the resources by. The sorting index follows the configuration of `order_by`.","in":"query"},{"name":"order_by","in":"query","description":"Index to order credentials by.","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at","name"]}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Condition to search resources by.","example":"version%3Dv2"},{"name":"labels","in":"query","required":false,"description":"Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.","schema":{"type":"string","minLength":1,"example":"labels%5Bversion%5D=v2"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"An array of DeveloperCredential.","items":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","allOf":[{"type":"object","properties":{"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"developer_id":{"description":"Developer ID.","example":"7e4d29f5-a4bc-4e0d-9c02-5a0d8e1c3427","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"Application ID.","example":"default","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"oneOf":[{"title":"Key Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["key-auth"],"properties":{"key-auth":{"type":"object"}}}}},{"title":"Basic Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["basic-auth"],"properties":{"basic-auth":{"type":"object"}}}}},{"title":"OAuth","properties":{"oauth":{"type":"object","properties":{"dcr_provider_id":{"type":"string","description":"The DCR provider ID."},"dcr_provider":{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"name":{"type":"string","description":"The name of the Dynamic Client Registration (DCR) Provider."},"issuer":{"type":"string","description":"The issuer URL of the Authorization Server."}}},"client_id":{"type":"string","description":"The client ID."},"client_secret":{"type":"string","description":"The client secret is only returned upon creation."},"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}]},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/applications/{application_id}/credentials/{credential_id}":{"get":{"tags":["Credential"],"summary":"Get a developer credential for Developer Portal","operationId":"getDeveloperCredential","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"credential_id","description":"the unique identifier of the developer credential.","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","allOf":[{"type":"object","properties":{"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"developer_id":{"description":"Developer ID.","example":"7e4d29f5-a4bc-4e0d-9c02-5a0d8e1c3427","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"Application ID.","example":"default","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"oneOf":[{"title":"Key Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["key-auth"],"properties":{"key-auth":{"type":"object"}}}}},{"title":"Basic Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["basic-auth"],"properties":{"basic-auth":{"type":"object"}}}}},{"title":"OAuth","properties":{"oauth":{"type":"object","properties":{"dcr_provider_id":{"type":"string","description":"The DCR provider ID."},"dcr_provider":{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"name":{"type":"string","description":"The name of the Dynamic Client Registration (DCR) Provider."},"issuer":{"type":"string","description":"The issuer URL of the Authorization Server."}}},"client_id":{"type":"string","description":"The client ID."},"client_secret":{"type":"string","description":"The client secret is only returned upon creation."},"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}]},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}},"put":{"tags":["Credential"],"summary":"Update a developer credential for Developer Portal","operationId":"upsertDeveloperCredential","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"credential_id","description":"the unique identifier of the developer credential.","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Update an application credential request.","type":"object","oneOf":[{"title":"Key Auth Or Basic Auth","required":["name"],"additionalProperties":false,"properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"title":"OAuth","required":["oauth"],"additionalProperties":false,"properties":{"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}},"oauth":{"type":"object","additionalProperties":false,"properties":{"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","allOf":[{"type":"object","properties":{"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"developer_id":{"description":"Developer ID.","example":"7e4d29f5-a4bc-4e0d-9c02-5a0d8e1c3427","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"Application ID.","example":"default","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"oneOf":[{"title":"Key Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["key-auth"],"properties":{"key-auth":{"type":"object"}}}}},{"title":"Basic Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["basic-auth"],"properties":{"basic-auth":{"type":"object"}}}}},{"title":"OAuth","properties":{"oauth":{"type":"object","properties":{"dcr_provider_id":{"type":"string","description":"The DCR provider ID."},"dcr_provider":{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"name":{"type":"string","description":"The name of the Dynamic Client Registration (DCR) Provider."},"issuer":{"type":"string","description":"The issuer URL of the Authorization Server."}}},"client_id":{"type":"string","description":"The client ID."},"client_secret":{"type":"string","description":"The client secret is only returned upon creation."},"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}]},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}},"delete":{"tags":["Credential"],"summary":"Delete a developer credential for Developer Portal","operationId":"deleteDeveloperCredential","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"credential_id","description":"the unique identifier of the developer credential.","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/applications/{application_id}/credentials/{credential_id}/regenerate":{"put":{"tags":["Credential"],"summary":"Regenerate a developer credential auth conf","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}},{"name":"credential_id","description":"the unique identifier of the developer credential.","in":"path","required":true,"schema":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Regenerate an application credential request.","type":"object","maxProperties":1,"minProperties":1,"additionalProperties":false,"properties":{"key-auth":{"type":"object","nullable":true,"additionalProperties":false},"basic-auth":{"type":"object","additionalProperties":false,"required":["username","password"],"properties":{"username":{"type":"string","description":"Username."},"password":{"type":"string","description":"User password."}}}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","allOf":[{"type":"object","properties":{"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"developer_id":{"description":"Developer ID.","example":"7e4d29f5-a4bc-4e0d-9c02-5a0d8e1c3427","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"Application ID.","example":"default","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"oneOf":[{"title":"Key Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["key-auth"],"properties":{"key-auth":{"type":"object"}}}}},{"title":"Basic Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["basic-auth"],"properties":{"basic-auth":{"type":"object"}}}}},{"title":"OAuth","properties":{"oauth":{"type":"object","properties":{"dcr_provider_id":{"type":"string","description":"The DCR provider ID."},"dcr_provider":{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"name":{"type":"string","description":"The name of the Dynamic Client Registration (DCR) Provider."},"issuer":{"type":"string","description":"The issuer URL of the Authorization Server."}}},"client_id":{"type":"string","description":"The client ID."},"client_secret":{"type":"string","description":"The client secret is only returned upon creation."},"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}]},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/applications/api_calls":{"get":{"tags":["API Calls"],"summary":"Get API Calls","description":"Retrieve a list of API calls made by the user.","operationId":"getApiCalls","parameters":[{"name":"application_id","in":"query","required":false,"schema":{"type":"array","items":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"name":"api_product_id","description":"the api product ids.","in":"query","required":false,"schema":{"type":"array","items":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"name":"credential_id","in":"query","schema":{"type":"array","items":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"in":"query","name":"start_at","required":true,"schema":{"type":"integer"}},{"in":"query","required":true,"name":"end_at","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"An array of api calls.","items":{"type":"object","properties":{"api_product_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"api_product_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"hour_timestamp":{"description":"The object timestamp.","type":"integer","minimum":0,"example":1742288230},"api_calls":{"type":"integer"}}}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/credentials":{"get":{"tags":["Credential"],"summary":"Credentials by filters","operationId":"listCredentials","parameters":[{"name":"application_id","in":"query","required":false,"schema":{"type":"array","items":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}},{"name":"auth_method","description":"the authentication method of the developer credential.","in":"query","required":false,"schema":{"type":"string","enum":["key-auth","basic-auth","oauth"]}},{"name":"plugin_name","description":"the plugin name of the developer credential, recommended to use `auth_method` instead.","in":"query","required":false,"deprecated":true,"schema":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"}},{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Order to list the resources by. The sorting index follows the configuration of `order_by`.","in":"query"},{"name":"order_by","in":"query","description":"Index to order credentials by.","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at","name"]}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Condition to search resources by.","example":"version%3Dv2"},{"name":"labels","in":"query","required":false,"description":"Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.","schema":{"type":"string","minLength":1,"example":"labels%5Bversion%5D=v2"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"An array of DeveloperCredential.","items":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","allOf":[{"type":"object","properties":{"portal_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"developer_id":{"description":"Developer ID.","example":"7e4d29f5-a4bc-4e0d-9c02-5a0d8e1c3427","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"Application ID.","example":"default","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"desc":{"description":"The object description.","type":"string","maxLength":65536,"example":"Object description."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"description":"Key-value pairs of labels.","example":{"version":"v2","env":"prod"}}}},{"oneOf":[{"title":"Key Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["key-auth"],"properties":{"key-auth":{"type":"object"}}}}},{"title":"Basic Auth","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100,"example":"us-west-rsc"},"plugins":{"type":"object","additionalProperties":false,"required":["basic-auth"],"properties":{"basic-auth":{"type":"object"}}}}},{"title":"OAuth","properties":{"oauth":{"type":"object","properties":{"dcr_provider_id":{"type":"string","description":"The DCR provider ID."},"dcr_provider":{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"name":{"type":"string","description":"The name of the Dynamic Client Registration (DCR) Provider."},"issuer":{"type":"string","description":"The issuer URL of the Authorization Server."}}},"client_id":{"type":"string","description":"The client ID."},"client_secret":{"type":"string","description":"The client secret is only returned upon creation."},"redirect_uris":{"type":"array","description":"The redirect URIs.","items":{"type":"string","minLength":1}}}}}}]}]},{"type":"object","properties":{"id":{"description":"The policy ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235}}}]}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}},"default":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/labels/{resource_type}":{"get":{"tags":["Label"],"summary":"Get all labels of a resource type","operationId":"listLabels","parameters":[{"name":"resource_type","in":"path","required":true,"schema":{"type":"string","enum":["developer_credential","developer_application","api_product"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"k8s/namespace":["api7-ingress-system","default","api7"],"manager-by":["api7-ingress-controller","apisix-ingress-controller"]}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/ldap/{login_option_id}/login":{"post":{"tags":["Developer"],"summary":"Log in to developer portal using the username and password","operationId":"developerLDAPLogin","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["username","password"],"properties":{"username":{"description":"The username of the user.","type":"string","minLength":1,"maxLength":128,"example":"john"},"password":{"type":"string","description":"The password of the user.","minLength":1,"maxLength":128,"example":"safe-password"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/ldap/{login_option_id}/logout":{"post":{"tags":["Developer"],"summary":"Log out from developer portal","operationId":"developerLDAPLogout","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}}}}}}}},"/api/oidc/{login_option_id}/login":{"get":{"tags":["Developer"],"summary":"Log in using the OIDC provider","operationId":"developerOIDCLogin","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"responses":{"307":{"description":"Redirect","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/oidc/{login_option_id}/callback":{"get":{"tags":["Developer"],"summary":"Log in using the OIDC provider","operationId":"developerOIDCCallback","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."},{"name":"state","in":"query","description":"The field of the OIDC protocol.","required":true,"schema":{"type":"string"}},{"name":"code","in":"query","description":"The field of the OIDC protocol.","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"Redirect to the home page.","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/oidc/{login_option_id}/logout":{"get":{"tags":["Developer"],"summary":"Log out using the OIDC provider","operationId":"developerOIDCLogout","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"responses":{"307":{"description":"Redirect","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/saml/{login_option_id}/login":{"get":{"tags":["Developer"],"summary":"SAML login, will redirect to IdP and callback to SP(developer portal)","operationId":"developerSAMLLogin","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."},{"name":"redirect_uri","in":"query","schema":{"type":"string","minLength":1,"pattern":"^/"},"description":"Path to be redirected after callback."}],"responses":{"302":{"description":"Redirect to IdP.","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/saml/{login_option_id}/logout":{"get":{"tags":["Developer"],"summary":"SAML Logout, will redirect to IdP and callback to SP(developer portal)","operationId":"developerSAMLLogout","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."},{"name":"redirect_uri","in":"query","schema":{"type":"string","minLength":1,"pattern":"^/"},"description":"Path to be redirected after callback."}],"responses":{"302":{"description":"Redirect to IdP.","content":{}}}}},"/api/saml/{login_option_id}/acs":{"post":{"operationId":"developerSAMLACSCallback","tags":["Developer"],"summary":"SAML ACS/SLO callback, from IdP callback to SP(developer portal)","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["SAMLResponse"],"properties":{"SAMLResponse":{"type":"string","description":"Base64 encoded SAML response"},"RelayState":{"type":"string","description":"State information to be relayed with the response"}}}}}},"responses":{"302":{"description":"Redirect to IdP.","content":{}}}}},"/api/saml/{login_option_id}/slo":{"get":{"tags":["Developer"],"summary":"SAML ACS/SLO callback, from IdP callback to SP(developer portal)","operationId":"developerSAMLSLO","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."},{"name":"SAMLResponse","in":"query","required":true,"schema":{"type":"string"},"description":"Base64 encoded SAML response."},{"name":"RelayState","in":"query","required":false,"schema":{"type":"string"},"description":"State information to be relayed with the response."}],"responses":{"302":{"description":"Redirect to IdP.","content":{}}}},"post":{"operationId":"developerSAMLSLOCallback","tags":["Developer"],"summary":"SAML ACS/SLO callback, from IdP callback to SP(developer portal)","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["SAMLResponse"],"properties":{"SAMLResponse":{"type":"string","description":"Base64 encoded SAML response"},"RelayState":{"type":"string","description":"State information to be relayed with the response"}}}}}},"responses":{"302":{"description":"Redirect to IdP.","content":{}}}}},"/api/saml/{login_option_id}/metadata":{"get":{"tags":["Developer"],"summary":"SP metadata","operationId":"developerSAMLMetadata","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"responses":{"200":{"description":"saml metadata xml response","content":{"application/samlmetadata+xml":{"schema":{"type":"string"}}}}}}},"/api/cas/{login_option_id}/login":{"get":{"tags":["User"],"summary":"Log in using the CAS provider","operationId":"CASLogin","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."},{"name":"ticket","in":"query","description":"The field of the CAS protocol.","schema":{"type":"string"}}],"responses":{"301":{"description":"Permanent redirect to IDP.","content":{}},"302":{"description":"Redirect to IdP.","content":{}}}}},"/api/cas/{login_option_id}/logout":{"get":{"tags":["User"],"summary":"Log out using the CAS provider","operationId":"CASLogout","parameters":[{"name":"login_option_id","in":"path","required":true,"schema":{"type":"string"},"description":"Login option ID."}],"responses":{"301":{"description":"Permanent redirect to IDP.","content":{}},"302":{"description":"Redirect to IdP.","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/login_options_for_login":{"get":{"tags":["Developer"],"summary":"List all developer login options for login","operationId":"listDeveloperLoginOptionsForLogin","description":"list developer login options for login","parameters":[{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Order to list the resources by. The sorting index follows the configuration of `order_by`.","in":"query"},{"name":"order_by","in":"query","description":"Index to order resources by.","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at"],"description":"Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`."}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Condition to search resources by.","example":"version%3Dv2"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Name of the resource."},{"name":"portal_id","description":"The unique identifier of the portal instance.","in":"query","required":false,"schema":{"default":"default","description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"Array of login options","items":{"allOf":[{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"created_at":{"description":"The object created timestamp.","type":"integer","minimum":0,"example":1742288232},"updated_at":{"description":"The object updated timestamp.","type":"integer","minimum":0,"example":1742288235},"name":{"example":"API7 Integrated Authentication","type":"string","minLength":1,"maxLength":256,"description":"Name of the login option."},"logo":{"type":"string","description":"The base64-encoded logo image.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAH4SURBVHgBrVVLUhsxEH3SaBJSxJQWLLJKzAkClcqCVcINkhuYk6RygnCDkBOYI3iXTVKQE9ipggIGKKb42TAjNWrbY0+BkcY2b6ceqV/3688Ac6CrF+r/tfzmuyMxI25rL75klO+exDbFcxP0luItAjXbKteSsOe7qzAFWBJpbZOIVhNlkAkgyvHP96ZyBiyJMGaXnd8JQhJZgNBZSzGfRKS1LiRxR822dpwPPgq/PAyvRCzJnb1pukhXC9uZi5ylGfgPEzyZQbcWNwpJChtLcxyZ8WOaMYPua/XZRffzoT1xzq0Yn3vGX+B+EJOMr67yFkXZivO1XdjOnTRpROVr6XqKDmYh6JO4xy8vs00mMpJ2kpI0QwTl8RKUiZSlX+9yhcWSPqIiQaVBEyQ/Lbi2X7EK19LiULlOArWqvK00aC7wUSctWom3WcQZNH6/QT30VqACerX4HMMhY+yrfFxwgW3H9339aHLBgwQ8bG4e2sWZu+lAPSq4m0VsfDxF66E9KJE02Uge099Bj5ynzntjknNGuMgk3hd5JqU1McReluOrbx7CRRaynwGvCd5DIzOw5Vb1RmjYghkQdxCVNuhAks0PZ9hBBXgJSEPfGqoXPxdUkGQq8NK7WFL0Zxn0dxk/MAO8GQhX4E6cTSXJVAQnsdHXBmvzSHIP3R3bZScnj8UAAAAASUVORK5CYII="},"disable":{"type":"boolean","description":"If true, disable the login option.","default":false},"provider_type":{"type":"string","enum":["ldap","oidc","saml","built_in"],"description":"The login option type.","example":"built_in"},"builtin_config":{"type":"object","description":"Built-in configuration.","properties":{"login_with_email":{"type":"boolean","description":"If true, enable email login.","default":false}}}}},{"type":"object","properties":{"builtin_config":{"type":"object","description":"Built-in specific configuration","properties":{"enable_self_registration":{"type":"boolean","description":"Whether to enable self registration."},"registration_auto_approval":{"type":"boolean","description":"Whether to auto approve new registrations."},"login_with_email":{"type":"boolean","description":"If true, enable email login.","default":false}}}}}]}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}}}}},"/api/system_settings/smtp_server_status":{"get":{"tags":["System Settings"],"summary":"Get SMTP server settings status","description":"Get SMTP server settings status.","responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable SMTP Server."}}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/system_settings/public_access":{"get":{"tags":["Login Settings"],"summary":"Get developer portal public access","operationId":"getDeveloperPortalPublicAccess","responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."}}},{"type":"object","properties":{"value":{"type":"object","additionalProperties":false,"properties":{"portal_public_access":{"type":"boolean","description":"If true, allow public access to the developer portal."}}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}},"/api/dcr_providers":{"get":{"tags":["Developer Portal - DCR Provider"],"summary":"List all DCR providers","operationId":"listDCRProviders","parameters":[{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Order to list the resources by. The sorting index follows the configuration of `order_by`.","in":"query"},{"name":"order_by","in":"query","description":"Index to order resources by.","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at"],"description":"Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`."}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Condition to search resources by.","example":"version%3Dv2"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","description":"An array of resources.","items":{"type":"object"}},"total":{"type":"integer","minimum":0,"example":1,"description":"Total number of objects."}}},{"type":"object","properties":{"list":{"type":"array","description":"An array of DCRProvider.","items":{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256,"example":"bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"},"name":{"type":"string","description":"The name of the Dynamic Client Registration (DCR) Provider."},"issuer":{"type":"string","description":"The issuer URL of the Authorization Server."}}}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"object","description":"The specific resource.","example":{}},"error_msg":{"type":"string","description":"The error message.","example":"error message"}}}}}}}}}},"components":{"securitySchemes":{}}}