Amazon IAM Identity Center Iam Identity Center Application API

openapi: 3.2.0
info:
  title: AWS Single Sign-On Admin Application API
  version: '2020-07-20'
  description: Generated from AWS's published Smithy model for AWS Single Sign-On Admin. 5 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://sso.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Application
paths:
  /#CreateApplication:
    post:
      operationId: CreateApplication
      summary: Create Application
      description: Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider. This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateApplicationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.CreateApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
      tags:
      - Application
  /#DeleteApplication:
    post:
      operationId: DeleteApplication
      summary: Delete Application
      description: Deletes the association with the application. The connected service resource still exists.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteApplicationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.DeleteApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteApplicationRequest'
      tags:
      - Application
  /#DescribeApplication:
    post:
      operationId: DescribeApplication
      summary: Describe Application
      description: Retrieves the details of an application associated with an instance of IAM Identity Center.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeApplicationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.DescribeApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeApplicationRequest'
      tags:
      - Application
  /#ListApplications:
    post:
      operationId: ListApplications
      summary: List Applications
      description: Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListApplicationsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.ListApplications
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListApplicationsRequest'
      tags:
      - Application
  /#UpdateApplication:
    post:
      operationId: UpdateApplication
      summary: Update Application
      description: Updates application properties.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateApplicationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.UpdateApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateApplicationRequest'
      tags:
      - Application
components:
  schemas:
    SignInOptions:
      type: object
      properties:
        Origin:
          type: string
          enum:
          - IDENTITY_CENTER
          - APPLICATION
          description: 'This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values: APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl. IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.'
        ApplicationUrl:
          type: string
          description: The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.
      required:
      - Origin
    UpdateApplicationResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_InvalidKeyUsageException
          - KMS_InvalidStateException
          - KMS_DisabledException
          description: The reason for the validation exception.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_AccessDeniedException
          description: The reason for the access denied exception.
    DeleteApplicationResponse:
      type: object
      properties: {}
    DescribeApplicationRequest:
      type: object
      properties:
        ApplicationArn:
          type: string
          description: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
      required:
      - ApplicationArn
    ListApplicationsRequest:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
        MaxResults:
          type: integer
          description: Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
        NextToken:
          type: string
          description: Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
        Filter:
          $ref: '#/components/schemas/ListApplicationsFilter'
      required:
      - InstanceArn
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_NotFoundException
          description: The reason for the resource not found exception.
    DescribeApplicationResponse:
      type: object
      properties:
        ApplicationArn:
          type: string
          description: Specifies the ARN of the application.
        ApplicationProviderArn:
          type: string
          description: The ARN of the application provider under which the operation will run.
        Name:
          type: string
          description: The application name.
        ApplicationAccount:
          type: string
          description: The account ID.
        InstanceArn:
          type: string
          description: The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
        IdentityStoreArn:
          type: string
          description: The ARN of the identity store that is connected to the instance of IAM Identity Center.
        Status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the application is enabled or disabled.
        PortalOptions:
          $ref: '#/components/schemas/PortalOptions'
        Description:
          type: string
          description: The description of the .
        CreatedDate:
          type: string
          format: date-time
          description: The date the application was created.
        CreatedFrom:
          type: string
          description: The Amazon Web Services Region where the application was created in IAM Identity Center.
    DeleteApplicationRequest:
      type: object
      properties:
        ApplicationArn:
          type: string
          description: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
      required:
      - ApplicationArn
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateApplicationResponse:
      type: object
      properties:
        ApplicationArn:
          type: string
          description: Specifies the ARN of the application.
        InstanceArn:
          type: string
          description: The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
        IdentityStoreArn:
          type: string
          description: The ARN of the identity store that is connected to the instance of IAM Identity Center.
    UpdateApplicationPortalOptions:
      type: object
      properties:
        SignInOptions:
          $ref: '#/components/schemas/SignInOptions'
    PortalOptions:
      type: object
      properties:
        SignInOptions:
          $ref: '#/components/schemas/SignInOptions'
        Visibility:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Indicates whether this application is visible in the access portal.
    ListApplicationsFilter:
      type: object
      properties:
        ApplicationAccount:
          type: string
          description: An Amazon Web Services account ID number that filters the results in the response.
        ApplicationProvider:
          type: string
          description: The ARN of an application provider that can filter the results in the response.
    CreateApplicationRequest:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
        ApplicationProviderArn:
          type: string
          description: The ARN of the application provider under which the operation will run.
        Name:
          type: string
          description: The name of the .
        Description:
          type: string
          description: The description of the .
        PortalOptions:
          $ref: '#/components/schemas/PortalOptions'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Specifies tags to be attached to the application.
        Status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the application is enabled or disabled.
        ClientToken:
          type: string
          description: Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch
      required:
      - InstanceArn
      - ApplicationProviderArn
      - Name
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag.
        Value:
          type: string
          description: The value of the tag.
      required:
      - Key
      - Value
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_ThrottlingException
          description: The reason for the throttling exception.
    ListApplicationsResponse:
      type: object
      properties:
        Applications:
          type: array
          items:
            $ref: '#/components/schemas/Application'
          description: Retrieves all applications associated with the instance.
        NextToken:
          type: string
          description: If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
    UpdateApplicationRequest:
      type: object
      properties:
        ApplicationArn:
          type: string
          description: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
        Name:
          type: string
          description: Specifies the updated name for the application.
        Description:
          type: string
          description: The description of the .
        Status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the application is enabled or disabled.
        PortalOptions:
          $ref: '#/components/schemas/UpdateApplicationPortalOptions'
      required:
      - ApplicationArn
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    Application:
      type: object
      properties:
        ApplicationArn:
          type: string
          description: The ARN of the application.
        ApplicationProviderArn:
          type: string
          description: The ARN of the application provider for this application.
        Name:
          type: string
          description: The name of the application.
        ApplicationAccount:
          type: string
          description: The Amazon Web Services account ID number of the application.
        InstanceArn:
          type: string
          description: The ARN of the instance of IAM Identity Center that is configured with this application.
        IdentityStoreArn:
          type: string
          description: The ARN of the identity store that is connected to the instance of IAM Identity Center.
        Status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The current status of the application in this instance of IAM Identity Center.
        PortalOptions:
          $ref: '#/components/schemas/PortalOptions'
        Description:
          type: string
          description: The description of the application.
        CreatedDate:
          type: string
          format: date-time
          description: The date and time when the application was originally created.
        CreatedFrom:
          type: string
          description: The Amazon Web Services Region where the application was created in IAM Identity Center.
  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: sso
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)