IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/user[?userID={string}][&userName={string}][&includeInternalMemberships={boolean}][&parts={string}][&refreshUser={boolean}]
| Name | Value Type | Description |
|---|---|---|
| userID | string | A value representing the userID of the desired user.
|
| userName | string | A value representing the userName of the desired user.
|
| includeInternalMemberships | boolean | If true, includes in the returned list of memberships the internal group membership names that the user belongs to. Defaults to true.
|
| parts | string | A string indicating which parts of the response data should be returned. Valid values are "memberships", "all" (the default), or "none".
|
| refreshUser | boolean | Refreshes fullname and group memberships of users before retriving them. Only members of the group, that are referred by the action policy "ACTION_REFRESH_USER", can use this function.
|
None
The default content type is application/json.
{ "description": "User",
"type": "object",
"properties":
{
"userID": {"type": "integer",
"description": "The user ID of the user that is described by this object."
},
"userName": {"type": "string",
"description": "The user name of the user that is described by this object.",
},
"fullName": {"type": "string",
"description": "The full name of the user that is described by this object.",
},
"isDisabled": {"type": "boolean",
"description": "States whether this user is disabled. This field is set to false and cannot be changed."
},
"primaryGroup": {"type": "string",
"description": "The primary group associated with this user."
},
"emailAddress": {"type": "string",
"description": "The email address associated with this user."
},
"userPreferences":
[
{ "key" : { "type": "string",
"description": "The key associated with the user preference."
},
"value" : { "type": "string",
"description": "They value associated with the user preference."
}
}
],
"memberships": {"type": "[string]",
"description": "List of groups in which the user is a member."
}
}
}
{
"status":"200",
"data":{
"userID":1,
"userName":"tw_admin",
"fullName":"Internal TW Admin user",
"isDisabled":false,
"primaryGroup":null,
"emailAddress":null,
"userPreferences":{
"Locale":"en"
},
"tasksCollaboration":["75"],
"memberships":[
"Debug",
"tw_admins",
"tw_authors",
"tw_portal_admins",
"tw_process_owners",
"tw_allusers",
"All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
"All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
"All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f",
"Process Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
"Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
"All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
"All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
"Process Owner_S_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
"Managers_S_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
"All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.64bbda3f-b456-486a-9679-87d81c4366dd",
"Process Owner_S_9a9f919e-6644-4592-b900-3eaa46838454.64bbda3f-b456-486a-9679-87d81c4366dd",
"Managers_S_eca3397d-df4d-4ea6-a74e-22aaef303e3c.64bbda3f-b456-486a-9679-87d81c4366dd",
"HRManagers_T_6615a4b0-fd38-4ea5-8bc0-69d2f107369e.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"HiringManagers_T_cd97937f-06ab-43cc-8067-17dea489fdb3.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"GeneralManagers_T_eb30156e-52c8-4ec5-9be6-02290d02f827.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"HiringManagers_S_cd97937f-06ab-43cc-8067-17dea489fdb3.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"GeneralManagers_S_eb30156e-52c8-4ec5-9be6-02290d02f827.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"HRManagers_S_6615a4b0-fd38-4ea5-8bc0-69d2f107369e.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"HRManagers_T_129c442a-75a1-4a7f-b7df-53d2c8909981.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"GeneralManagers_T_ab886e73-e2ec-4cf4-94a7-0c8dff105001.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"HiringManagers_T_e6497638-1592-4d72-b976-2c8579ada550.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"GeneralManagers_S_ab886e73-e2ec-4cf4-94a7-0c8dff105001.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"HRManagers_S_129c442a-75a1-4a7f-b7df-53d2c8909981.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"HiringManagers_S_e6497638-1592-4d72-b976-2c8579ada550.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"Process Owner_T_7a742398-8ba3-4347-a60f-b21d15ea6bc0.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7",
"Managers_T_f319047c-8955-48a1-a6a9-f52d9eaf6f88.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7",
"All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7",
"All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7",
"Managers_S_f319047c-8955-48a1-a6a9-f52d9eaf6f88.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7",
"Process Owner_S_7a742398-8ba3-4347-a60f-b21d15ea6bc0.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7"
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/usergroup"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/usergroup"
xmlns:data="http://rest.bpm.ibm.com/v1/data/root"
xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common">
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" />
<import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common" />
<!--
This type represents a user that has been defined to the IBM BPM installation.
-->
<complexType name="User">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The numeric ID of the user -->
<element name="userID" type="long" />
<!-- The alphanumeric user name associated with the user -->
<element name="userName" type="string" />
<!-- The user's full name -->
<element name="fullName" type="string" minOccurs="0" />
<!-- This field indicates whether or not this user is disabled. This field is set to false and cannot be changed. -->
<element name="isDisabled" type="boolean" />
<!-- The timestamp when the user last logged in, This field cannot be changed. -->
<element name="lastLoginDate" type="dateTime" />
<!-- not used -->
<element name="primaryGroup" type="string" minOccurs="0" />
<!-- not used -->
<element name="emailAddress" type="string" minOccurs="0" />
<!-- A list of user preferences (extended attributes) associated with this user -->
<element name="userPreferences" type="cmn:Map" minOccurs="0" />
<!-- A list of Tasks (taskIds) that the user is collaborating on -->
<element name="tasksCollaboration" type="string" minOccurs="0" maxOccurs="unbounded" />
<!-- A list of groups to which this user belongs -->
<element name="memberships" type="string" maxOccurs="unbounded" minOccurs="0" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a user with a workload defined to the IBM BPM installation.
-->
<complexType name="TeamMember">
<complexContent>
<extension base="tns:User">
<sequence>
<!-- The numeric ID of the user -->
<element name="workload" type="integer" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a user with a workload defined to the IBM BPM installation.
-->
<complexType name="Expert">
<complexContent>
<extension base="tns:TeamMember">
<sequence>
<!-- TODO what is this -->
<element name="completed" type="integer" />
<!-- TODO what is this -->
<element name="avgHours" type="double" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents an array of Experts
-->
<complexType name="Experts">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- MAY CONTAIN -->
<element name="Experts" type="tns:Expert" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a list of expert users with a workload defined to the IBM BPM installation.
-->
<complexType name="ExpertList">
<complexContent>
<extension base="data:Data">
<sequence>
<!--group of users the system identifies as experts on a task -->
<element name="systemIdentifiedUsers" type="tns:Expert" maxOccurs="unbounded" minOccurs="0" />
<!--group of users included in the the task expert participant group -->
<element name="expertParticipantGroupUsers" type="tns:Expert" maxOccurs="unbounded" minOccurs="0" />
<!--task expert participant group -->
<element name="expertParticipantGroupDetails" type="tns:Group" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a user that has been defined to the IBM BPM installation.
-->
<complexType name="UserPreferences">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The user's display name -->
<element name="displayName" type="string" />
<!-- The user's "Primary Role Description -->
<element name="primaryRoleDescription" type="string" />
<!-- The user's Task Email Address -->
<element name="taskEmailAddress" type="string" />
<!-- The user's Phone Number -->
<element name="phoneNumber" type="string" />
<!-- The user's Street Address -->
<element name="streetAddress" type="string" />
<!-- The user's City -->
<element name="city" type="string" />
<!-- The user's State -->
<element name="state" type="string" />
<!-- The user's Country -->
<element name="country" type="string" />
<!-- The user's Postal Code-->
<element name="postalCode" type="string" />
<!-- The user's Image -->
<element name="image" type="string" />
<!-- The user's Toolbar Collapsed setting -->
<element name="toolbarCollapsed" type="boolean" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a group that has been defined to the IBM BPM installation.
-->
<complexType name="Group">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The numeric ID of the group -->
<element name="groupID" type="long" />
<!-- The alphanumeric name of the group -->
<element name="groupName" type="string" />
<!-- The display name associated with the group -->
<element name="displayName" type="string" />
<!-- The description associated with the group -->
<element name="description" type="string" />
<!-- The list of users that are members of this group -->
<element name="members" type="string" maxOccurs="unbounded" minOccurs="0" />
<!-- The alphanumeric name of the manager group -->
<element name="managerGroupName" type="string" minOccurs="0" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a list of zero or more users that have been defined to the IBM BPM installation.
-->
<complexType name="UserList">
<complexContent>
<extension base="data:Data">
<sequence>
<element name="users" type="tns:User" maxOccurs="unbounded" minOccurs="0" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a list of zero or more user groups that have been defined to the IBM BPM installation.
-->
<complexType name="GroupList">
<complexContent>
<extension base="data:Data">
<sequence>
<element name="groups" type="tns:Group" maxOccurs="unbounded" minOccurs="0" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="User" type="tns:User" />
<element name="TeamMember" type="tns:TeamMember" />
<element name="Expert" type="tns:Expert" />
<element name="Experts" type="tns:Experts" />
<element name="UserPreferences" type="tns:UserPreferences" />
<element name="Group" type="tns:Group" />
<element name="UserList" type="tns:UserList" />
<element name="GroupList" type="tns:GroupList" />
</schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm='http://rest.bpm.ibm.com/v1/data'>
<status>200</status>
<data xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ug='http://rest.bpm.ibm.com/v1/data/usergroup' xsi:type='ug:User'>
<userID>1</userID>
<userName>tw_admin</userName>
<fullName>Internal TW Admin user</fullName>
<isDisabled>false</isDisabled>
<userPreferences>
<item key='Locale'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>en</value>
</item>
</userPreferences>
<tasksCollaboration>75</tasksCollaboration>
<memberships>Debug</memberships>
<memberships>tw_admins</memberships>
<memberships>tw_authors</memberships>
<memberships>tw_portal_admins</memberships>
<memberships>tw_process_owners</memberships>
<memberships>tw_allusers</memberships>
<memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
<memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
<memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f</memberships>
<memberships>Process Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
<memberships>Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
<memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
<memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
<memberships>Process Owner_S_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
<memberships>Managers_S_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
<memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.64bbda3f-b456-486a-9679-87d81c4366dd</memberships>
<memberships>Process Owner_S_9a9f919e-6644-4592-b900-3eaa46838454.64bbda3f-b456-486a-9679-87d81c4366dd</memberships>
<memberships>Managers_S_eca3397d-df4d-4ea6-a74e-22aaef303e3c.64bbda3f-b456-486a-9679-87d81c4366dd</memberships>
<memberships>HRManagers_T_6615a4b0-fd38-4ea5-8bc0-69d2f107369e.30c63e29-aacd-4b3b-803f-a09ce65486d2</memberships>
<memberships>HiringManagers_T_cd97937f-06ab-43cc-8067-17dea489fdb3.30c63e29-aacd-4b3b-803f-a09ce65486d2</memberships>
<memberships>GeneralManagers_T_eb30156e-52c8-4ec5-9be6-02290d02f827.30c63e29-aacd-4b3b-803f-a09ce65486d2</memberships>
<memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.30c63e29-aacd-4b3b-803f-a09ce65486d2</memberships>
<memberships>HiringManagers_S_cd97937f-06ab-43cc-8067-17dea489fdb3.30c63e29-aacd-4b3b-803f-a09ce65486d2</memberships>
<memberships>GeneralManagers_S_eb30156e-52c8-4ec5-9be6-02290d02f827.30c63e29-aacd-4b3b-803f-a09ce65486d2</memberships>
<memberships>HRManagers_S_6615a4b0-fd38-4ea5-8bc0-69d2f107369e.30c63e29-aacd-4b3b-803f-a09ce65486d2</memberships>
<memberships>HRManagers_T_129c442a-75a1-4a7f-b7df-53d2c8909981.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>GeneralManagers_T_ab886e73-e2ec-4cf4-94a7-0c8dff105001.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>HiringManagers_T_e6497638-1592-4d72-b976-2c8579ada550.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>GeneralManagers_S_ab886e73-e2ec-4cf4-94a7-0c8dff105001.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>HRManagers_S_129c442a-75a1-4a7f-b7df-53d2c8909981.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>HiringManagers_S_e6497638-1592-4d72-b976-2c8579ada550.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</memberships>
<memberships>Process Owner_T_7a742398-8ba3-4347-a60f-b21d15ea6bc0.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7</memberships>
<memberships>Managers_T_f319047c-8955-48a1-a6a9-f52d9eaf6f88.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7</memberships>
<memberships>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7</memberships>
<memberships>All Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7</memberships>
<memberships>Managers_S_f319047c-8955-48a1-a6a9-f52d9eaf6f88.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7</memberships>
<memberships>Process Owner_S_7a742398-8ba3-4347-a60f-b21d15ea6bc0.f2472b8c-651f-4cd1-9d95-7bc9d3cbc3b7</memberships>
</data>
</bpm:ResponseData>
The default content type is application/json.
{ "description": "WLE Error Response",
"type": "object",
"properties":
{ "status": {"type": "string",
"description": "The status of the previous API call."
},
"exceptionType": {"type": "string",
"description": "The classname associated with the exception."
},
"errorNumber": {"type": "string",
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string",
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description":"Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description":"Additional exception details, for example, a stack trace."
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/exception"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/exception"
xmlns:dat="http://rest.bpm.ibm.com/v1/data/root">
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" />
<!--
This type represents an error response.
-->
<element name="RestRuntimeException">
<complexType>
<sequence>
<element name="status" type="string"/>
<element name="Data" type="tns:ExceptionData">
</element>
</sequence>
</complexType>
</element>
<!--
This type contains detailed error information associated with an exception.
-->
<complexType name="ExceptionData">
<sequence>
<element name="status" type="string"/>
<!-- This specifies the java class name of the exception -->
<element name="exceptionType" type="string"/>
<!-- The message ID of the error message -->
<element name="errorNumber" type="string" minOccurs="0"/>
<!-- The complete error message -->
<element name="errorMessage" type="string"/>
<!-- The list of strings inserted into the error message -->
<element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/>
<!--
The stacktrace associated with the exception.
Note that this will be omitted unless the "server-stacktrace-enabled" property
is enabled in the server's 100Custom.xml file.
-->
<element name="programmersDetails" type="string"></element>
<!-- Prior responses. Set if a bulk command was used -->
<element name="responses" type="dat:BulkCommandResponses" minOccurs="0"></element>
</sequence>
</complexType>
</schema>
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
8.5.5.0
Parent Topic: User Details Resource