...
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
|---|---|---|---|---|---|
recursive | Boolean |
|
| false | Include users from the suborganizations. |
<any user attribute name> | String |
|
|
| Include only users with exact matching search criteria value for the specified attribute name(s). You may use any of the builtin or custom attribute names here. The value given is searched from the attribute defined. You may use multiple different attribute names (and limiting search criteria values) in a single query (all must then match for the result to be returned). You cannot use the same attribute name multiple times in a single query. You can also search by user status . Use either the status code or the status technical name. For example "pending" is equally suitable as "0". See Data model - CustomerID for a list of user status es. |
maxResults | Integer |
|
| No Limit | Limit the maximum number of results. A value of zero means no limit. |
exactMatch | Boolean |
|
| false | When limiting attribute values are used, this parameter defines if the value must be found exactly like given (true) or if the database value just needs to start with the given value (false). |
Curl Example
| Code Block | ||
|---|---|---|
| ||
curl --insecure -X GET -u restuser:secret "https://localhost:7443/customerid-rest/services/2.1/organizations/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/users/?recursive=true" |
...
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <User xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.1/users/XXXXXXXXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" method="GET"> <Attribute <Attribute name="organizationid"> <Value>1234567-1</Value> </Attribute> <Attribute <Value>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</Value> </Attribute> <Attribute name="emailfirstname"> <Value>firstname.lastname@example.org< <Value>Firstname</Value> < </Attribute> <Attribute <Attribute name="cnsurname"> <Value>YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY</Value> </Attribute> <Attribute <Value>Lastname</Value> </Attribute> <Attribute name="ssnmobile"> <Value>010199-1234< <Value>+0123456789</Value> < </Attribute> <Attribute <Attribute name="surnamecn"> <Value>Lastname< <Value>YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY</Value> <</Attribute> <Attribute <Attribute name="login"> <Value>firstname<Value>firstname.lastname</Value> </Attribute> <Attribute name="firstname"> <Value>Firstname</Value> </Attribute> <Attribute name="mobile"> <Value>+0123456789</Value> </Attribute> <Attribute </Attribute> <Attribute name="email"> <Value>firstname.lastname@example.org</Value> </Attribute> <Attribute name="ssn"> <Value>010199-1234</Value> </Attribute> <Attribute name="organization"> <Value>My Subsidiary</Value> </Attribute> <Attribute name="organizationEntityName"> <Value>5555555-6/1234567-1</Value> </Attribute> <Attribute name="organizationId"> <Value>ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ</Value> </Attribute> <Attribute name="status"> <Value>Enabled< <Value>Enabled</Value> < </Attribute> </User> |
Supported values
...