Amazon IAM Identity Center · JSON Structure

Identitystore Describe Group Request Structure

DescribeGroupRequest schema from AWS IAM Identity Center

Type: object Properties: 2 Required: 2
Access ControlAuthenticationIdentity ManagementSingle Sign-On

DescribeGroupRequest is a JSON Structure definition published by Amazon IAM Identity Center, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

IdentityStoreId GroupId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-identity-center/refs/heads/main/json-structure/identitystore-describe-group-request-structure.json",
  "name": "DescribeGroupRequest",
  "description": "DescribeGroupRequest schema from AWS IAM Identity Center",
  "type": "object",
  "properties": {
    "IdentityStoreId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityStoreId"
        },
        {
          "description": "The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> 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."
        }
      ]
    }
  },
  "required": [
    "IdentityStoreId",
    "GroupId"
  ]
}