Amazon WorkSpaces Web

Amazon WorkSpaces Web Portal Idp API

The Portal Idp API from Amazon WorkSpaces Web — 1 operation(s) for portal idp.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 2

GET /portalIdp/{portalArn+} Get Portal Service Provider Metadata #
GET /portalIdp/{portalArn} Amazon WorkSpaces Web Get Portal Service Provider Metadata #

Documentation

📖
Documentation
https://docs.aws.amazon.com/workspaces-web/latest/adminguide/
📖
APIReference
https://docs.aws.amazon.com/workspaces-web/latest/APIReference/
📖
GettingStarted
https://docs.aws.amazon.com/workspaces-web/latest/adminguide/getting-started.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-workspaces-web/openapi/amazon-workspaces-web-portal-idp-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/amazon-workspaces-web/json-schema/workspaces-web-portal-schema.json

Other Resources

🔗
Pricing
https://aws.amazon.com/workspaces/web/pricing/
🔗
FAQ
https://aws.amazon.com/workspaces/web/faqs/
🔗
JSONLD
https://artifacts.apis.io/amazon-workspaces-web/json-ld/amazon-workspaces-web-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-workspaces-web:amazon-workspaces-web-portal-idp-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-workspaces-web-portal-idp-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon WorkSpaces Web Portal Idp API
  version: '2020-07-08'
  description: Generated from AWS's published Smithy model for Amazon WorkSpaces Web. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://workspaces-web.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Portal Idp
paths:
  /portalIdp/{portalArn+}:
    get:
      operationId: GetPortalServiceProviderMetadata
      summary: Get Portal Service Provider Metadata
      description: Gets the service provider metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPortalServiceProviderMetadataResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPortalServiceProviderMetadataRequest'
      tags:
      - Portal Idp
  /portalIdp/{portalArn}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: GetPortalServiceProviderMetadata
      description: Gets the service provider metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPortalServiceProviderMetadataResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: portalArn
        in: path
        required: true
        description: The ARN of the web portal.
        schema:
          type: string
          pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$
          minLength: 20
          maxLength: 2048
      summary: Amazon WorkSpaces Web Get Portal Service Provider Metadata
      tags:
      - Portal Idp
components:
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field that failed validation.
        message:
          type: string
          description: The message describing why the field failed validation.
      required:
      - name
      - message
    GetPortalServiceProviderMetadataRequest:
      type: object
      properties:
        portalArn:
          type: string
          description: The ARN of the web portal.
      required:
      - portalArn
    GetPortalServiceProviderMetadataResponse:
      type: object
      properties:
        portalArn:
          type: string
          description: The ARN of the web portal.
        serviceProviderSamlMetadata:
          type: string
          description: The service provider SAML metadata.
      required:
      - portalArn
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The originating service.
        quotaCode:
          type: string
          description: The originating quota.
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: Reason the request failed validation
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The field that caused the error.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: Hypothetical identifier of the resource affected.
        resourceType:
          type: string
          description: Hypothetical type of the resource affected.
    ARN:
      type: string
      pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$
      minLength: 20
      maxLength: 2048
    SamlMetadata:
      type: string
      pattern: ^.+$
      minLength: 1
      maxLength: 204800
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: workspaces-web
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
  parameters:
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/workspaces-web/service/2020-07-08/workspaces-web-2020-07-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)