PortalSummary

{
  "type": "object",
  "properties": {
    "authenticationType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuthenticationType"
        },
        {
          "description": "<p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p> <code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p> <code>IAM_Identity_Center</code> web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.</p>"
        }
      ]
    },
    "browserSettingsArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the browser settings that is associated with the web portal."
        }
      ]
    },
    "browserType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrowserType"
        },
        {
          "description": "The browser type of the web portal."
        }
      ]
    },
    "creationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The creation date of the web portal."
        }
      ]
    },
    "displayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DisplayName"
        },
        {
          "description": "The name of the web portal."
        }
      ]
    },
    "ipAccessSettingsArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the IP access settings."
        }
      ]
    },
    "networkSettingsArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the network settings that is associated with the web portal."
        }
      ]
    },
    "portalArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the web portal."
        }
      ]
    },
    "portalEndpoint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortalEndpoint"
        },
        {
          "description": "The endpoint URL of the web portal that users access in order to start streaming sessions."
        }
      ]
    },
    "portalStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortalStatus"
        },
        {
          "description": "The status of the web portal."
        }
      ]
    },
    "rendererType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RendererType"
        },
        {
          "description": "The renderer that is used in streaming sessions."
        }
      ]
    },
    "trustStoreArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the trust that is associated with this web portal."
        }
      ]
    },
    "userAccessLoggingSettingsArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the user access logging settings that is associated with the web portal."
        }
      ]
    },
    "userSettingsArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN of the user settings that is associated with the web portal."
        }
      ]
    }
  },
  "description": "The summary of the portal.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PortalSummary",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-schema/workspaces-web-portal-summary-schema.json"
}