Amazon WorkSpaces Web · Schema
UpdatePortalRequest
UpdatePortalRequest schema from Amazon WorkSpaces Web API
End User ComputingSecure BrowserVirtual DesktopZero Trust
Properties
| Name | Type | Description |
|---|---|---|
| authenticationType | object | |
| displayName | object |
JSON Schema
{
"type": "object",
"title": "UpdatePortalRequest",
"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>"
}
]
},
"displayName": {
"allOf": [
{
"$ref": "#/components/schemas/DisplayName"
},
{
"description": "The name of the web portal. This is not visible to users who log into the web portal."
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-schema/workspaces-web-update-portal-request-schema.json",
"description": "UpdatePortalRequest schema from Amazon WorkSpaces Web API"
}