Amazon IAM Identity Center · JSON Structure

Identitystore Group Structure

A group object that contains the metadata and attributes for a specified group.

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

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

Properties

GroupId DisplayName ExternalIds Description IdentityStoreId

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-group-structure.json",
  "name": "Group",
  "description": "A group object that contains the metadata and attributes for a specified group.",
  "type": "object",
  "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 display name value for the group. 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 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 <code>ExternalId</code> 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 specified group."
        }
      ]
    },
    "IdentityStoreId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityStoreId"
        },
        {
          "description": "The globally unique identifier for the identity store."
        }
      ]
    }
  },
  "required": [
    "GroupId",
    "IdentityStoreId"
  ]
}