Update Role | X4Documentation

The Update Role operation updates the data of the role with the specified ID. The data is defined in the input XML expected by the adapter.

Input XML

XML

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

Role

Element	Description	Possible values
`Role`	Role definition	The element contains the following elements: `Id` `Name` `Description` (optional) `Composite` (optional) `ClientRole` (optional) `ContainerId` (optional) `Attributes` (optional)
`Id`	UUID of the role	UUID
`Name`	Name of the role	Any string
`Description`	Description of the role	Any string
`Composite`	Specification of whether the role is a composite role	`true`: The role is a composite role. `false`: The role is not a composite role. (Default)
`ClientRole`	Specifies whether the role is a client role. This is basically a role namespace specified for the client.	Any string
`ContainerId`	Name of the Realm	Any string
`Attributes`	Personalized, configurable attributes	The element contains the following elements: `Attribute` (Multiple declaration possible)

Attributes

Element	Description
`Attributes`	Personalized, configurable attributes	The element contains the following elements: `Attribute` (Multiple declaration possible)
`Attribute`	Personalized, configurable attribute	The element contains the following elements: `Name` `Values`
`Name`	Attribute name	Any string
`Values`	Attribute values	The element contains the following elements: `Value` (Multiple declaration possible)
`Value`	Attribute value	Any 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="Id"/>
        <xs:element ref="Name"/>
        <xs:element ref="Description"/>
        <xs:element ref="Composite"/>
        <xs:element ref="ClientRole"/>
        <xs:element ref="ContainerId"/>
        <xs:element ref="Attributes"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="Id" type="xs:string"/>
  <xs:element name="Description" type="xs:string"/>
  <xs:element name="Composite" type="xs:boolean"/>
  <xs:element name="ClientRole" 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>

Example

Input

XML

<?xml version="1.0" encoding="UTF-8"?>
<Role>
	<Id>658242d5-0caf-4ecd-b930-45c02ccf39d4</Id>
	<Name>Developer</Name>
	<Description>Software Developer</Description>
	<Composite>false</Composite>
	<ClientRole>false</ClientRole>
	<ContainerId>X4Realm</ContainerId>
	<Attributes>
		<Attribute>
			<Name>Team</Name>
			<Values>
				<Value>Blue</Value>
				<Value>Red</Value>
			</Values>
		</Attribute>
	</Attributes>
</Role>