Portals

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.

get/v3/portals

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

sortstring

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
authentication_enabledboolean

Filter by a boolean value (true/false).

rbac_enabledboolean

Filter by a boolean value (true/false).

auto_approve_developersboolean

Filter by a boolean value (true/false).

auto_approve_applicationsboolean

Filter by a boolean value (true/false).

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_enabled to the response with the 200 status

      response-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_enabled to the response with the 200 status

      response-required-property-added

    • added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 3c0154b2053a114See the full diff
    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • the response property data/items/display_name became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/name became nullable for the status 200

      response-property-became-nullable

    • the response property detail became nullable for the status 401

      response-property-became-nullable

    • the response property instance became nullable for the status 401

      response-property-became-nullable

    • the response property status became nullable for the status 401

      response-property-became-nullable

    • the response property title became nullable for the status 401

      response-property-became-nullable

    • the authentication_enabled response's property default value true was added for the status 200

      response-property-default-value-added

    • the auto_approve_applications response's property default value false was added for the status 200

      response-property-default-value-added

    • the auto_approve_developers response's property default value false was added for the status 200

      response-property-default-value-added

    • the rbac_enabled response's property default value false was added for the status 200

      response-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

  • 6333a0d3b095917See the full diff
    • for the query request parameter filter, the type/format of property canonical_domain was specialized from / to object/

      request-parameter-property-type-specialized

    • for the query request parameter filter, the type/format of property default_api_visibility was specialized from / to object/

      request-parameter-property-type-specialized

    • for the query request parameter filter, the type/format of property default_application_auth_strategy_id was specialized from / to object/

      request-parameter-property-type-specialized

    • for the query request parameter filter, the type/format of property default_domain was specialized from / to object/

      request-parameter-property-type-specialized

    • for the query request parameter filter, the type/format of property default_page_visibility was specialized from / to object/

      request-parameter-property-type-specialized

    • for the query request parameter filter, the type/format of property description was specialized from / to object/

      request-parameter-property-type-specialized

    • for the query request parameter filter, the type/format of property id was specialized from / to object/

      request-parameter-property-type-specialized

    • for the query request parameter filter, the type/format of property name was specialized from / to object/

      request-parameter-property-type-specialized

    • the data/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • added the optional property data/items/labels to the response with the 200 status

      response-optional-property-added

    • removed Portal subschema #2 from the data/items/ response property allOf list for the response status 200

      response-property-all-of-removed

    • added the required property data/items/authentication_enabled to the response with the 200 status

      response-required-property-added

    • added the required property data/items/auto_approve_applications to the response with the 200 status

      response-required-property-added

    • added the required property data/items/auto_approve_developers to the response with the 200 status

      response-required-property-added

    • added the required property data/items/canonical_domain to the response with the 200 status

      response-required-property-added

    • added the required property data/items/created_at to the response with the 200 status

      response-required-property-added

    • added the required property data/items/default_api_visibility to the response with the 200 status

      response-required-property-added

    • added the required property data/items/default_application_auth_strategy_id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/default_domain to the response with the 200 status

      response-required-property-added

    • added the required property data/items/default_page_visibility to the response with the 200 status

      response-required-property-added

    • added the required property data/items/description to the response with the 200 status

      response-required-property-added

    • added the required property data/items/display_name to the response with the 200 status

      response-required-property-added

    • added the required property data/items/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/name to the response with the 200 status

      response-required-property-added

    • added the required property data/items/rbac_enabled to the response with the 200 status

      response-required-property-added

    • added the required property data/items/updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d1691See the full diff
    • the data/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the required property data/items/authentication_enabled from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/auto_approve_applications from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/auto_approve_developers from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/canonical_domain from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/created_at from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/default_api_visibility from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/default_application_auth_strategy_id from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/default_domain from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/default_page_visibility from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/description from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/display_name from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/id from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/name from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/rbac_enabled from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/updated_at from the response with the 200 status

      response-required-property-removed

    • for the query request parameter filter, the type/format of property canonical_domain was changed from object/ to /

      request-parameter-property-type-changed

    • for the query request parameter filter, the type/format of property default_api_visibility was changed from object/ to /

      request-parameter-property-type-changed

    • for the query request parameter filter, the type/format of property default_application_auth_strategy_id was changed from object/ to /

      request-parameter-property-type-changed

    • for the query request parameter filter, the type/format of property default_domain was changed from object/ to /

      request-parameter-property-type-changed

    • for the query request parameter filter, the type/format of property default_page_visibility was changed from object/ to /

      request-parameter-property-type-changed

    • for the query request parameter filter, the type/format of property description was changed from object/ to /

      request-parameter-property-type-changed

    • for the query request parameter filter, the type/format of property id was changed from object/ to /

      request-parameter-property-type-changed

    • for the query request parameter filter, the type/format of property name was changed from object/ to /

      request-parameter-property-type-changed

    • removed the optional property data/items/labels from the response with the 200 status

      response-optional-property-removed

    • added Portal subschema #2 to the data/items/ response property allOf list for the response status 200

      response-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