openapi: 3.2.0
info:
version: '2020-07-08'
x-release: v4
title: Amazon WorkSpaces Web Identity Providers API
description: WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads.
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: workspaces-web
x-aws-signingName: workspaces-web
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workspaces-web-2020-07-08.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://workspaces-web.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon WorkSpaces Web multi-region endpoint
- url: https://workspaces-web.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon WorkSpaces Web multi-region endpoint
- url: http://workspaces-web.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon WorkSpaces Web endpoint for China (Beijing) and China (Ningxia)
- url: https://workspaces-web.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon WorkSpaces Web endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Identity Providers
paths:
/identityProviders:
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'
post:
operationId: CreateIdentityProvider
description: Creates an identity provider resource that is then associated with a web portal.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIdentityProviderResponse'
'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: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'485':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'486':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- identityProviderDetails
- identityProviderName
- identityProviderType
- portalArn
properties:
clientToken:
description: 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.
If you do not specify a client token, one is automatically generated by the AWS SDK.
type: string
minLength: 1
maxLength: 512
identityProviderDetails:
description: The identity provider details. The following list describes the provider detail keys for each identity provider type.
type: object
additionalProperties:
$ref: '#/components/schemas/StringType'
identityProviderName:
description: The identity provider name.
type: string
pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$
minLength: 1
maxLength: 32
format: password
identityProviderType:
description: The identity provider type.
type: string
enum:
- SAML
- Facebook
- Google
- LoginWithAmazon
- SignInWithApple
- OIDC
portalArn:
description: The ARN of the web portal.
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 Create Identity Provider
tags:
- Identity Providers
/identityProviders/{identityProviderArn}:
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'
delete:
operationId: DeleteIdentityProvider
description: Deletes the identity provider.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteIdentityProviderResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
parameters:
- name: identityProviderArn
in: path
required: true
description: The ARN of the identity provider.
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 Delete Identity Provider
tags:
- Identity Providers
get:
operationId: GetIdentityProvider
description: Gets the identity provider.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetIdentityProviderResponse'
'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: identityProviderArn
in: path
required: true
description: The ARN of the identity provider.
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 Identity Provider
tags:
- Identity Providers
patch:
operationId: UpdateIdentityProvider
description: Updates the identity provider.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIdentityProviderResponse'
'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: identityProviderArn
in: path
required: true
description: The ARN of the identity provider.
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
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
clientToken:
description: 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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
type: string
minLength: 1
maxLength: 512
identityProviderDetails:
description: The details of the identity provider. The following list describes the provider detail keys for each identity provider type.
type: object
additionalProperties:
$ref: '#/components/schemas/StringType'
identityProviderName:
description: The name of the identity provider.
type: string
pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$
minLength: 1
maxLength: 32
format: password
identityProviderType:
description: The type of the identity provider.
type: string
enum:
- SAML
- Facebook
- Google
- LoginWithAmazon
- SignInWithApple
- OIDC
summary: Amazon WorkSpaces Web Update Identity Provider
tags:
- Identity Providers
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
schemas:
ConflictException: {}
ServiceQuotaExceededException: {}
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
AccessDeniedException: {}
IdentityProviderName:
type: string
pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$
minLength: 1
maxLength: 32
format: password
IdentityProvider:
type: object
required:
- identityProviderArn
properties:
identityProviderArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN of the identity provider.
identityProviderDetails:
allOf:
- $ref: '#/components/schemas/IdentityProviderDetails'
- description: The identity provider details. The following list describes the provider detail keys for each identity provider type.
identityProviderName:
allOf:
- $ref: '#/components/schemas/IdentityProviderName'
- description: The identity provider name.
identityProviderType:
allOf:
- $ref: '#/components/schemas/IdentityProviderType'
- description: The identity provider type.
description: The identity provider.
UpdateIdentityProviderResponse:
type: object
required:
- identityProvider
properties:
identityProvider:
allOf:
- $ref: '#/components/schemas/IdentityProvider'
- description: The identity provider.
ThrottlingException: {}
StringType:
type: string
pattern: ^[\s\S]*$
minLength: 0
maxLength: 131072
DeleteIdentityProviderResponse:
type: object
properties: {}
InternalServerException: {}
ResourceNotFoundException: {}
IdentityProviderType:
type: string
enum:
- SAML
- Facebook
- Google
- LoginWithAmazon
- SignInWithApple
- OIDC
IdentityProviderDetails:
type: object
additionalProperties:
$ref: '#/components/schemas/StringType'
ValidationException: {}
GetIdentityProviderResponse:
type: object
properties:
identityProvider:
allOf:
- $ref: '#/components/schemas/IdentityProvider'
- description: The identity provider.
CreateIdentityProviderResponse:
type: object
required:
- identityProviderArn
properties:
identityProviderArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN of the identity provider.
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/workspaces-web/
x-hasEquivalentPaths: true