WebSphere Process Server, WebSphere Business Monitor, WebSphere Business Services Fabric, WebSphere Business Modeler Publishing Server, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS
GET /v1/users/profiles?{parameters}
Name | Value Type | Description |
---|---|---|
expandRefs | boolean | If set to true, the complete profiles are embedded in the references. The default is false. |
includeAttributes | None | The attributes contained in the profiles are limited to those specified in the comma-separated list provided by this attribute. By default, if you omit this parameter, the basic set of attributes is returned for users. |
memberOf | string | The response contains only profiles of users that a are member of the specified group. |
showNested | boolean | If you set the memberOf parameter, this parameter specifies whether nested groups are considered or not. If you set the parameter to false, only direct membership is evaluated. The default value is false. |
searchAttributes | string | Use this query parameter to define a search string that specifies various combinations of attribute values as search criteria. All implementations have to support at least values such as attribute name-attribute value, where the attribute value can contain an asterisk (*) as a wildcard character. |
identifier | None | The returned list will contain only the one user with the specified unique identifier. The implementation decides what is to be used as the unique identifier. For example, this can be the distinguished name. |
None.
A list of user profiles.
The default content-type is application/xml.
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.ibm.com/xmlns/prod/websphere/um.xsd" xmlns="http://www.ibm.com/xmlns/prod/websphere/um.xsd" elementFormDefault="qualified"> <xs:element name="attribute"> <xs:annotation> <xs:documentation>The element that represents an attribute definition.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="attributeValue" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>This element represents one value for the wrapping attribute. It can be sequenced in arbitrary length for multi-valued attributes. If the attribute element is only used to describe the attribute definition that is not part of a profile, there is no attributeValue element wrapped inside.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>This XML attribute is used to specify the name that identifies the attribute. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="type" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>This XML attribute is used to describe the type of the attribute. The values correspond to the data types specified by the XML Schema data type definitions described by http://www.w3.org/2001/XMLSchema-datatypes. The actual attribute types are part of the server configuration and can not be changed by using this XML attribute, but are only used for description purposes.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="multiValued" type="xs:boolean" use="optional" default="false"> <xs:annotation> <xs:documentation>This XML attribute specifies whether the attribute can have multiple values or can have only one value.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> <xs:element name="attributeValue" type="xs:string"> <xs:annotation> <xs:documentation>This element wraps a single attribute value. The value itself is represented by all character data inside the element, using the corresponding string representation, depending on the attribute type.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="profile"> <xs:annotation> <xs:documentation>This element represents a user or group profile.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="attribute" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The profile can contain an arbitrary number of attributes and wrapped attribute value elements.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="type" type="profileType" use="required"> <xs:annotation> <xs:documentation>Denotes whether the profile represents a user or group profile.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="identifier" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>Denotes the unique identifier of the principal, e.g. the DN</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> <xs:simpleType name="profileType"> <xs:annotation> <xs:documentation>Specifies the list of values that can be used to define the type of a profile. Currently, user and group profiles are distinguished.</xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:enumeration value="user"/> <xs:enumeration value="group"/> </xs:restriction> </xs:simpleType> <xs:element name="profileRef"> <xs:annotation> <xs:documentation>This element represents a reference to a profile.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="profile" minOccurs="0"> <xs:annotation> <xs:documentation>The profile reference can contain a full representation of the profile itself. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="uri" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The relative URI that points to the resource that represente the profile. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> <xs:element name="groupMembershipList"> <xs:annotation> <xs:documentation>This element represents a list of profile references to all groups of which a particular user or group is member.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="profileRef" maxOccurs="unbounded" minOccurs="0"> <xs:annotation> <xs:documentation>The groupMembershipList can contain an arbitrary number of references to group profiles.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="resourceList"> <xs:annotation> <xs:documentation>This element represents a list of resource references to profile or attribute elements.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="resource" maxOccurs="unbounded" minOccurs="0"> <xs:annotation> <xs:documentation>The resourceList can contain an arbitrary number of references to profile or attrubute elements.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="uri" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The relative URI that points to the resourceList. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> <xs:element name="resource"> <xs:annotation> <xs:documentation>This element represents a reference to a profile or an attribute element.</xs:documentation> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="1"> <xs:element ref="profile"> <xs:annotation> <xs:documentation> The profile reference can contain a full representation of the profile itself. </xs:documentation> </xs:annotation> </xs:element> <xs:element ref="attribute"> <xs:annotation> <xs:documentation> The attribute reference can contain a full representation of the attribute itself. </xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:attribute name="uri" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The relative URI that points to the resource that represent the profile or attribute.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> </xs:schema>
Example content:
<?xml version="1.0" encoding="UTF-8"?> <um:resourceList uri="rest/ws/um/v1/users/profiles?searchAttributes=uid=wbmadmin&verbose=true&expandRefs=true" xmlns:um="http://www.ibm.com/xmlns/prod/websphere/um.xsd"> <um:resource uri="rest/ws/um/v1/users/profiles/uid=wbmadmin,o=defaultWIMFileBasedRealm"> <um:profile type="user"> <um:attribute name="password" type="hexBinary" multiValued="false"> <um:attributeValue>5348412D313A70623773703772373934616C3A306A63706</um:attributeValue> </um:attribute> <um:attribute name="uid" type="string" multiValued="false"> <um:attributeValue>wbmadmin</um:attributeValue> </um:attribute> <um:attribute name="cn" type="string" multiValued="false"> <um:attributeValue>wbmadmin</um:attributeValue> </um:attribute> <um:attribute name="sn" type="string" multiValued="false"> <um:attributeValue>wbmadmin</um:attributeValue> </um:attribute> </um:profile> </um:resource> </um:resourceList>
{ id: "attribute", description: "The element that represents an attribute definition.", type: "object", properties: { attributeValue: { type: "string", description: "A single attribute value" }, type: { type: "string", description: "The type of the attribute. This should correspond to a schema type definition, described by http://www.w3.org/2001/XMLSchema-datatypes." }, multiValued: { type: "boolean", description: "Indicates whether the attribute can have multiple values or one." } } } { id: "profile", description: "Represents a user or group profile", type: "object", properties: { type: { type: "string", description: "Denotes whether the profile represents a user or group profile." }, identifier: { type: "string", description: "Denotes the unique identifier of the principal, e.g., the DN" }, attribute: { type: "object", description: "Each key is an attribute of the profile, containing attribute content", additionalProperties: { "$ref" : "attribute" } } } } { id: "resource", description: "A reference to a profile or set of attribute definitions.", type: "object", properties: { profile: { "$ref" : "profile", description: "Present when the resource is a profile." optional: true }, attribute: { "$ref" : "attribute", description: "Present when the resource is an attribute.", optional: true }, uri: { type: "string", description: "Relative URI referencing this resource.", optional: false } } } { id: "resourceList", description: "Container object for a list of resources.", type: "object", properties: { resourceList: { type: "array", items: { "$ref" : "resource" } } } }
Example content:
{ "resourceList": [ { "profile": { "attribute": { "cn": { "attributeValue": "wbmadmin", "multiValued": false, "type": "string" }, "password": { "attributeValue": "5348412D313A70623773703772373934616C3A306A63706", "multiValued": false, "type": "hexBinary" }, "sn": { "attributeValue": "wbmadmin", "multiValued": false, "type": "string" }, "uid": { "attributeValue": "wbmadmin", "multiValued": false, "type": "string" } }, "type": "user" }, "uri": "rest\/ws\/um\/v1\/users\/profiles\/uid=wbmadmin,o=defaultWIMFileBasedRealm" } ], "uri": "rest\/ws\/um\/v1\/users\/profiles?searchAttributes=uid=wbmadmin&verbose=true&expandRefs=true" }
None.
Code | Description |
---|---|
401 Unauthorized | Failed access control check during processing. |
403 Forbidden | The operation the client tries to perform is not possible (e.g. using mutually exclusive request parameters). |
404 Not Found | URI does not match any of the defined paths or the variable part of a defined URI path does not denote a resource that exists. |
405 Method Not Allowed | The request addresses a defined URI, but uses an HTTP method that is not defined for this URI. |
415 Unsupported Media Type | The format specified in the MIME-type URI parameter or accept headers is not supported. |
6.2
Parent Topic: Resource "User Profiles"