Amazon Connect Authentication API

openapi: 3.1.0
info:
  title: Amazon Connect Service Authentication API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 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://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /user/federate/{InstanceId}:
    get:
      operationId: GetFederationToken
      summary: Get Federation Token
      description: 'Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect
        Customer user which corresponds to the IAM credentials that were used to invoke this action. For more information
        about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect
        Customer Administrator Guide. This API doesn''t support root users. If you try to invoke GetFederationToken with root
        credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: ....
        cannot be used for federation with Connect Customer'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFederationTokenResponse'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException; UserNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFederationTokenRequest'
      tags:
      - Authentication
components:
  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: connect
  schemas:
    Credentials:
      type: object
      properties:
        AccessToken:
          type: string
          description: An access token generated for a federated user to access Connect Customer.
        AccessTokenExpiration:
          type: string
          format: date-time
          description: A token generated with an expiration time for the session a user is logged in to Connect Customer.
        RefreshToken:
          type: string
          description: Renews a token generated for a user to access the Connect Customer instance.
        RefreshTokenExpiration:
          type: string
          format: date-time
          description: Renews the expiration timer for a generated token.
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    GetFederationTokenRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
      required:
      - InstanceId
    GetFederationTokenResponse:
      type: object
      properties:
        UserId:
          type: string
          description: The identifier for the user. This can be the ID or the ARN of the user.
        UserArn:
          type: string
          description: The Amazon Resource Name (ARN) of the user.
        Credentials:
          $ref: '#/components/schemas/Credentials'
        SignInUrl:
          type: string
          description: The URL to sign into the user's instance.
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)