CreatePortalRequest schema from Amazon WorkSpaces Web API
Type: objectProperties: 6
End User ComputingSecure BrowserVirtual DesktopZero Trust
CreatePortalRequest is a JSON Structure definition published by Amazon WorkSpaces Web, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"type": "object",
"name": "CreatePortalRequest",
"properties": {
"additionalEncryptionContext": {
"allOf": [
{
"$ref": "#/components/schemas/EncryptionContextMap"
},
{
"description": "The additional encryption context of the portal."
}
]
},
"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>"
}
]
},
"clientToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientToken"
},
{
"description": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the AWS SDK.</p>"
}
]
},
"customerManagedKey": {
"allOf": [
{
"$ref": "#/components/schemas/keyArn"
},
{
"description": "The customer managed key of the web portal."
}
]
},
"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."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "The tags to add to the web portal. A tag is a key-value pair."
}
]
}
},
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-structure/workspaces-web-create-portal-request-structure.json",
"description": "CreatePortalRequest schema from Amazon WorkSpaces Web API"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.