Skip to main content
Skip table of contents

Create new Sub-Group

The Create new Group operation creates a new subgroup in Keycloak. The data is defined in the input XML expected by the adapter.

Input XML

XML
<?xml version="1.0" encoding="UTF-8"?>
<ParentGroup>
	<ParentId></ParentId>
	<SubGroup>
		<Name></Name>
		<Attributes>
			<Attribute>
				<Name></Name>
				<Values>
					<Value></Value>
				</Values>
			</Attribute>
		</Attributes>
	</SubGroup>
</ParentGroup>

ParentGroup

ElementDescriptionPossible values
ParentGroup

The element contains the following elements:

  • ParentId
  • SubGroup
ParentIdUUID of the parent groupUUID
SubGroupSubgroup definition

The element contains the following elements:

  • Name
  • Attributes (optional)

SubGroup

ElementDescriptionPossible values
SubGroupSubgroup definition

The element contains the following elements:

  • Name
  • Attributes (optional)
NameName of the subgroupAny string
AttributesPersonalized, configurable attributes

The element contains the following elements:

  • Attribute (Multiple declaration possible)

Attributes

ElementDescription
AttributesPersonalized, configurable attributes

The element contains the following elements:

  • Attribute (Multiple declaration possible)
Attribute

Personalized, configurable attribute

The element contains the following elements:

  • Name
  • Values
NameAttribute nameAny string
Values

Attribute values

The element contains the following elements:

  • Value (Multiple declaration possible)
ValueAttribute valueAny string

XSD

XML
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
	<xs:element name="ParentGroup">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="ParentId"/>
				<xs:element ref="SubGroup"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="ParentId" type="xs:string"/>
	<xs:element name="SubGroup">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Name"/>
				<xs:element ref="Attributes"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Attributes">
		<xs:complexType>
			<xs:sequence>
				<xs:element maxOccurs="unbounded" ref="Attribute"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Attribute">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Name"/>
				<xs:element ref="Values"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Values">
		<xs:complexType>
			<xs:sequence>
				<xs:element maxOccurs="unbounded" ref="Value"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Value" type="xs:string"/>
	<xs:element name="Name" type="xs:string"/>
</xs:schema>

Example

Input

XML
<?xml version="1.0" encoding="UTF-8"?>
<ParentGroup>
    <ParentId>49bf25f9-7878-484e-87da-bebff1550379</ParentId>
    <SubGroup>
        <Name>Developer</Name>
        <Attributes>
            <Attribute>
                <Name>Team</Name>
                <Values>
                    <Value>Red</Value>
                </Values>
            </Attribute>
        </Attributes>
    </SubGroup>
</ParentGroup>
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.