Create new Role | X4Documentation

Die Operation Create new Role erstellt in Keycloak eine neue Rolle. Die Daten werden in der vom Adapter erwarteten Input-XML definiert.

Input-XML

XML

<?xml version="1.0" encoding="UTF-8"?>
<Role>
	<Name></Name>
	<Description></Description>
	<Composite></Composite>
	<ContainerId></ContainerId>
	<Attributes>
		<Attribute>
			<Name></Name>
			<Values>
				<Value></Value>
			</Values>
		</Attribute>
	</Attributes>
</Role>

Role

Element	Beschreibung	Mögliche Werte
`Role`	Rollendefinition	Das Element enthält folgende Elemente: `Name` `Description` optional `Composite` optional `ContainerId` `Attributes` (optional)
`Name`	Name der Rolle	Beliebiger String
`Description`	Beschreibung der Rolle	Beliebiger String
`Composite`	Angabe, ob die Rolle eine zusammengesetzte Rolle ist	`true`: Die Rolle ist eine zusammengesetzte Rolle. `false`: Die Rolle ist keine zusammengesetzte Rolle. (Standard)
`ContainerId`	Name des Realm	Beliebiger String
`Attributes`	Personalisierte, konfigurierbare Attribute	Das Element enthält folgende Elemente: `Attribute` (Mehrfachdeklaration möglich)

Attributes

Element	Beschreibung
`Attributes`	Personalisierte, konfigurierbare Attribute	Das Element enthält folgende Elemente: `Attribute` (Mehrfachdeklaration möglich)
`Attribute`	Personalisiertes, konfigurierbares Attribut	Das Element enthält folgende Elemente: `Name` `Values`
`Name`	Attributname	Beliebiger String
`Values`	Attributwerte	Das Element enthält folgende Elemente: `Value` (Mehrfachdeklaration möglich)
`Value`	Attributwert	Beliebiger 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="Role">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="Name"/>
        <xs:element ref="Description"/>
        <xs:element ref="Composite"/>
        <xs:element ref="ContainerId"/>
        <xs:element ref="Attributes"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="Description" type="xs:string"/>
  <xs:element name="Composite" type="xs:boolean"/>
  <xs:element name="ContainerId" type="xs:NCName"/>
  <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>

Beispiel

Input

XML

<?xml version="1.0" encoding="UTF-8"?>
<Role>
	<Name>Developer</Name>
	<Description>Software Developer</Description>
	<Composite>false</Composite>
	<ContainerId>exampleRealm</ContainerId>
	<Attributes>
		<Attribute>
			<Name>Team</Name>
			<Values>
				<Value>Blue</Value>
				<Value>Red</Value>
			</Values>
		</Attribute>
	</Attributes>
</Role>