Group

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

Access ControlAuthenticationIdentity ManagementSingle Sign-On

Properties

Name Type Description
GroupId object
DisplayName object
ExternalIds object
Description object
IdentityStoreId object
View JSON Schema on GitHub

JSON Schema

identitystore-group-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-identity-center/refs/heads/main/json-schema/identitystore-group-schema.json",
  "title": "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"
  ]
}