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> GroupId in an identity store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeGroupResponse'
'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/DescribeGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSIdentityStore.DescribeGroup
summary: Amazon IAM Identity Center Describe Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSIdentityStore.DescribeGroup'
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:
DescribeGroupRequest:
type: object
required:
- IdentityStoreId
- GroupId
title: DescribeGroupRequest
properties:
IdentityStoreId:
allOf:
- $ref: '#/components/schemas/IdentityStoreId'
- description: The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
GroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier for a group in the identity store.
ExternalIdIdentifier:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
minLength: 1
maxLength: 256
format: password
ExternalId:
type: object
required:
- Issuer
- Id
properties:
Issuer:
allOf:
- $ref: '#/components/schemas/ExternalIdIssuer'
- description: The issuer for an external identifier.
Id:
allOf:
- $ref: '#/components/schemas/ExternalIdIdentifier'
- description: The identifier issued to this resource by an external identity provider.
description: The identifier issued to this resource by an external identity provider.
AccessDeniedException: {}
ExternalIds:
type: array
items:
$ref: '#/components/schemas/ExternalId'
minItems: 1
maxItems: 10
ResourceNotFoundException: {}
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
DescribeGroupResponse:
type: object
required:
- GroupId
- IdentityStoreId
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier for a group in the identity store.
DisplayName:
allOf:
- $ref: '#/components/schemas/GroupDisplayName'
- description: The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.
ExternalIds:
allOf:
- $ref: '#/components/schemas/ExternalIds'
- description: A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
Description:
allOf:
- $ref: '#/components/schemas/SensitiveStringType'
- description: A string containing a description of the group.
IdentityStoreId:
allOf:
- $ref: '#/components/schemas/IdentityStoreId'
- description: The globally unique identifier for the identity store.
ExternalIdIssuer:
type: string
pattern: \(\?!\(\?i\)\(arn\|aws\):\)[\p\{L\}\p\{M\}\p\{S\}\p\{N\}\p\{P\}]\+
minLength: 1
maxLength: 100
format: password
SensitiveStringType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+'
minLength: 1
maxLength: 1024
format: password
ThrottlingException: {}
ValidationException: {}
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: {}
GroupDisplayName:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+'
minLength: 1
maxLength: 1024
format: password
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