Hub 2017.3 Help

Get All User Details

Request

GET <REST API URL>/userdetails?fields=string&$skip=int&$top=int&query=string
Parameter Description
fields Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.
$skip Optional query parameter. Number of roles to skip before returning first entry of the page.
$top Optional query parameter. Max number of roles to return in the page.
query

Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for UserDetails:

authLogin: userGithubLogin — All details with the given login

authName: value — All details with the given login

authName: userGoogleName — All details with the given user full name

googleID: value — All details with the given OpenID identifier

has: avatar — Has avatar

authLogin: value — Details with the given login

authLogin: value — All details with the given login

authName: value — All details with the given user full name

authLogin: userLdapLogin — All details with the given login

authName: value — All details with the given login

authName: userOpenIDName — All details with the given user full name

has: avatar — Has avatar

openID: value — All details with the given OpenID identifier

authLogin: value — Details with the given login

authMethod: authModule — User details associated with the given auth provider

email: email — Details with the given email

has: email — Details with email

has: jabber — Details with jabber

has: originService — Details that were imported from some service

has: authLogin — Details with login

id: value — A user detail with the given id

jabber: jabber — Details with the given jabber account

originService: service — Details that were imported from the given service

type: authModuleType — User details of the auth providers of the given type

user: user — User details of the given user

Response

Response Code Meaning
200 OK Successful request.
400 Bad Request Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body

page

{ "skip": int, "top": int, "total": int, "userdetails": [details, ...] }
Last modified: 23 August 2017