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-workmail:amazon-workmail-identity-provider-configuration-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

openapi: 3.2.0
info:
  title: Amazon WorkMail Identity Provider Configuration API
  version: '2017-10-01'
  description: Generated from AWS's published Smithy model for Amazon WorkMail. 3 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://workmail.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Identity Provider Configuration
paths:
  /#DeleteIdentityProviderConfiguration:
    post:
      operationId: DeleteIdentityProviderConfiguration
      summary: Delete Identity Provider Configuration
      description: Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteIdentityProviderConfigurationResponse'
        '400':
          description: InvalidParameterException; OrganizationNotFoundException; OrganizationStateException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkMailService.DeleteIdentityProviderConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteIdentityProviderConfigurationRequest'
      tags:
      - Identity Provider Configuration
  /#DescribeIdentityProviderConfiguration:
    post:
      operationId: DescribeIdentityProviderConfiguration
      summary: Describe Identity Provider Configuration
      description: Returns detailed information on the current IdC setup for the WorkMail organization.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeIdentityProviderConfigurationResponse'
        '400':
          description: InvalidParameterException; OrganizationNotFoundException; OrganizationStateException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkMailService.DescribeIdentityProviderConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeIdentityProviderConfigurationRequest'
      tags:
      - Identity Provider Configuration
  /#PutIdentityProviderConfiguration:
    post:
      operationId: PutIdentityProviderConfiguration
      summary: Put Identity Provider Configuration
      description: Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutIdentityProviderConfigurationResponse'
        '400':
          description: InvalidParameterException; OrganizationNotFoundException; OrganizationStateException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkMailService.PutIdentityProviderConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutIdentityProviderConfigurationRequest'
      tags:
      - Identity Provider Configuration
components:
  schemas:
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    DeleteIdentityProviderConfigurationRequest:
      type: object
      properties:
        OrganizationId:
          type: string
          description: The Organization ID.
      required:
      - OrganizationId
    PutIdentityProviderConfigurationRequest:
      type: object
      properties:
        OrganizationId:
          type: string
          description: The ID of the WorkMail Organization.
        AuthenticationMode:
          type: string
          enum:
          - IDENTITY_PROVIDER_ONLY
          - IDENTITY_PROVIDER_AND_DIRECTORY
          description: The authentication mode used in WorkMail.
        IdentityCenterConfiguration:
          $ref: '#/components/schemas/IdentityCenterConfiguration'
        PersonalAccessTokenConfiguration:
          $ref: '#/components/schemas/PersonalAccessTokenConfiguration'
      required:
      - OrganizationId
      - AuthenticationMode
      - IdentityCenterConfiguration
      - PersonalAccessTokenConfiguration
    PutIdentityProviderConfigurationResponse:
      type: object
      properties: {}
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
    DescribeIdentityProviderConfigurationResponse:
      type: object
      properties:
        AuthenticationMode:
          type: string
          enum:
          - IDENTITY_PROVIDER_ONLY
          - IDENTITY_PROVIDER_AND_DIRECTORY
          description: The authentication mode used in WorkMail.
        IdentityCenterConfiguration:
          $ref: '#/components/schemas/IdentityCenterConfiguration'
        PersonalAccessTokenConfiguration:
          $ref: '#/components/schemas/PersonalAccessTokenConfiguration'
    DescribeIdentityProviderConfigurationRequest:
      type: object
      properties:
        OrganizationId:
          type: string
          description: The Organization ID.
      required:
      - OrganizationId
    IdentityCenterConfiguration:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the of IAM Identity Center instance. Must be in the same AWS account and region as WorkMail organization.
        ApplicationArn:
          type: string
          description: The Amazon Resource Name (ARN) of IAMIdentity Center Application for WorkMail. Must be created by the WorkMail API, see CreateIdentityCenterApplication.
      required:
      - InstanceArn
      - ApplicationArn
    PersonalAccessTokenConfiguration:
      type: object
      properties:
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The status of the Personal Access Token allowed for the organization. Active - Mailbox users can login to the web application and choose Settings to see the new Personal Access Tokens page to create and delete the Personal Access Tokens. Mailbox users can use the Personal Access Tokens to set up mailbox connection from desktop or mobile email clients. Inactive - Personal Access Tokens are disabled for your organization. Mailbox users can’t create, list, or delete Personal Access Tokens and can’t use them to connect to their mailboxes from desktop or mobile email clients.
        LifetimeInDays:
          type: integer
          description: The validity of the Personal Access Token status in days.
      required:
      - Status
    DeleteIdentityProviderConfigurationResponse:
      type: object
      properties: {}
  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: workmail
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/workmail/service/2017-10-01/workmail-2017-10-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)