2.2.4.455 UserRole

  • 2 minutes to read

The UserRole complex type allows extended attributes on a BaseIpamObject type (section 2.2.4.64).

 <xs:complexType name="UserRole">
   <xs:complexContent mixed="false">
     <xs:extension base="ipam:BaseIpamObject">
       <xs:sequence>
         <xs:element minOccurs="0" name="Description" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="IsBuiltinRole" type="xsd:boolean" />
         <xs:element minOccurs="0" name="Name" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="Operations" nillable="true" type="ipam:ArrayOfIpamAdminOperation" />
         <xs:element minOccurs="0" name="UserRoleID" nillable="true" type="xsd:long" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

Description: A string that holds the description of the user role.

IsBuiltinRole: A Boolean that indicates if this instance of UserRole is built in or user input.

Name: A string that corresponds to the name of the user role.

Operations: This is an array of ipam:IpamAdminOperation objects that holds the operations allowed for this instance of UserRole.

UserRoleID: This is a long int that holds the reference in IPAM data store to this instance of the user role.