Documentation is now available for the Fall 2020 Update release!

Search users

This endpoint is used to fetch users within a tenant.

Leave Feedback

URL

GET https://{api-url}/pi/v2/tenants/{tenantId}/users/search

Sample URLs

To search for partner-level users:

https://{api-url}/api/v2/tenants/msp_15/users/search?pageNo=1&pageSize=5&isDescendingOrder=true&sortName=id&queryString=loginName:brocade+lastName:inc+status:inactive

To search for client-level users:

https://{api-url}/api/v2/tenants/client_16/users/search?pageNo=1&pageSize=5&isDescendingOrder=true&sortName=id&queryString=loginName:brocade+lastName:lab+status:active

Parameters

The parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariablesDescription
uniqueIdID of user.
loginNameLogin name of user.
firstNameFirst name of user.
lastNameLast name of user.
mailIdUser email.
startCreationDateFilter the users created within a date range. Provide the from date.
Example: 2016-11-01T11:54:24 0000
endCreationDateFilter the users created within a date range. Provide the to date.
Example: 2016-11-03T11:54:24 0000
startUpdationDateFilter the users updated within a date range. Provide the to date.
Example: 2016-11-01T11:54:24 0000
endUpdationDateFilter the users updated within a date range. Provide the to date.
Example: 2016-11-03T11:54:24 0000
status
  • To retrieve a list of active users, provide status: active.
  • To fetch list of inactive users, provide status: inactive.

Sample response

{
	"results" : [
		{
			"id" : "USR0000000028",
			"loginName" : "ScarletJohn",
			"lastName" : "John",
			"firstName" : "Scarlet",
			"email" : "scarlet@gmail.com",
			"phoneNumber" : "408-555-1234 Extn 1",
			"mobileNumber" : "8337311540",
			"timeZone" : {
				"id" : "12",
				"name" : "GMT",
				"label" : "Greenwich Mean Time",
				"code" : "GMT"
			},
			"roles" : [
				{
					"id" : 4,
					"name" : "Client Administrator"
				},
				{
					"id" : 5,
					"name" : "Client User"
				},
				{
					"id" : 6,
					"name" : "Customer"
				},
				{
					"id" : 9,
					"name" : "End User View"
				},
				{
					"id" : 10,
					"name" : "ACS Client Administrator"
				},
				{
					"id" : 14,
					"name" : "IM Link Client Administrator"
				},
				{
					"id" : 15,
					"name" : "IM Link Client User"
				}
			],
			"orgId" : "client_16",
			"organizationName" : "Luminalto",
			"createdTime" : "2016-11-01T11:54:24+0000",
			"updatedTime" : "2016-11-01T11:54:24+0000"
		},
		{
			"id" : "USR0000000027",
			"loginName" : "MaryRoe",
			"lastName" : "ROE",
			"firstName" : "MARY",
			"email" : "maryroe@gmail.com",
			"phoneNumber" : "5232324543 Extn 1",
			"mobileNumber" : "8932329531",
			"timeZone" : {
				"id" : "12",
				"name" : "GMT",
				"label" : "Greenwich Mean Time",
				"code" : "GMT"
			},
			"roles" : [
				{
					"id" : 4,
					"name" : "Client Administrator"
				},
				{
					"id" : 5,
					"name" : "Client User"
				},
				{
					"id" : 6,
					"name" : "Customer"
				},
				{
					"id" : 9,
					"name" : "End User View"
				},
				{
					"id" : 10,
					"name" : "ACS Client Administrator"
				},
				{
					"id" : 14,
					"name" : "IM Link Client Administrator"
				},
				{
					"id" : 15,
					"name" : "IM Link Client User"
				}
			],
			"orgId" : "client_16",
			"organizationName" : "Luminalto",
			"createdTime" : "2016-11-01T11:35:20+0000",
			"updatedTime" : "2016-11-01T11:35:20+0000"
		}
	],
	"totalResults" : 2,
	"orderBy" : "user.id",
	"pageNo" : 1,
	"pageSize" : 10,
	"totalPages" : 1,
	"nextPage" : false,
	"previousPageNo" : 0,
	"descendingOrder" : true
}