The user entity can be used to control user permissions within the API.

The user definition. Used to relate access permissions and roles against a user identity.

User [Schema]

Name Type Required Description
UserIdentifier xsd:string ( min: 1 max: 250) yes The user identifier. Must exactly match the remote authentication authority user identifier value. Note: user identifiers must be unique.
(list of)
no The list of roles associated with this user definition.
Permissions Link
(list of)
no List of permissions associated with this user instance.
MetaData MetaData no The optional meta data collection.


<?xml version="1.0"?>
<User xmlns:xsi="" xmlns:xsd="">
  <Permissions />
    <Item Name="string">string</Item>
  "User": {
    "UserIdentifier": "string",
    "Roles": {
      "Role": [
    "Permissions": { "Permission": [] },
    "MetaData": {
      "Item": [
          "@Name": "string",
          "#text": "string"