openapi: 3.0.0 info: version: 2020-06-15 x-release: v4 title: 'AWS SSO Identity Store #X Amz Target=AWSIdentityStore.CreateGroup #X Amz Target=AWSIdentityStore.CreateGroup #X Amz Target=SWBExternalService.DescribeAccountAssignmentDeletionStatus API' description:
The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
<note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p> </note> <p>This reference guide describes the identity store operations that you can call programatically and includes detailed information about data types and errors.</p>
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: identitystore
x-aws-signingName: identitystore
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/identitystore-2020-06-15.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://identitystore.{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 IdentityStore multi-region endpoint
- url: https://identitystore.{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 IdentityStore multi-region endpoint
- url: http://identitystore.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The IdentityStore endpoint for China (Beijing) and China (Ningxia)
- url: https://identitystore.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The IdentityStore endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=SWBExternalService.DescribeAccountAssignmentDeletionStatus'
paths:
/#X-Amz-Target=SWBExternalService.DescribeAccountAssignmentDeletionStatus:
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: DescribeAccountAssignmentDeletionStatus
description: Describes the status of the assignment deletion request.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAccountAssignmentDeletionStatusResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAccountAssignmentDeletionStatusRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SWBExternalService.DescribeAccountAssignmentDeletionStatus
summary: Amazon IAM Identity Center Describe Account Assignment Deletion Status
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=SWBExternalService.DescribeAccountAssignmentDeletionStatus'
components:
parameters:
X-Amz-Credential:
name: X-Amz-Credential
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
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-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
schemas:
StatusValues:
type: string
enum:
- IN_PROGRESS
- FAILED
- SUCCEEDED
DescribeAccountAssignmentDeletionStatusResponse:
type: object
properties:
AccountAssignmentDeletionStatus:
allOf:
- $ref: '#/components/schemas/AccountAssignmentOperationStatus'
- description: The status object for the account assignment deletion operation.
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
AccessDeniedException: {}
TargetId:
type: string
pattern: \d{12}
minLength: 12
maxLength: 12
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 Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
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 IAM Identity Center Identity Store API Reference.
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.
TargetType:
type: string
enum:
- AWS_ACCOUNT
DescribeAccountAssignmentDeletionStatusRequest:
type: object
required:
- InstanceArn
- AccountAssignmentDeletionRequestId
title: DescribeAccountAssignmentDeletionStatusRequest
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 Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
AccountAssignmentDeletionRequestId:
allOf:
- $ref: '#/components/schemas/UUId'
- description: The identifier that is used to track the request operation progress.
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
ResourceNotFoundException: {}
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
ThrottlingException: {}
Date:
type: string
format: date-time
ValidationException: {}
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
InternalServerException: {}
PrincipalType:
type: string
enum:
- USER
- GROUP
Reason:
type: string
pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*'
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/identitystore/
x-hasEquivalentPaths: true