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=AWSIdentityStore.ListGroupMembershipsForMember 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=AWSIdentityStore.ListGroupMembershipsForMember'
paths:
/#X-Amz-Target=AWSIdentityStore.ListGroupMembershipsForMember:
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: ListGroupMembershipsForMember
description: For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupMembershipsForMemberResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupMembershipsForMemberRequest'
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:
- AWSIdentityStore.ListGroupMembershipsForMember
summary: Amazon IAM Identity Center List Group Memberships for Member
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSIdentityStore.ListGroupMembershipsForMember'
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:
NextToken:
type: string
pattern: '[-a-zA-Z0-9+=/:]*'
minLength: 1
maxLength: 65535
ListGroupMembershipsForMemberResponse:
type: object
required:
- GroupMemberships
properties:
GroupMemberships:
allOf:
- $ref: '#/components/schemas/GroupMemberships'
- description: A list of GroupMembership objects in the group for a specified member.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page. '
MemberId:
type: object
properties:
UserId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: An object containing the identifiers of resources that can be members.
description: An object containing the identifier of a group member.
AccessDeniedException: {}
ListGroupMembershipsForMemberRequest:
type: object
required:
- IdentityStoreId
- MemberId
title: ListGroupMembershipsForMemberRequest
properties:
IdentityStoreId:
allOf:
- $ref: '#/components/schemas/IdentityStoreId'
- description: The globally unique identifier for the identity store.
MemberId:
allOf:
- $ref: '#/components/schemas/MemberId'
- description: An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
GroupMembership:
type: object
required:
- IdentityStoreId
properties:
IdentityStoreId:
allOf:
- $ref: '#/components/schemas/IdentityStoreId'
- description: The globally unique identifier for the identity store.
MembershipId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier for a GroupMembership object in an identity store.
GroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier for a group in the identity store.
MemberId:
allOf:
- $ref: '#/components/schemas/MemberId'
- description: An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
description: Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.
ResourceNotFoundException: {}
GroupMemberships:
type: array
items:
$ref: '#/components/schemas/GroupMembership'
ResourceId:
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
ThrottlingException: {}
ValidationException: {}
MaxResults:
type: integer
minimum: 1
maximum: 100
IdentityStoreId:
type: string
pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
minLength: 1
maxLength: 36
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/identitystore/
x-hasEquivalentPaths: true