Query parameter for REST API /api/v1/members - Check to see if user exists

Does anyone have an example of a REST API call for 16.2 using /api/v1/members that will allow me to look a user/member up by userid(name) field?

I can create the user no problem using the REST API

builder = new URIBuilder(baseUrl+"/api/v1/members");
builder.setParameter("type", "0"); //type 0 is user
builder.setParameter("name", username);
builder.setParameter("group_id", groupId);
builder.setParameter("first_name", firstName);
builder.setParameter("middle_name", middleName);
builder.setParameter("last_name", lastName);

but I am struggling with the syntax to query/find that user. The "name" field will be unique, I would prefer to search by that and get back 1 result if they exist or nothing/{"data":[]} if they do not.

Can anyone provide an example?

Find more posts tagged with

Comments

Wallace Ho

Hi Carmen,

The only query parameter that is necessary is named "query". So your URIBuilder only requires one key-value pair.

builder.setParameter("query", username);

and the built URI should be "/api/v1/members?query=<username>".

Hope that helps,

Wallace

Carmen Mazzotta

Thanks, do you know I make the query literal meaning it finds the specific name and doesn't do a like or * type search

For example:

if I have two users with the user id abc and abc123

builder.setParameter("query", username);//works for username "abc123" and username "abc"

I tried to put the literal in quotes. but it doesn't return anything.

builder.setParameter("query", "\""+username+"\""); //does not return result for "abc123" which is valid

Wallace Ho

Hi Carmen,

The "query" parameter is not expecting a string literal and the user id does not need to be enclosed in double quotes. A query for user id "abc" will return any matches for the string pattern for all users in Content Server. For example, "/api/v1/members?query=abc" will return both usernames "abc123" and "abc". If you only want to return a result for user id "abc123" then that's the string you should be setting for the "query" parameter (/api/v1/members?query=abc123).

Regards,

Wallace

Carmen Mazzotta

Thanks Wallace! I will just parse the results for an exact match.