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.ListAccountAssignments 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.ListAccountAssignments' paths: /#X-Amz-Target=SWBExternalService.ListAccountAssignments: 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: ListAccountAssignments description: Lists the assignee of the specified AWS account with the specified permission set. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAccountAssignmentsResponse' '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/ListAccountAssignmentsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - SWBExternalService.ListAccountAssignments summary: Amazon IAM Identity Center List Account Assignments x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=SWBExternalService.ListAccountAssignments' 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: ListAccountAssignmentsResponse: type: object properties: AccountAssignments: allOf: - $ref: '#/components/schemas/AccountAssignmentList' - description: The list of assignments that match the input AWS account and permission set. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls. AccountAssignment: type: object properties: AccountId: allOf: - $ref: '#/components/schemas/AccountId' - description: The identifier of the AWS account. 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. description:

The assignment that indicates a principal's limited access to a specified AWS account with a specified permission set.

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

Token: type: string pattern: ^[-a-zA-Z0-9+=/_]* maxLength: 2048 AccessDeniedException: {} TargetId: type: string pattern: \d{12} minLength: 12 maxLength: 12 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: {} ValidationException: {} AccountAssignmentList: type: array items: $ref: '#/components/schemas/AccountAssignment' ListAccountAssignmentsRequest: type: object required: - InstanceArn - AccountId - PermissionSetArn title: ListAccountAssignmentsRequest 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. AccountId: allOf: - $ref: '#/components/schemas/TargetId' - description: The identifier of the AWS account from which to list the assignments. PermissionSetArn: allOf: - $ref: '#/components/schemas/PermissionSetArn' - description: The ARN of the permission set from which to list assignments. MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: The maximum number of results to display for the assignment. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls. MaxResults: type: integer minimum: 1 maximum: 100 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 AccountId: type: string pattern: \d{12} minLength: 12 maxLength: 12 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