{"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.5.5"},"servers":[],"security":[],"paths":{"/api/api_products":{"get":{"tags":["API Product"],"summary":"List all API products for Developer Portal.","operationId":"listAPIProducts-DeveloperPortal","parameters":[{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"The page number, starting from 1.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"The page size. It must be greater than 0.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"It should be ascending or descending (case-insensitive). By default, it is set to descending.","in":"query"},{"name":"order_by","in":"query","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at"]}},{"name":"search","in":"query","schema":{"type":"string"},"description":"The search keyword."},{"name":"subscription_status","in":"query","schema":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","items":{"type":"object"}},"total":{"type":"integer","minimum":0}}},{"type":"object","properties":{"list":{"type":"array","description":"An array of APIProduct.","items":{"allOf":[{"description":"The APIProduct fields.","allOf":[{"oneOf":[{"title":"GatewayAPIProduct","type":"object","allOf":[{"type":"object","required":["type","name","linked_gateway_services"],"properties":{"type":{"type":"string","enum":["gateway"],"default":"gateway"},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"logo":{"type":"string","description":"The logo of the API product."},"desc":{"type":"string","description":"The description of the API product."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}},"auth":{"type":"object","description":"The auth configuration of the API product.","additionalProperties":false,"oneOf":[{"required":["key-auth"]}],"properties":{"key-auth":{"type":"object","additionalProperties":false,"properties":{"hide_credentials":{"type":"boolean","default":false},"query":{"type":"string","default":"apikey"},"header":{"type":"string","default":"apikey"}}}}},"linked_gateway_services":{"type":"array","minItems":1,"items":{"type":"object","properties":{"gateway_group_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"service_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256}}}},"status":{"type":"string","enum":["draft","published"],"default":"draft"},"subscription_auto_approval":{"type":"boolean","default":false,"description":"Whether the subscription is auto approved or not."},"can_view_unsubscribed":{"type":"boolean","description":"Whether the developer can view the unsubscribed APIs or not.","default":true},"visibility":{"type":"string","enum":["public","logged_in"],"default":"public","description":"The visibility of the API product in the API hub. Public means visible to all users, logged_in means only visible to logged in developers."}}},{"type":"object","properties":{"linked_gateway_services":{"type":"array","items":{"type":"object","properties":{"gateway_group_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"gateway_group_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"service_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"version":{"type":"string","description":"The version of the published service."},"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":{"type":"string","description":"The HTTP host.","pattern":"^\\*?[0-9a-zA-Z-._]+$"}},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0},"openapi_title":{"type":"string","description":"The title of the openapi file."}}}}}}]},{"title":"ExternalAPIProduct","type":"object","allOf":[{"type":"object","required":["name","type","raw_openapi","server_url"],"properties":{"type":{"type":"string","enum":["external"],"default":"external"},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"raw_openapi":{"type":"string","minLength":1,"description":"The content of the openapi yaml file."},"server_url":{"type":"string","minLength":1,"description":"The server url, if its not defines on the openapi file, the user should specified it."},"status":{"type":"string","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 visible to all users, logged_in means only visible to logged in developers."}}},{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"desc":{"type":"string"},"api_desc":{"type":"string"},"api_count":{"type":"number","format":"int64"}}}]}]},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0}}}]},{"type":"object","properties":{"subscription_status":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}}]}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/api/api_products/{api_product_id}":{"get":{"tags":["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}}],"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"allOf":[{"description":"The APIProduct fields.","allOf":[{"oneOf":[{"title":"GatewayAPIProduct","type":"object","allOf":[{"type":"object","required":["type","name","linked_gateway_services"],"properties":{"type":{"type":"string","enum":["gateway"],"default":"gateway"},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"logo":{"type":"string","description":"The logo of the API product."},"desc":{"type":"string","description":"The description of the API product."},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}},"auth":{"type":"object","description":"The auth configuration of the API product.","additionalProperties":false,"oneOf":[{"required":["key-auth"]}],"properties":{"key-auth":{"type":"object","additionalProperties":false,"properties":{"hide_credentials":{"type":"boolean","default":false},"query":{"type":"string","default":"apikey"},"header":{"type":"string","default":"apikey"}}}}},"linked_gateway_services":{"type":"array","minItems":1,"items":{"type":"object","properties":{"gateway_group_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"service_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256}}}},"status":{"type":"string","enum":["draft","published"],"default":"draft"},"subscription_auto_approval":{"type":"boolean","default":false,"description":"Whether the subscription is auto approved or not."},"can_view_unsubscribed":{"type":"boolean","description":"Whether the developer can view the unsubscribed APIs or not.","default":true},"visibility":{"type":"string","enum":["public","logged_in"],"default":"public","description":"The visibility of the API product in the API hub. Public means visible to all users, logged_in means only visible to logged in developers."}}},{"type":"object","properties":{"linked_gateway_services":{"type":"array","items":{"type":"object","properties":{"gateway_group_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"gateway_group_name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"service_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"version":{"type":"string","description":"The version of the published service."},"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":{"type":"string","description":"The HTTP host.","pattern":"^\\*?[0-9a-zA-Z-._]+$"}},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0},"openapi_title":{"type":"string","description":"The title of the openapi file."}}}}}}]},{"title":"ExternalAPIProduct","type":"object","allOf":[{"type":"object","required":["name","type","raw_openapi","server_url"],"properties":{"type":{"type":"string","enum":["external"],"default":"external"},"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"raw_openapi":{"type":"string","minLength":1,"description":"The content of the openapi yaml file."},"server_url":{"type":"string","minLength":1,"description":"The server url, if its not defines on the openapi file, the user should specified it."},"status":{"type":"string","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 visible to all users, logged_in means only visible to logged in developers."}}},{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"desc":{"type":"string"},"api_desc":{"type":"string"},"api_count":{"type":"number","format":"int64"}}}]}]},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0}}}]},{"type":"object","properties":{"subscription_status":{"type":"string","enum":["unsubscribed","wait_for_approval","subscribed"]}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/api/api_products/{api_product_id}/oas":{"get":{"tags":["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}},{"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}}],"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"type":"object","properties":{"raw_openapi":{"type":"string","description":"The OpenAPI specification of the service."},"api_count":{"type":"integer","description":"The number of APIs in the service."},"api_desc":{"type":"string","description":"The description of the OAS."}}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/api/api_products/{api_product_id}/subscriptions":{"post":{"tags":["API Product Subscription"],"summary":"Create a subscription for an API Product.","operationId":"createSubscription","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}}],"requestBody":{"content":{"application/json":{"schema":{"description":"The request body for creating a subscription.","type":"object","properties":{"application_id":{"type":"string","minLength":1,"description":"The application id."}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning 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},"password":{"description":"The password of the user.","type":"string","minLength":1,"maxLength":128}}}}}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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},"password":{"description":"The password of the user.","type":"string","minLength":1,"maxLength":128}}}}}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/api/password":{"put":{"tags":["User"],"summary":"Update the user password.","operationId":"updateUserPassword","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["new_password"],"properties":{"old_password":{"type":"string","minLength":1,"maxLength":128},"new_password":{"type":"string","minLength":1,"maxLength":128}}}}},"required":true},"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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"description":"The user.","allOf":[{"type":"object","properties":{"username":{"type":"string"},"name":{"type":"string"},"desc":{"type":"string"},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}},"last_active_at":{"type":"integer"},"email":{"type":"string"},"email_verified":{"type":"boolean"}}},{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"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":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}},"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":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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":"object","description":"The outer structure for encapsulating the specific resource.","properties":{"value":{"type":"object","description":"The specific resource."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}},"delete":{"tags":["User"],"summary":"Delete the user email.","operationId":"deleteUserEmail","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/api/email_verified":{"get":{"tags":["Email"],"summary":"Check if email is verified","operationId":"checkEmailVerified","parameters":[{"name":"email","in":"query","required":true,"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"type":"object","properties":{"verified":{"type":"boolean"}}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/api/allow_access":{"post":{"tags":["Role","User"],"summary":"Check if a user has certain permissions on certain resources.","operationId":"checkAllowAccess","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object","properties":{"resource":{"type":"string"},"action":{"type":"string"},"context":{"type":"object","anyOf":[{"title":"ContextForGatewayGroup","type":"object","properties":{"gateway_group_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForService","type":"object","properties":{"service_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForPublishedService","type":"object","properties":{"gateway_group_label":{"type":"object","additionalProperties":{"type":"string"}},"service_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForRole","type":"object","properties":{"role_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForPermissionPolicy","type":"object","properties":{"permission_policy_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForUser","type":"object","properties":{"user_label":{"type":"object","additionalProperties":{"type":"string"}},"permission_boundaries":{"type":"array","items":{"type":"string"}}}},{"title":"ContextForConsumer","type":"object","properties":{"gateway_group_label":{"type":"object","additionalProperties":{"type":"string"}},"consumer_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForSecret","type":"object","properties":{"gateway_group_label":{"type":"object","additionalProperties":{"type":"string"}},"secret_provider_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForContactPoint","type":"object","properties":{"contact_point_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForAlertPolicy","type":"object","properties":{"alert_policy_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForDeveloper","type":"object","properties":{"developer_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForAPIProduct","type":"object","properties":{"api_product_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForCaCertificate","type":"object","properties":{"ca_certificate_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForCertificate","type":"object","properties":{"certificate_label":{"type":"object","additionalProperties":{"type":"string"}}}},{"title":"ContextForSNI","type":"object","properties":{"sni_label":{"type":"object","additionalProperties":{"type":"string"}}}}]}},"required":["resource","action"]}}}}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","additionalProperties":{"type":"boolean"}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/api/applications/{application_id}/credentials":{"post":{"tags":["Credential"],"summary":"Create a developer credential.","operationId":"createDeveloperCredential","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"type":"string","default":"default"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Create an application credential request.","type":"object","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"desc":{"description":"The object description.","type":"string","maxLength":65536},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}},"plugins":{"type":"object","properties":{"key-auth":{"type":"object","nullable":true,"additionalProperties":false}},"additionalProperties":false,"maxProperties":1,"oneOf":[{"required":["key-auth"]}]}},"required":["name","plugins"]}}}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"plugins":{"type":"object","additionalProperties":false,"oneOf":[{"required":["key-auth"]}],"properties":{"key-auth":{"type":"object"}}},"desc":{"description":"The object description.","type":"string","maxLength":65536},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}}}},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}},"get":{"tags":["Credential"],"summary":"List all credentials for the logged in developer.","operationId":"listDeveloperCredentials","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"type":"string","default":"default"}},{"name":"plugin_name","description":"the plugin name of the developer credential.","in":"query","required":false,"schema":{"description":"The object name.","type":"string","minLength":1,"maxLength":100}},{"name":"page","schema":{"type":"integer","format":"int64","minimum":1},"description":"The page number, starting from 1.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"The page size. It must be greater than 0.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"It should be ascending or descending (case-insensitive). By default, it is set to descending.","in":"query"},{"name":"order_by","in":"query","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at","name"]}},{"name":"search","in":"query","schema":{"type":"string"},"description":"The search keyword."},{"name":"labels","in":"query","required":false,"schema":{"type":"object","additionalProperties":{"type":"string"},"minLength":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","items":{"type":"object"}},"total":{"type":"integer","minimum":0}}},{"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","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"plugins":{"type":"object","additionalProperties":false,"oneOf":[{"required":["key-auth"]}],"properties":{"key-auth":{"type":"object"}}},"desc":{"description":"The object description.","type":"string","maxLength":65536},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}}}},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0}}}]}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning 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":{"type":"string","default":"default"}},{"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}}],"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"plugins":{"type":"object","additionalProperties":false,"oneOf":[{"required":["key-auth"]}],"properties":{"key-auth":{"type":"object"}}},"desc":{"description":"The object description.","type":"string","maxLength":65536},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}}}},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}},"put":{"tags":["Credential"],"summary":"Create or update a developer credential for Developer Portal.","operationId":"upsertDeveloperCredential","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"type":"string","default":"default"}},{"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}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Update an application credential request.","type":"object","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"desc":{"description":"The object description.","type":"string","maxLength":65536},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}}},"additionalProperties":false}}}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"plugins":{"type":"object","additionalProperties":false,"oneOf":[{"required":["key-auth"]}],"properties":{"key-auth":{"type":"object"}}},"desc":{"description":"The object description.","type":"string","maxLength":65536},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}}}},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}},"delete":{"tags":["Credential"],"summary":"Delete a developer credential for Developer Portal.","operationId":"deleteDeveloperCredential","parameters":[{"name":"application_id","in":"path","required":true,"schema":{"type":"string","default":"default"}},{"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}}],"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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning 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":{"type":"string","default":"default"}},{"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}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Regenerate an application credential request.","type":"object","properties":{"key-auth":{"type":"object","nullable":true,"additionalProperties":false}},"oneOf":[{"required":["key-auth"]}],"additionalProperties":false}}}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"description":"The developer credential with management fields.","allOf":[{"description":"The developer credential description.","type":"object","properties":{"name":{"description":"The object name.","type":"string","minLength":1,"maxLength":100},"developer_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"application_id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"plugins":{"type":"object","additionalProperties":false,"oneOf":[{"required":["key-auth"]}],"properties":{"key-auth":{"type":"object"}}},"desc":{"description":"The object description.","type":"string","maxLength":65536},"labels":{"type":"object","additionalProperties":{"type":"string","pattern":"^.+$","minLength":1,"maxLength":65536},"example":{"keyA":"valueA","keyB":"valueB"}}}},{"type":"object","properties":{"id":{"description":"The object ID.","type":"string","pattern":"^[a-zA-Z0-9-_.]+$","minLength":1,"maxLength":256},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0}}}]}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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","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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["username","password"],"properties":{"username":{"description":"The username of the user.","type":"string","minLength":1,"maxLength":128},"password":{"description":"The password of the user.","type":"string","minLength":1,"maxLength":128}}}}}},"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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}}],"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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}}],"responses":{"307":{"description":"Redirect","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}},{"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":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}}],"responses":{"307":{"description":"Redirect","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}},{"name":"redirect_uri","in":"query","description":"Path to be redirected after callback","schema":{"type":"string","minLength":1,"pattern":"^/"}}],"responses":{"302":{"description":"Redirect to IDP.","content":{}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}},{"name":"redirect_uri","in":"query","description":"Path to be redirected after callback","schema":{"type":"string","minLength":1,"pattern":"^/"}}],"responses":{"302":{"description":"Redirect to IDP.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}}],"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":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}},{"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":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}},"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"}}],"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":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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"}}],"responses":{"200":{"description":"saml metadata xml response","content":{"application/samlmetadata+xml":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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":"The page number, starting from 1.","in":"query"},{"name":"page_size","schema":{"type":"integer","format":"int64","minimum":1},"description":"The page size. It must be greater than 0.","in":"query"},{"name":"direction","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"It should be ascending or descending (case-insensitive). By default, it is set to descending.","in":"query"},{"name":"order_by","in":"query","schema":{"type":"string","default":"updated_at","enum":["created_at","updated_at"]}},{"name":"search","in":"query","schema":{"type":"string"},"description":"The search keyword."},{"in":"query","name":"name","schema":{"type":"string"},"description":"Name is the name of the resource."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The outer structure for encapsulating a list of resources.","properties":{"list":{"type":"array","items":{"type":"object"}},"total":{"type":"integer","minimum":0}}},{"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},"created_at":{"description":"The object timestamp.","type":"integer","minimum":0},"updated_at":{"description":"The object timestamp.","type":"integer","minimum":0},"name":{"type":"string"},"logo":{"type":"string","description":"The base64 logo image."},"disable":{"type":"boolean","description":"Whether to disable the login option.","default":false},"provider_type":{"type":"string","enum":["ldap","oidc","saml","built_in"],"description":"The login option type."}}},{"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."}}}}}]}}}}]}}}},"400":{"description":"Invalid arguments. Error details will be provided in the response.","content":{}},"500":{"description":"Internal Server Error","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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}},"/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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable SMTP Server."}}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning 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."},"warning_msg":{"type":"string","description":"The warning message."}}},{"type":"object","properties":{"value":{"type":"object","additionalProperties":false,"properties":{"portal_public_access":{"type":"boolean","description":"Whether to allow public access to the developer portal."}}}}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error_msg":{"type":"string","description":"The 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."},"warning_msg":{"type":"string","description":"The warning message."}}}}}}}}}},"components":{"securitySchemes":{}}}