Update developer portal public access
PUT /api/portal/system_settings/public_access
PUT /api/portal/system_settings/public_accessInteractive request editor loads with JavaScript.
In: header
Query Parameters
The unique identifier of the portal instance.
^[a-zA-Z0-9-_.]+$1 <= length <= 256"default"Request Body
application/json
Response Body
application/json
application/json
curl -X PUT "$API_BASE_URL/api/portal/system_settings/public_access" \ -H "Content-Type: application/json" \ -d '{}'Successfully retrieved or updated the developer portal settings.
{
"value": {
"portal_public_access": true
}
}Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
{
"value": {},
"error_msg": "error message"
}Complete operation details and schema variants
PUT /api/portal/system_settings/public_access
Update developer portal public access
Update public access and login behavior for a developer portal, such as how external users can access sign-in or registration flows. This setting controls portal exposure and authentication entry points.
Required IAM Permission: Action portal:UpdateDeveloperPortalPublicAccess, Resource arn:api7:portal:portal/%s/loginsetting/*
Parameters
portal_id(query, string, optional): The unique identifier of the portal instance.
Request body
Content type: application/json
portal_public_access(boolean, optional): If true, allow public access to the developer portal.
Responses
200: Successfully retrieved or updated the developer portal settings.- allOf variant 1
value(object, optional): The specific resource.- allOf variant 2
value(object, optional):value.portal_public_access(boolean, optional): If true, allow public access to the developer portal.400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.value(object, optional): The specific resource.error_msg(string, optional): The error message.
cURL
curl -X PUT '$API_BASE_URL/api/portal/system_settings/public_access'