Data
- Default Namespace
- XML Schema File: ns0.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
- role-request
- roles-privs-list-filter
- user-changepw
- user-forgotpw
- user-request
- user-search
- user-to-role
The following types are members of this namespace:
- plexusUserSearchCriteriaResource
- plexusUserSearchCriteriaResourceRequest
- roleAndPrivilegeListFilterResource
- roleAndPrivilegeListFilterResourceRequest
- roleResource
- roleResourceRequest
- userChangePasswordRequest
- userChangePasswordResource
- userForgotPasswordRequest
- userForgotPasswordResource
- userResource
- userResourceRequest
- userToRoleResource
- userToRoleResourceRequest
Element role-request
- Type: roleResourceRequest
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<role-request>
<data>
<!--content of type 'roleResource'-->
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
<sessionTimeout>
<!--content of type 'int'-->
...
</sessionTimeout>
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<userManaged>
<!--content of type 'boolean'-->
...
</userManaged>
<description>
<!--content of type 'string'-->
...
</description>
<name>
<!--content of type 'string'-->
...
</name>
<id>
<!--content of type 'string'-->
...
</id>
<privileges>
<!--content of type 'string'-->
...
</privileges>
<privileges>
<!--(another 'string' type)-->
</privileges>
<!--...more "privileges" elements...-->
</data>
</role-request>
Example JSON
{
"data" : {
"roles" : [ "...", ... ],
"sessionTimeout" : ...,
"resourceURI" : "...",
"userManaged" : false,
"description" : "...",
"name" : "...",
"id" : "...",
"privileges" : [ "...", ... ]
}
}
Element roles-privs-list-filter
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<roles-privs-list-filter>
<role-priv-list-filter>
<!--content of type 'roleAndPrivilegeListFilterResource'-->
<selctedRoleIds>
<selectedRoleId>
<!--content of type 'string'-->
...
</selectedRoleId>
<selectedRoleId>
<!--(another 'string' type)-->
</selectedRoleId>
<!--...more "selectedRoleId" elements...-->
</selctedRoleIds>
<onlySelected>
<!--content of type 'boolean'-->
...
</onlySelected>
<hiddenPrivilegeIds>
<hiddenPrivilegeId>
<!--content of type 'string'-->
...
</hiddenPrivilegeId>
<hiddenPrivilegeId>
<!--(another 'string' type)-->
</hiddenPrivilegeId>
<!--...more "hiddenPrivilegeId" elements...-->
</hiddenPrivilegeIds>
<noPrivileges>
<!--content of type 'boolean'-->
...
</noPrivileges>
<name>
<!--content of type 'string'-->
...
</name>
<noRoles>
<!--content of type 'boolean'-->
...
</noRoles>
<selctedPrivilegeIds>
<selectedPrivilegeId>
<!--content of type 'string'-->
...
</selectedPrivilegeId>
<selectedPrivilegeId>
<!--(another 'string' type)-->
</selectedPrivilegeId>
<!--...more "selectedPrivilegeId" elements...-->
</selctedPrivilegeIds>
<noExternalRoles>
<!--content of type 'boolean'-->
...
</noExternalRoles>
<hiddenRoleIds>
<hiddenRoleId>
<!--content of type 'string'-->
...
</hiddenRoleId>
<hiddenRoleId>
<!--(another 'string' type)-->
</hiddenRoleId>
<!--...more "hiddenRoleId" elements...-->
</hiddenRoleIds>
<userId>
<!--content of type 'string'-->
...
</userId>
</role-priv-list-filter>
</roles-privs-list-filter>
Example JSON
{
"role-priv-list-filter" : {
"selctedRoleIds" : [ "...", ... ],
"onlySelected" : false,
"hiddenPrivilegeIds" : [ "...", ... ],
"noPrivileges" : false,
"name" : "...",
"noRoles" : false,
"selctedPrivilegeIds" : [ "...", ... ],
"noExternalRoles" : false,
"hiddenRoleIds" : [ "...", ... ],
"userId" : "..."
}
}
Element user-changepw
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-changepw>
<data>
<!--content of type 'userChangePasswordResource'-->
<oldPassword>
<!--content of type 'string'-->
...
</oldPassword>
<userId>
<!--content of type 'string'-->
...
</userId>
<newPassword>
<!--content of type 'string'-->
...
</newPassword>
</data>
</user-changepw>
Example JSON
{
"data" : {
"oldPassword" : "...",
"userId" : "...",
"newPassword" : "..."
}
}
Element user-forgotpw
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-forgotpw>
<data>
<!--content of type 'userForgotPasswordResource'-->
<userId>
<!--content of type 'string'-->
...
</userId>
<email>
<!--content of type 'string'-->
...
</email>
</data>
</user-forgotpw>
Example JSON
{
"data" : {
"userId" : "...",
"email" : "..."
}
}
Element user-request
- Type: userResourceRequest
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-request>
<data>
<!--content of type 'userResource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<firstName>
<!--content of type 'string'-->
...
</firstName>
<lastName>
<!--content of type 'string'-->
...
</lastName>
<userId>
<!--content of type 'string'-->
...
</userId>
<status>
<!--content of type 'string'-->
...
</status>
<password>
<!--content of type 'string'-->
...
</password>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
<email>
<!--content of type 'string'-->
...
</email>
</data>
</user-request>
Example JSON
{
"data" : {
"resourceURI" : "...",
"firstName" : "...",
"lastName" : "...",
"userId" : "...",
"status" : "...",
"password" : "...",
"roles" : [ "...", ... ],
"email" : "..."
}
}
Element user-search
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-search>
<data>
<!--content of type 'plexusUserSearchCriteriaResource'-->
<effectiveUsers>
<!--content of type 'boolean'-->
...
</effectiveUsers>
<userId>
<!--content of type 'string'-->
...
</userId>
</data>
</user-search>
Example JSON
{
"data" : {
"effectiveUsers" : false,
"userId" : "..."
}
}
Element user-to-role
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-to-role>
<data>
<!--content of type 'userToRoleResource'-->
<source>
<!--content of type 'string'-->
...
</source>
<userId>
<!--content of type 'string'-->
...
</userId>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
</data>
</user-to-role>
Example JSON
{
"data" : {
"source" : "...",
"userId" : "...",
"roles" : [ "...", ... ]
}
}
Type plexusUserSearchCriteriaResource
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
effectiveUsers (boolean) | 1/1 | (no documentation provided) |
userId (string) | 0/1 | (no documentation provided) |
Type plexusUserSearchCriteriaResourceRequest
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (plexusUserSearchCriteriaResource) | 0/1 | (no documentation provided) |
Type roleAndPrivilegeListFilterResource
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
selectedRoleId (string) | 0/unbounded | (no documentation provided) |
onlySelected (boolean) | 1/1 | (no documentation provided) |
hiddenPrivilegeId (string) | 0/unbounded | (no documentation provided) |
noPrivileges (boolean) | 1/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
noRoles (boolean) | 1/1 | (no documentation provided) |
selectedPrivilegeId (string) | 0/unbounded | (no documentation provided) |
noExternalRoles (boolean) | 1/1 | (no documentation provided) |
hiddenRoleId (string) | 0/unbounded | (no documentation provided) |
userId (string) | 0/1 | (no documentation provided) |
Type roleAndPrivilegeListFilterResourceRequest
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
role-priv-list-filter (roleAndPrivilegeListFilterResource) | 0/1 | (no documentation provided) |
Type roleResource
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
role (string) | 0/unbounded | (no documentation provided) |
sessionTimeout (int) | 1/1 | (no documentation provided) |
resourceURI (string) | 0/1 | (no documentation provided) |
userManaged (boolean) | 1/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
id (string) | 0/1 | (no documentation provided) |
privileges (string) | 0/unbounded | (no documentation provided) |
Type roleResourceRequest
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (roleResource) | 0/1 | (no documentation provided) |
Type userChangePasswordRequest
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userChangePasswordResource) | 0/1 | (no documentation provided) |
Type userChangePasswordResource
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
oldPassword (string) | 0/1 | (no documentation provided) |
userId (string) | 0/1 | (no documentation provided) |
newPassword (string) | 0/1 | (no documentation provided) |
Type userForgotPasswordRequest
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userForgotPasswordResource) | 0/1 | (no documentation provided) |
Type userForgotPasswordResource
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
userId (string) | 0/1 | (no documentation provided) |
email (string) | 0/1 | (no documentation provided) |
Type userResource
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
resourceURI (string) | 0/1 | (no documentation provided) |
firstName (string) | 0/1 | (no documentation provided) |
lastName (string) | 0/1 | (no documentation provided) |
userId (string) | 0/1 | (no documentation provided) |
status (string) | 0/1 | (no documentation provided) |
password (string) | 0/1 | (no documentation provided) |
role (string) | 0/unbounded | (no documentation provided) |
email (string) | 0/1 | (no documentation provided) |
Type userResourceRequest
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userResource) | 0/1 | (no documentation provided) |
Type userToRoleResource
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
source (string) | 0/1 | (no documentation provided) |
userId (string) | 0/1 | (no documentation provided) |
role (string) | 0/unbounded | (no documentation provided) |
Type userToRoleResourceRequest
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userToRoleResource) | 0/1 | (no documentation provided) |