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:
- assigned-privileges-list
- authentication-login
- external-role-mapping
- external-role-mapping-list
- plexus-roles
- plexus-user
- plexus-user-list
- privilege-list-response
- privilege-status-response
- privilege-type-response
- role-request
- role-response
- roles-list
- roles-privs-list
- roles-privs-list-filter
- role-tree-list
- sec-components-list
- user-changepw
- user-forgotpw
- user-request
- user-response
- user-search
- users-list
- user-to-role
The following types are members of this namespace:
- assignedPrivilegeListResource
- assignedPrivilegeListResourceResponse
- authenticationClientPermissions
- authenticationLoginResource
- authenticationLoginResourceResponse
- clientPermission
- component
- externalRoleMappingListResourceResponse
- externalRoleMappingResourceResponse
- mapping
- parentNode
- plexusComponentListResourceResponse
- plexus-role
- plexusRoleListResourceResponse
- plexusUserListResourceResponse
- plexusUserResource
- plexusUserResourceResponse
- plexusUserSearchCriteriaResource
- plexusUserSearchCriteriaResourceRequest
- privilegeListResourceResponse
- privilegeProperty
- privilegeStatusResource
- privilegeStatusResourceResponse
- privilegeTypePropertyResource
- privilegeTypeResource
- privilegeTypeResourceResponse
- roleAndPrivilegeListFilterResource
- roleAndPrivilegeListFilterResourceRequest
- roleAndPrivilegeListResource
- roleAndPrivilegeListResourceResponse
- roleListResourceResponse
- roleResource
- roleResourceRequest
- roleResourceResponse
- roleTreeResource
- roleTreeResourceResponse
- userChangePasswordRequest
- userChangePasswordResource
- userForgotPasswordRequest
- userForgotPasswordResource
- userListResourceResponse
- userResource
- userResourceRequest
- userResourceResponse
- userToRoleResource
- userToRoleResourceRequest
Element assigned-privileges-list
REST Response object retrieve list of privileges assigned to a user.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<assigned-privileges-list>
<data>
<assigned-privileges-list>
<!--content of type 'assignedPrivilegeListResource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<parents>
<parent>
<!--content of type 'parentNode'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<parents>
<parent>
<!--content of type 'parentNode'-->
<!--(content not shown)-->
</parent>
<parent>
<!--(another 'parentNode' type)-->
</parent>
<!--...more "parent" elements...-->
</parents>
</parent>
<parent>
<!--(another 'parentNode' type)-->
</parent>
<!--...more "parent" elements...-->
</parents>
</assigned-privileges-list>
<assigned-privileges-list>
<!--(another 'assignedPrivilegeListResource' type)-->
</assigned-privileges-list>
<!--...more "assigned-privileges-list" elements...-->
</data>
</assigned-privileges-list>
Example JSON
{
"data" : [ {
"id" : "...",
"name" : "...",
"parents" : [ {
"id" : "...",
"name" : "...",
"parents" : [ {
"..." : ...
}, ... ]
}, ... ]
}, ... ]
}
Element authentication-login
REST Response object to list the privileges a users has.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<authentication-login>
<data>
<!--content of type 'authenticationLoginResource'-->
<clientPermissions>
<!--content of type 'authenticationClientPermissions'-->
<loggedIn>
<!--content of type 'boolean'-->
...
</loggedIn>
<loggedInUsername>
<!--content of type 'string'-->
...
</loggedInUsername>
<loggedInUserSource>
<!--content of type 'string'-->
...
</loggedInUserSource>
<permissions>
<permission>
<!--content of type 'clientPermission'-->
<id>
<!--content of type 'string'-->
...
</id>
<value>
<!--content of type 'int'-->
...
</value>
</permission>
<permission>
<!--(another 'clientPermission' type)-->
</permission>
<!--...more "permission" elements...-->
</permissions>
</clientPermissions>
</data>
</authentication-login>
Example JSON
{
"data" : {
"clientPermissions" : {
"loggedIn" : false,
"loggedInUsername" : "...",
"loggedInUserSource" : "...",
"permissions" : [ {
"id" : "...",
"value" : ...
}, ... ]
}
}
}
Element external-role-mapping
REST Response object to list role mappings. A role mapping maps roles of one security realm to the default one.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<external-role-mapping>
<mapping>
<!--content of type 'mapping'-->
<defaultRole>
<!--content of type 'plexus-role'-->
<roleId>
<!--content of type 'string'-->
...
</roleId>
<name>
<!--content of type 'string'-->
...
</name>
<source>
<!--content of type 'string'-->
...
</source>
</defaultRole>
<mappedRoles>
<plexus-role>
<!--content of type 'plexus-role'-->
<roleId>
<!--content of type 'string'-->
...
</roleId>
<name>
<!--content of type 'string'-->
...
</name>
<source>
<!--content of type 'string'-->
...
</source>
</plexus-role>
<plexus-role>
<!--(another 'plexus-role' type)-->
</plexus-role>
<!--...more "plexus-role" elements...-->
</mappedRoles>
</mapping>
</external-role-mapping>
Example JSON
{
"mapping" : {
"defaultRole" : {
"roleId" : "...",
"name" : "...",
"source" : "..."
},
"mappedRoles" : [ {
"roleId" : "...",
"name" : "...",
"source" : "..."
}, ... ]
}
}
Element external-role-mapping-list
REST Response object to list role mappings. A role mapping maps roles of one security realm to the default one.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<external-role-mapping-list>
<data>
<mapping>
<!--content of type 'mapping'-->
<defaultRole>
<!--content of type 'plexus-role'-->
<roleId>
<!--content of type 'string'-->
...
</roleId>
<name>
<!--content of type 'string'-->
...
</name>
<source>
<!--content of type 'string'-->
...
</source>
</defaultRole>
<mappedRoles>
<plexus-role>
<!--content of type 'plexus-role'-->
<roleId>
<!--content of type 'string'-->
...
</roleId>
<name>
<!--content of type 'string'-->
...
</name>
<source>
<!--content of type 'string'-->
...
</source>
</plexus-role>
<plexus-role>
<!--(another 'plexus-role' type)-->
</plexus-role>
<!--...more "plexus-role" elements...-->
</mappedRoles>
</mapping>
<mapping>
<!--(another 'mapping' type)-->
</mapping>
<!--...more "mapping" elements...-->
</data>
</external-role-mapping-list>
Example JSON
{
"data" : [ {
"defaultRole" : {
"roleId" : "...",
"name" : "...",
"source" : "..."
},
"mappedRoles" : [ {
"roleId" : "...",
"name" : "...",
"source" : "..."
}, ... ]
}, ... ]
}
Element plexus-roles
REST Response object that lists roles.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<plexus-roles>
<data>
<plexus-role>
<!--content of type 'plexus-role'-->
<roleId>
<!--content of type 'string'-->
...
</roleId>
<name>
<!--content of type 'string'-->
...
</name>
<source>
<!--content of type 'string'-->
...
</source>
</plexus-role>
<plexus-role>
<!--(another 'plexus-role' type)-->
</plexus-role>
<!--...more "plexus-role" elements...-->
</data>
</plexus-roles>
Example JSON
{
"data" : [ {
"roleId" : "...",
"name" : "...",
"source" : "..."
}, ... ]
}
Element plexus-user
REST response object containing a user.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<plexus-user>
<data>
<!--content of type 'plexusUserResource'-->
<userId>
<!--content of type 'string'-->
...
</userId>
<source>
<!--content of type 'string'-->
...
</source>
<firstName>
<!--content of type 'string'-->
...
</firstName>
<lastName>
<!--content of type 'string'-->
...
</lastName>
<email>
<!--content of type 'string'-->
...
</email>
<roles>
<plexus-role>
<!--content of type 'plexus-role'-->
<roleId>
<!--content of type 'string'-->
...
</roleId>
<name>
<!--content of type 'string'-->
...
</name>
<source>
<!--content of type 'string'-->
...
</source>
</plexus-role>
<plexus-role>
<!--(another 'plexus-role' type)-->
</plexus-role>
<!--...more "plexus-role" elements...-->
</roles>
</data>
</plexus-user>
Example JSON
{
"data" : {
"userId" : "...",
"source" : "...",
"firstName" : "...",
"lastName" : "...",
"email" : "...",
"roles" : [ {
"roleId" : "...",
"name" : "...",
"source" : "..."
}, ... ]
}
}
Element plexus-user-list
REST Response object that lists users.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<plexus-user-list>
<data>
<plexus-user>
<!--content of type 'plexusUserResource'-->
<userId>
<!--content of type 'string'-->
...
</userId>
<source>
<!--content of type 'string'-->
...
</source>
<firstName>
<!--content of type 'string'-->
...
</firstName>
<lastName>
<!--content of type 'string'-->
...
</lastName>
<email>
<!--content of type 'string'-->
...
</email>
<roles>
<plexus-role>
<!--content of type 'plexus-role'-->
<roleId>
<!--content of type 'string'-->
...
</roleId>
<name>
<!--content of type 'string'-->
...
</name>
<source>
<!--content of type 'string'-->
...
</source>
</plexus-role>
<plexus-role>
<!--(another 'plexus-role' type)-->
</plexus-role>
<!--...more "plexus-role" elements...-->
</roles>
</plexus-user>
<plexus-user>
<!--(another 'plexusUserResource' type)-->
</plexus-user>
<!--...more "plexus-user" elements...-->
</data>
</plexus-user-list>
Example JSON
{
"data" : [ {
"userId" : "...",
"source" : "...",
"firstName" : "...",
"lastName" : "...",
"email" : "...",
"roles" : [ {
"roleId" : "...",
"name" : "...",
"source" : "..."
}, ... ]
}, ... ]
}
Element privilege-list-response
REST Response object to list privileges.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<privilege-list-response>
<data>
<privilege-item>
<!--content of type 'privilegeStatusResource'-->
<id>
<!--content of type 'string'-->
...
</id>
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<name>
<!--content of type 'string'-->
...
</name>
<description>
<!--content of type 'string'-->
...
</description>
<type>
<!--content of type 'string'-->
...
</type>
<userManaged>
<!--content of type 'boolean'-->
...
</userManaged>
<properties>
<privilege-property>
<!--content of type 'privilegeProperty'-->
<key>
<!--content of type 'string'-->
...
</key>
<value>
<!--content of type 'string'-->
...
</value>
</privilege-property>
<privilege-property>
<!--(another 'privilegeProperty' type)-->
</privilege-property>
<!--...more "privilege-property" elements...-->
</properties>
</privilege-item>
<privilege-item>
<!--(another 'privilegeStatusResource' type)-->
</privilege-item>
<!--...more "privilege-item" elements...-->
</data>
</privilege-list-response>
Example JSON
{
"data" : [ {
"id" : "...",
"resourceURI" : "...",
"name" : "...",
"description" : "...",
"type" : "...",
"userManaged" : false,
"properties" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}, ... ]
}
Element privilege-status-response
REST response object containing a privilege.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<privilege-status-response>
<data>
<!--content of type 'privilegeStatusResource'-->
<id>
<!--content of type 'string'-->
...
</id>
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<name>
<!--content of type 'string'-->
...
</name>
<description>
<!--content of type 'string'-->
...
</description>
<type>
<!--content of type 'string'-->
...
</type>
<userManaged>
<!--content of type 'boolean'-->
...
</userManaged>
<properties>
<privilege-property>
<!--content of type 'privilegeProperty'-->
<key>
<!--content of type 'string'-->
...
</key>
<value>
<!--content of type 'string'-->
...
</value>
</privilege-property>
<privilege-property>
<!--(another 'privilegeProperty' type)-->
</privilege-property>
<!--...more "privilege-property" elements...-->
</properties>
</data>
</privilege-status-response>
Example JSON
{
"data" : {
"id" : "...",
"resourceURI" : "...",
"name" : "...",
"description" : "...",
"type" : "...",
"userManaged" : false,
"properties" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
}
Element privilege-type-response
REST Request object to lists the types of privilege in the system.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<privilege-type-response>
<data>
<privilege-type>
<!--content of type 'privilegeTypeResource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<properties>
<privilege-type-property>
<!--content of type 'privilegeTypePropertyResource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<helpText>
<!--content of type 'string'-->
...
</helpText>
<type>
<!--content of type 'string'-->
...
</type>
</privilege-type-property>
<privilege-type-property>
<!--(another 'privilegeTypePropertyResource' type)-->
</privilege-type-property>
<!--...more "privilege-type-property" elements...-->
</properties>
</privilege-type>
<privilege-type>
<!--(another 'privilegeTypeResource' type)-->
</privilege-type>
<!--...more "privilege-type" elements...-->
</data>
</privilege-type-response>
Example JSON
{
"data" : [ {
"id" : "...",
"name" : "...",
"properties" : [ {
"id" : "...",
"name" : "...",
"helpText" : "...",
"type" : "..."
}, ... ]
}, ... ]
}
Element role-request
- Type: roleResourceRequest
REST Request object to persist a role.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<role-request>
<data>
<!--content of type 'roleResource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<description>
<!--content of type 'string'-->
...
</description>
<sessionTimeout>
<!--content of type 'int'-->
...
</sessionTimeout>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
<privileges>
<!--content of type 'string'-->
...
</privileges>
<privileges>
<!--(another 'string' type)-->
</privileges>
<!--...more "privileges" elements...-->
<userManaged>
<!--content of type 'boolean'-->
...
</userManaged>
</data>
</role-request>
Example JSON
{
"data" : {
"resourceURI" : "...",
"id" : "...",
"name" : "...",
"description" : "...",
"sessionTimeout" : ...,
"roles" : [ "...", ... ],
"privileges" : [ "...", ... ],
"userManaged" : false
}
}
Element role-response
- Type: roleResourceResponse
REST Response object for role request.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<role-response>
<data>
<!--content of type 'roleResource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<description>
<!--content of type 'string'-->
...
</description>
<sessionTimeout>
<!--content of type 'int'-->
...
</sessionTimeout>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
<privileges>
<!--content of type 'string'-->
...
</privileges>
<privileges>
<!--(another 'string' type)-->
</privileges>
<!--...more "privileges" elements...-->
<userManaged>
<!--content of type 'boolean'-->
...
</userManaged>
</data>
</role-response>
Example JSON
{
"data" : {
"resourceURI" : "...",
"id" : "...",
"name" : "...",
"description" : "...",
"sessionTimeout" : ...,
"roles" : [ "...", ... ],
"privileges" : [ "...", ... ],
"userManaged" : false
}
}
Element roles-list
- Type: roleListResourceResponse
REST Response object for a role list request.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<roles-list>
<data>
<roles-list-item>
<!--content of type 'roleResource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<description>
<!--content of type 'string'-->
...
</description>
<sessionTimeout>
<!--content of type 'int'-->
...
</sessionTimeout>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
<privileges>
<!--content of type 'string'-->
...
</privileges>
<privileges>
<!--(another 'string' type)-->
</privileges>
<!--...more "privileges" elements...-->
<userManaged>
<!--content of type 'boolean'-->
...
</userManaged>
</roles-list-item>
<roles-list-item>
<!--(another 'roleResource' type)-->
</roles-list-item>
<!--...more "roles-list-item" elements...-->
</data>
</roles-list>
Example JSON
{
"data" : [ {
"resourceURI" : "...",
"id" : "...",
"name" : "...",
"description" : "...",
"sessionTimeout" : ...,
"roles" : [ "...", ... ],
"privileges" : [ "...", ... ],
"userManaged" : false
}, ... ]
}
Element roles-privs-list
REST Response object to list roles and privileges using pagination.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<roles-privs-list>
<data>
<role-priv>
<!--content of type 'roleAndPrivilegeListResource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<description>
<!--content of type 'string'-->
...
</description>
<type>
<!--content of type 'string'-->
...
</type>
<external>
<!--content of type 'boolean'-->
...
</external>
</role-priv>
<role-priv>
<!--(another 'roleAndPrivilegeListResource' type)-->
</role-priv>
<!--...more "role-priv" elements...-->
</data>
<totalCount>
<!--content of type 'int'-->
...
</totalCount>
</roles-privs-list>
Example JSON
{
"data" : [ {
"id" : "...",
"name" : "...",
"description" : "...",
"type" : "...",
"external" : false
}, ... ],
"totalCount" : ...
}
Element roles-privs-list-filter
REST Request object to filter the list roles and privileges using pagination.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<roles-privs-list-filter>
<role-priv-list-filter>
<!--content of type 'roleAndPrivilegeListFilterResource'-->
<name>
<!--content of type 'string'-->
...
</name>
<noPrivileges>
<!--content of type 'boolean'-->
...
</noPrivileges>
<noRoles>
<!--content of type 'boolean'-->
...
</noRoles>
<onlySelected>
<!--content of type 'boolean'-->
...
</onlySelected>
<noExternalRoles>
<!--content of type 'boolean'-->
...
</noExternalRoles>
<selctedRoleIds>
<selectedRoleId>
<!--content of type 'string'-->
...
</selectedRoleId>
<selectedRoleId>
<!--(another 'string' type)-->
</selectedRoleId>
<!--...more "selectedRoleId" elements...-->
</selctedRoleIds>
<selctedPrivilegeIds>
<selectedPrivilegeId>
<!--content of type 'string'-->
...
</selectedPrivilegeId>
<selectedPrivilegeId>
<!--(another 'string' type)-->
</selectedPrivilegeId>
<!--...more "selectedPrivilegeId" elements...-->
</selctedPrivilegeIds>
<hiddenRoleIds>
<hiddenRoleId>
<!--content of type 'string'-->
...
</hiddenRoleId>
<hiddenRoleId>
<!--(another 'string' type)-->
</hiddenRoleId>
<!--...more "hiddenRoleId" elements...-->
</hiddenRoleIds>
<hiddenPrivilegeIds>
<hiddenPrivilegeId>
<!--content of type 'string'-->
...
</hiddenPrivilegeId>
<hiddenPrivilegeId>
<!--(another 'string' type)-->
</hiddenPrivilegeId>
<!--...more "hiddenPrivilegeId" elements...-->
</hiddenPrivilegeIds>
<userId>
<!--content of type 'string'-->
...
</userId>
</role-priv-list-filter>
</roles-privs-list-filter>
Example JSON
{
"role-priv-list-filter" : {
"name" : "...",
"noPrivileges" : false,
"noRoles" : false,
"onlySelected" : false,
"noExternalRoles" : false,
"selctedRoleIds" : [ "...", ... ],
"selctedPrivilegeIds" : [ "...", ... ],
"hiddenRoleIds" : [ "...", ... ],
"hiddenPrivilegeIds" : [ "...", ... ],
"userId" : "..."
}
}
Element role-tree-list
- Type: roleTreeResourceResponse
REST Response object retrieve the tree of roles/privs assigned to a user.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<role-tree-list>
<data>
<assigned-privileges-list>
<!--content of type 'roleTreeResource'-->
<id>
<!--content of type 'string'-->
...
</id>
<name>
<!--content of type 'string'-->
...
</name>
<type>
<!--content of type 'string'-->
...
</type>
<children>
<child>
<!--content of type 'roleTreeResource'-->
<!--(content not shown)-->
</child>
<child>
<!--(another 'roleTreeResource' type)-->
</child>
<!--...more "child" elements...-->
</children>
</assigned-privileges-list>
<assigned-privileges-list>
<!--(another 'roleTreeResource' type)-->
</assigned-privileges-list>
<!--...more "assigned-privileges-list" elements...-->
</data>
</role-tree-list>
Example JSON
{
"data" : [ {
"id" : "...",
"name" : "...",
"type" : "...",
"children" : [ {
"..." : ...
}, ... ]
}, ... ]
}
Element sec-components-list
REST Response object to list components.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<sec-components-list>
<data>
<component>
<!--content of type 'component'-->
<roleHint>
<!--content of type 'string'-->
...
</roleHint>
<description>
<!--content of type 'string'-->
...
</description>
</component>
<component>
<!--(another 'component' type)-->
</component>
<!--...more "component" elements...-->
</data>
</sec-components-list>
Example JSON
{
"data" : [ {
"roleHint" : "...",
"description" : "..."
}, ... ]
}
Element user-changepw
REST Request to change a user's password.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-changepw>
<data>
<!--content of type 'userChangePasswordResource'-->
<userId>
<!--content of type 'string'-->
...
</userId>
<oldPassword>
<!--content of type 'string'-->
...
</oldPassword>
<newPassword>
<!--content of type 'string'-->
...
</newPassword>
</data>
</user-changepw>
Example JSON
{
"data" : {
"userId" : "...",
"oldPassword" : "...",
"newPassword" : "..."
}
}
Element user-forgotpw
REST Request to reset a user's password.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-forgotpw>
<data>
<!--content of type 'userForgotPasswordResource'-->
<email>
<!--content of type 'string'-->
...
</email>
<userId>
<!--content of type 'string'-->
...
</userId>
</data>
</user-forgotpw>
Example JSON
{
"data" : {
"email" : "...",
"userId" : "..."
}
}
Element user-request
- Type: userResourceRequest
REST request object to persist a user.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-request>
<data>
<!--content of type 'userResource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<userId>
<!--content of type 'string'-->
...
</userId>
<password>
<!--content of type 'string'-->
...
</password>
<firstName>
<!--content of type 'string'-->
...
</firstName>
<lastName>
<!--content of type 'string'-->
...
</lastName>
<status>
<!--content of type 'string'-->
...
</status>
<email>
<!--content of type 'string'-->
...
</email>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
</data>
</user-request>
Example JSON
{
"data" : {
"resourceURI" : "...",
"userId" : "...",
"password" : "...",
"firstName" : "...",
"lastName" : "...",
"status" : "...",
"email" : "...",
"roles" : [ "...", ... ]
}
}
Element user-response
- Type: userResourceResponse
REST response object containing a user.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-response>
<data>
<!--content of type 'userResource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<userId>
<!--content of type 'string'-->
...
</userId>
<password>
<!--content of type 'string'-->
...
</password>
<firstName>
<!--content of type 'string'-->
...
</firstName>
<lastName>
<!--content of type 'string'-->
...
</lastName>
<status>
<!--content of type 'string'-->
...
</status>
<email>
<!--content of type 'string'-->
...
</email>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
</data>
</user-response>
Example JSON
{
"data" : {
"resourceURI" : "...",
"userId" : "...",
"password" : "...",
"firstName" : "...",
"lastName" : "...",
"status" : "...",
"email" : "...",
"roles" : [ "...", ... ]
}
}
Element user-search
REST Request object to search for users based on criteria.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-search>
<data>
<!--content of type 'plexusUserSearchCriteriaResource'-->
<userId>
<!--content of type 'string'-->
...
</userId>
<effectiveUsers>
<!--content of type 'boolean'-->
...
</effectiveUsers>
</data>
</user-search>
Example JSON
{
"data" : {
"userId" : "...",
"effectiveUsers" : false
}
}
Element users-list
- Type: userListResourceResponse
REST Response object that lists users.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<users-list>
<data>
<users-list-item>
<!--content of type 'userResource'-->
<resourceURI>
<!--content of type 'string'-->
...
</resourceURI>
<userId>
<!--content of type 'string'-->
...
</userId>
<password>
<!--content of type 'string'-->
...
</password>
<firstName>
<!--content of type 'string'-->
...
</firstName>
<lastName>
<!--content of type 'string'-->
...
</lastName>
<status>
<!--content of type 'string'-->
...
</status>
<email>
<!--content of type 'string'-->
...
</email>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
</users-list-item>
<users-list-item>
<!--(another 'userResource' type)-->
</users-list-item>
<!--...more "users-list-item" elements...-->
</data>
</users-list>
Example JSON
{
"data" : [ {
"resourceURI" : "...",
"userId" : "...",
"password" : "...",
"firstName" : "...",
"lastName" : "...",
"status" : "...",
"email" : "...",
"roles" : [ "...", ... ]
}, ... ]
}
Element user-to-role
REST Request object to assign a roles to a user. Typically used when assigning roles to a user NOT managed by this system.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<user-to-role>
<data>
<!--content of type 'userToRoleResource'-->
<userId>
<!--content of type 'string'-->
...
</userId>
<source>
<!--content of type 'string'-->
...
</source>
<roles>
<role>
<!--content of type 'string'-->
...
</role>
<role>
<!--(another 'string' type)-->
</role>
<!--...more "role" elements...-->
</roles>
</data>
</user-to-role>
Example JSON
{
"data" : {
"userId" : "...",
"source" : "...",
"roles" : [ "...", ... ]
}
}
Type assignedPrivilegeListResource
A privilege object, that contains details about the privilege, as well as a tree showing how this privilege is assigned to the user through roles.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the privilege. |
name (string) | 0/1 | The name of the privilege. |
parent (parentNode) | 0/unbounded | Field parents. |
Type assignedPrivilegeListResourceResponse
REST Response object retrieve list of privileges assigned to a user.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
assigned-privileges-list (assignedPrivilegeListResource) | 0/unbounded | Field data. |
Type authenticationClientPermissions
Login details info.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
loggedIn (boolean) | 1/1 | Flags if a user is logged in. |
loggedInUsername (string) | 0/1 | The logged in user's id. |
loggedInUserSource (string) | 0/1 | The logged in user's source. |
permission (clientPermission) | 0/unbounded | Field permissions. |
Type authenticationLoginResource
Wrapper around login details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
clientPermissions (authenticationClientPermissions) | 0/1 | Login details info. |
Type authenticationLoginResourceResponse
REST Response object to list the privileges a users has.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (authenticationLoginResource) | 0/1 | Login details. |
Type clientPermission
Permission details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | Id of the permission. |
value (int) | 1/1 | Privilege value: NONE = 0, READ = 1, UPDATE = 2, DELETE = 4, CREATE = 8, or you can OR them together. |
Type component
Details of a component used by the system.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
roleHint (string) | 0/1 | The hint of the component. |
description (string) | 0/1 | The description of the component. |
Type externalRoleMappingListResourceResponse
REST Response object to list role mappings. A role mapping maps roles of one security realm to the default one.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
mapping (mapping) | 0/unbounded | Field data. |
Type externalRoleMappingResourceResponse
REST Response object to list role mappings. A role mapping maps roles of one security realm to the default one.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
mapping (mapping) | 0/1 | The role mappings. |
Type mapping
A role mapping maps roles of one security realm to the default one.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
defaultRole (plexus-role) | 0/1 | The systems's role. |
plexus-role (plexus-role) | 0/unbounded | Field mappedRoles. |
Type parentNode
A parent of a role or privilege.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the privilege or role. |
name (string) | 0/1 | The name of the privilege or role. |
parent (parentNode) | 0/unbounded | Field parents. |
Type plexusComponentListResourceResponse
REST Response object to list components.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
component (component) | 0/unbounded | Field data. |
Type plexus-role
Details of a security role. A roles uniqueness is made up of an id and a source (where the role came from).
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
roleId (string) | 0/1 | The id of the role. |
name (string) | 0/1 | Field name. |
source (string) | 0/1 | The source id of the role. Defines what source the role came from. |
Type plexusRoleListResourceResponse
REST Response object that lists roles.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
plexus-role (plexus-role) | 0/unbounded | Field data. |
Type plexusUserListResourceResponse
REST Response object that lists users.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
plexus-user (plexusUserResource) | 0/unbounded | Field data. |
Type plexusUserResource
User's details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
userId (string) | 0/1 | The id of the user. |
source (string) | 0/1 | The source of the role, i.e. what realm the user belongs to. |
firstName (string) | 0/1 | The first name of the user. |
lastName (string) | 0/1 | The last name of the user. |
email (string) | 0/1 | The email address of the user. |
plexus-role (plexus-role) | 0/unbounded | Field roles. |
Type plexusUserResourceResponse
REST response object containing a user.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (plexusUserResource) | 0/1 | User's details. |
Type plexusUserSearchCriteriaResource
User search criteria details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
userId (string) | 0/1 | Partial user Id to search for. Uses 'starts with' search. So 'jcod' will match 'jcoder' but not 'cjcoder'. |
effectiveUsers (boolean) | 1/1 | An effective user is one that can login to the system. |
Type plexusUserSearchCriteriaResourceRequest
REST Request object to search for users based on criteria.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (plexusUserSearchCriteriaResource) | 0/1 | Search criteria. |
Type privilegeListResourceResponse
REST Response object to list privileges.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
privilege-item (privilegeStatusResource) | 0/unbounded | Field data. |
Type privilegeProperty
Key value pair.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
key (string) | 0/1 | The key of the property. |
value (string) | 0/1 | The value of the property. |
Type privilegeStatusResource
Privilege details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the privilege. |
resourceURI (string) | 0/1 | The URI of the privilege. |
name (string) | 0/1 | The name of the privilege. |
description (string) | 0/1 | The description of the privilege. |
type (string) | 0/1 | The type of the privilege. |
userManaged (boolean) | 1/1 | Flag that defines if a privilege can update this role (read-only). |
privilege-property (privilegeProperty) | 0/unbounded | Field properties. |
Type privilegeStatusResourceResponse
REST response object containing a privilege.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (privilegeStatusResource) | 0/1 | Privilege details. |
Type privilegeTypePropertyResource
Privilege property details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the privilege property. |
name (string) | 0/1 | The name of the privilege property. |
helpText (string) | 0/1 | The help text of the privilege property. |
type (string) | 0/1 | The type of the privilege property. |
Type privilegeTypeResource
Privilege type details. Used to dynamically define types of privileges.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the privilege type. |
name (string) | 0/1 | The name of the privilege type. |
privilege-type-property (privilegeTypePropertyResource) | 0/unbounded | Field properties. |
Type privilegeTypeResourceResponse
REST Request object to lists the types of privilege in the system.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
privilege-type (privilegeTypeResource) | 0/unbounded | Field data. |
Type roleAndPrivilegeListFilterResource
A filter object, that will filter the results of the request.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 0/1 | Filter to be applied to the name of the results. |
noPrivileges (boolean) | 1/1 | If true, privileges will be left out of results. |
noRoles (boolean) | 1/1 | If true, roles will be left out of results. |
onlySelected (boolean) | 1/1 | If true, only selected results will be returned. |
noExternalRoles (boolean) | 1/1 | If true, external roles will be left out of results. |
selectedRoleId (string) | 0/unbounded | Field selectedRoleIds. |
selectedPrivilegeId (string) | 0/unbounded | Field selectedPrivilegeIds. |
hiddenRoleId (string) | 0/unbounded | Field hiddenRoleIds. |
hiddenPrivilegeId (string) | 0/unbounded | Field hiddenPrivilegeIds. |
userId (string) | 0/1 | If defined, results returned will also contain any roles that are from external sources assigned to this user. |
Type roleAndPrivilegeListFilterResourceRequest
REST Request object to filter the list roles and privileges using pagination.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
role-priv-list-filter (roleAndPrivilegeListFilterResource) | 0/1 | Filter details. |
Type roleAndPrivilegeListResource
A paginated list of roles and privileges. Sorted alphabetically with roles listed before privileges.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the role or privilege. |
name (string) | 0/1 | The name of the role or privilege. |
description (string) | 0/1 | The description of the role or privilege. |
type (string) | 0/1 | Type of item, 'role' or 'privilege'. |
external (boolean) | 1/1 | Flag that, if true, states this role is external (not from default security realm). |
Type roleAndPrivilegeListResourceResponse
REST Response object to list roles and privileges using pagination.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
role-priv (roleAndPrivilegeListResource) | 0/unbounded | Field data. |
totalCount (int) | 1/1 | Total count of roles and privileges in the system. |
Type roleListResourceResponse
REST Response object for a role list request.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
roles-list-item (roleResource) | 0/unbounded | Field data. |
Type roleResource
Role configuration.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
resourceURI (string) | 0/1 | The URI of the role. |
id (string) | 0/1 | The id of the role. |
name (string) | 0/1 | The name of the role. |
description (string) | 0/1 | The description of the role. |
sessionTimeout (int) | 1/1 | The sessionTimeout of the role (legacy, actual value not used). |
role (string) | 0/unbounded | Field roles. |
privileges (string) | 0/unbounded | Field privileges. |
userManaged (boolean) | 1/1 | Flag that defines if a user can update this role (read-only). |
Type roleResourceRequest
REST Request object to persist a role.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (roleResource) | 0/1 | Role to persist. |
Type roleResourceResponse
REST Response object for role request.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (roleResource) | 0/1 | Role returned. |
Type roleTreeResource
A node in a users tree of roles.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
id (string) | 0/1 | The id of the privilege or role. |
name (string) | 0/1 | The name of the privilege or role. |
type (string) | 0/1 | The type of the item, privilege or role. |
child (roleTreeResource) | 0/unbounded | Field children. |
Type roleTreeResourceResponse
REST Response object retrieve the tree of roles/privs assigned to a user.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
assigned-privileges-list (roleTreeResource) | 0/unbounded | Field data. |
Type userChangePasswordRequest
REST Request to change a user's password.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userChangePasswordResource) | 0/1 | Details needed to change a users's password. |
Type userChangePasswordResource
Details needed to change a users's password.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
userId (string) | 0/1 | User's id. |
oldPassword (string) | 0/1 | User's old password. |
newPassword (string) | 0/1 | User's new password. |
Type userForgotPasswordRequest
REST Request to reset a user's password.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userForgotPasswordResource) | 0/1 | Details needed to reset a users's password. |
Type userForgotPasswordResource
Details needed to reset a users's password.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
email (string) | 0/1 | User's email address. |
userId (string) | 0/1 | User's id. |
Type userListResourceResponse
REST Response object that lists users.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
users-list-item (userResource) | 0/unbounded | Field data. |
Type userResource
User's details.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
resourceURI (string) | 0/1 | The URI of the user. |
userId (string) | 0/1 | The id of the user. |
password (string) | 0/1 | The password of the user (write only). |
firstName (string) | 0/1 | The first name of the user. |
lastName (string) | 0/1 | The last name of the user. |
status (string) | 0/1 | The status of the user. Available status: active, locked, disabled. |
email (string) | 0/1 | The email address of the user. |
role (string) | 0/unbounded | Field roles. |
Type userResourceRequest
REST request object to persist a user.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userResource) | 0/1 | User information. |
Type userResourceResponse
REST response object containing a user.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userResource) | 0/1 | User information. |
Type userToRoleResource
Details to assign roles to a users.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
userId (string) | 0/1 | The id of the user. |
source (string) | 0/1 | The source of the user. |
role (string) | 0/unbounded | Field roles. |
Type userToRoleResourceRequest
REST Request object to assign a roles to a user. Typically used when assigning roles to a user NOT managed by this system.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (userToRoleResource) | 0/1 | Details of request. |