Amazon IAM Identity Center #X Amz Target=SWBExternalService.CreateAccountAssignment API

openapi: 3.2.0
info:
  version: 2020-07-20
  x-release: v4
  title: 'AWS Single Sign-On Admin #X Amz…'
  description: AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across AWS accounts and applications.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    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: sso-admin
  x-aws-signingName: sso
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sso-admin-2020-07-20.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://sso.{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 SSO Admin multi-region endpoint
- url: https://sso.{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 SSO Admin multi-region endpoint
- url: http://sso.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The SSO Admin endpoint for China (Beijing) and China (Ningxia)
- url: https://sso.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The SSO Admin endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=SWBExternalService.CreateAccountAssignment'
paths:
  /#X-Amz-Target=SWBExternalService.CreateAccountAssignment:
    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: CreateAccountAssignment
      description: 'Assigns access to a principal for a specified AWS account using a specified permission set.


        The term principal here refers to a user or group that is defined in IAM Identity Center.


        As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call ProvisionPermissionSet to make these updates.


        After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountAssignmentResponse'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '482':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '485':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '486':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountAssignmentRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.CreateAccountAssignment
      summary: Amazon IAM Identity Center Create Account Assignment
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=SWBExternalService.CreateAccountAssignment'
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    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-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-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  schemas:
    ValidationException: {}
    ResourceNotFoundException: {}
    TargetId:
      type: string
      pattern: \d{12}
      minLength: 12
      maxLength: 12
    UUId:
      type: string
      pattern: \b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b
      minLength: 36
      maxLength: 36
    CreateAccountAssignmentRequest:
      type: object
      required:
      - InstanceArn
      - TargetId
      - TargetType
      - PermissionSetArn
      - PrincipalType
      - PrincipalId
      title: CreateAccountAssignmentRequest
      properties:
        InstanceArn:
          allOf:
          - $ref: '#/components/schemas/InstanceArn'
          - description: The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.
        TargetId:
          allOf:
          - $ref: '#/components/schemas/TargetId'
          - description: TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
        TargetType:
          allOf:
          - $ref: '#/components/schemas/TargetType'
          - description: The entity type for which the assignment will be created.
        PermissionSetArn:
          allOf:
          - $ref: '#/components/schemas/PermissionSetArn'
          - description: The ARN of the permission set that the admin wants to grant the principal access to.
        PrincipalType:
          allOf:
          - $ref: '#/components/schemas/PrincipalType'
          - description: The entity type for which the assignment will be created.
        PrincipalId:
          allOf:
          - $ref: '#/components/schemas/PrincipalId'
          - description: An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.
    PrincipalType:
      type: string
      enum:
      - USER
      - GROUP
    ConflictException: {}
    PermissionSetArn:
      type: string
      pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}
      minLength: 10
      maxLength: 1224
    ThrottlingException: {}
    Date:
      type: string
      format: date-time
    AccountAssignmentOperationStatus:
      type: object
      properties:
        Status:
          allOf:
          - $ref: '#/components/schemas/StatusValues'
          - description: The status of the permission set provisioning process.
        RequestId:
          allOf:
          - $ref: '#/components/schemas/UUId'
          - description: The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
        FailureReason:
          allOf:
          - $ref: '#/components/schemas/Reason'
          - description: The message that contains an error or exception in case of an operation failure.
        TargetId:
          allOf:
          - $ref: '#/components/schemas/TargetId'
          - description: TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
        TargetType:
          allOf:
          - $ref: '#/components/schemas/TargetType'
          - description: The entity type for which the assignment will be created.
        PermissionSetArn:
          allOf:
          - $ref: '#/components/schemas/PermissionSetArn'
          - description: The ARN of the permission set. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.
        PrincipalType:
          allOf:
          - $ref: '#/components/schemas/PrincipalType'
          - description: The entity type for which the assignment will be created.
        PrincipalId:
          allOf:
          - $ref: '#/components/schemas/PrincipalId'
          - description: An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.
        CreatedDate:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The date that the permission set was created.
      description: The status of the creation or deletion operation of an assignment that a principal needs to access an account.
    PrincipalId:
      type: string
      pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$
      minLength: 1
      maxLength: 47
    ServiceQuotaExceededException: {}
    StatusValues:
      type: string
      enum:
      - IN_PROGRESS
      - FAILED
      - SUCCEEDED
    InstanceArn:
      type: string
      pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}
      minLength: 10
      maxLength: 1224
    CreateAccountAssignmentResponse:
      type: object
      properties:
        AccountAssignmentCreationStatus:
          allOf:
          - $ref: '#/components/schemas/AccountAssignmentOperationStatus'
          - description: The status object for the account assignment creation operation.
    Reason:
      type: string
      pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*'
    TargetType:
      type: string
      enum:
      - AWS_ACCOUNT
    AccessDeniedException: {}
    InternalServerException: {}
  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/sso/
x-hasEquivalentPaths: true