List Portals
Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated configuration, customization, developers, and applications.
Query parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Determines which page of the entities to retrieve.
Sorts a collection of portals. Supported sort attributes are:
- name
- description
- authentication_enabled
- rbac_enabled
- auto_approve_applications
- auto_approve_developers
- default_domain
- canonical_domain
- created_at
- updated_at
Filter portals returned in the response.
Response
A paginated list of portals in the current region of an organization.
Example response
{
"data": [
{
"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"sipr_enabled": true,
"labels": {
"env": "test"
}
}
],
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
}
}Changes
Changed in 7 of the 75 revisions of this API.361025
- ○
added the optional property
data/items/notifications_developer_pii_visibility_enabledto the response with the200statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the required property
data/items/sipr_enabledto the response with the200statusresponse-required-property-added
- ○
- ●
added the new
typeenum value to theallOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/ruleresponse property for the response status400response-property-enum-value-added
- ●
- ▲
the response property
allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/sourcebecame nullable for the status400response-property-became-nullable
- ▲
the response property
allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/sourcebecame nullable for the status400response-property-became-nullable
- ▲
the response property
allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/sourcebecame nullable for the status400response-property-became-nullable
- ▲
the response property
allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/sourcebecame nullable for the status400response-property-became-nullable
- ▲
the response property
allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/sourcebecame nullable for the status400response-property-became-nullable
- ▲
the response property
data/items/display_namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
data/items/namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
detailbecame nullable for the status401response-property-became-nullable
- ▲
the response property
instancebecame nullable for the status401response-property-became-nullable
- ▲
the response property
statusbecame nullable for the status401response-property-became-nullable
- ▲
the response property
titlebecame nullable for the status401response-property-became-nullable
- ○
the
authentication_enabledresponse's property default valuetruewas added for the status200response-property-default-value-added
- ○
the
auto_approve_applicationsresponse's property default valuefalsewas added for the status200response-property-default-value-added
- ○
the
auto_approve_developersresponse's property default valuefalsewas added for the status200response-property-default-value-added
- ○
the
rbac_enabledresponse's property default valuefalsewas added for the status200response-property-default-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
for the
queryrequest parameterfilter, the type/format of propertycanonical_domainwas specialized from/toobject/request-parameter-property-type-specialized
- ▲
for the
queryrequest parameterfilter, the type/format of propertydefault_api_visibilitywas specialized from/toobject/request-parameter-property-type-specialized
- ▲
for the
queryrequest parameterfilter, the type/format of propertydefault_application_auth_strategy_idwas specialized from/toobject/request-parameter-property-type-specialized
- ▲
for the
queryrequest parameterfilter, the type/format of propertydefault_domainwas specialized from/toobject/request-parameter-property-type-specialized
- ▲
for the
queryrequest parameterfilter, the type/format of propertydefault_page_visibilitywas specialized from/toobject/request-parameter-property-type-specialized
- ▲
for the
queryrequest parameterfilter, the type/format of propertydescriptionwas specialized from/toobject/request-parameter-property-type-specialized
- ▲
for the
queryrequest parameterfilter, the type/format of propertyidwas specialized from/toobject/request-parameter-property-type-specialized
- ▲
for the
queryrequest parameterfilter, the type/format of propertynamewas specialized from/toobject/request-parameter-property-type-specialized
- ▲
the
data/items/response's property type/format changed from/toobject/for status200response-property-type-changed
- ○
added the optional property
data/items/labelsto the response with the200statusresponse-optional-property-added
- ○
removed
Portalsubschema #2from thedata/items/response propertyallOflist for the response status200response-property-all-of-removed
- ○
added the required property
data/items/authentication_enabledto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/auto_approve_applicationsto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/auto_approve_developersto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/canonical_domainto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/created_atto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/default_api_visibilityto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/default_application_auth_strategy_idto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/default_domainto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/default_page_visibilityto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/descriptionto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/display_nameto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/idto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/nameto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/rbac_enabledto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/updated_atto the response with the200statusresponse-required-property-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the
data/items/response's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
removed the required property
data/items/authentication_enabledfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/auto_approve_applicationsfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/auto_approve_developersfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/canonical_domainfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/created_atfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/default_api_visibilityfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/default_application_auth_strategy_idfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/default_domainfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/default_page_visibilityfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/descriptionfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/display_namefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/idfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/namefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/rbac_enabledfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/items/updated_atfrom the response with the200statusresponse-required-property-removed
- ●
for the
queryrequest parameterfilter, the type/format of propertycanonical_domainwas changed fromobject/to/request-parameter-property-type-changed
- ●
for the
queryrequest parameterfilter, the type/format of propertydefault_api_visibilitywas changed fromobject/to/request-parameter-property-type-changed
- ●
for the
queryrequest parameterfilter, the type/format of propertydefault_application_auth_strategy_idwas changed fromobject/to/request-parameter-property-type-changed
- ●
for the
queryrequest parameterfilter, the type/format of propertydefault_domainwas changed fromobject/to/request-parameter-property-type-changed
- ●
for the
queryrequest parameterfilter, the type/format of propertydefault_page_visibilitywas changed fromobject/to/request-parameter-property-type-changed
- ●
for the
queryrequest parameterfilter, the type/format of propertydescriptionwas changed fromobject/to/request-parameter-property-type-changed
- ●
for the
queryrequest parameterfilter, the type/format of propertyidwas changed fromobject/to/request-parameter-property-type-changed
- ●
for the
queryrequest parameterfilter, the type/format of propertynamewas changed fromobject/to/request-parameter-property-type-changed
- ●
removed the optional property
data/items/labelsfrom the response with the200statusresponse-optional-property-removed
- ○
added
Portalsubschema #2to thedata/items/response propertyallOflist for the response status200response-property-all-of-added
- ▲
- ○
endpoint added
endpoint-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○