Hub 2018.3 Help

Get All User Details

Request

GET <REST API URL>/userdetails?fields=string&$skip=int&$top=int&query=string

Parameter

Description

fields

Optional. Returns only the specified subset of the fields for each UserDetail. Use Fields Syntax to define the subset.

$skip

Optional. Lets you set a number of UserDetails to skip before returning the first one.

$top

Optional. Lets you set the maximum number of UserDetails to return.

query

Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the UserDetails, the following fields and tuples are supported:

authName: userSamlName — User details with the given name provided by SAML

authLogin: value — User details with given JetBrains Account login

authLogin: userGithubLogin — User details with given GitHub login

fullName: value — User details with given name in GitHub

authLogin: userJiraLogin — User details with given login in Jira

authName: userJiraName — User details with given name in Jira

authLogin: userLdapLogin — User details with given LDAP user ID

authName: value — User details with given name in LDAP

authName: userOpenIDName — User details with given name in OpenID

has: avatar — Has avatar

openID: value — User details with given OpenID identifier

authLogin: value — User details with given Hub login

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

email: email — User details with the given email

has: email — User details with email

has: jabber — User details with jabber

has: originService — User details that were imported from some service

has: authLogin — Details with login

id: value — User detail with the given ID

jabber: jabber — User details with the given jabber address

originService: service — User details that were imported from the given service

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

user: user — User details of the given user

Response

Response Code

Meaning

200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "skip": int, "top": int, "total": int, "userdetails": [details, ...] }
Last modified: 17 December 2018