SEservicechannel
Users

Users collection

Returns the list of all users of the current subscriber (the main user is also included) for successful request. <br />Note: This method is available to subscriber users with the Super Admin secondary role.

get/users

Request

Query parameters

subscriberIdinteger

Unique numeric identifier of the subscriber. Optional

startIndexinteger

Start item index. Optional, 0 by Default

maxCountinteger

Items count to get. Optional, all items by Default.

userFilterType'Corporate' | 'All'

Return only users of a given type. Optional, corporate by default.

feedRolesFilterstring[]

Return users only with assigned Feed Roles. Optional, return all users by default.

includeMliInfoboolean

Include Mli user info in response. Optional, false by default

includeMlpInfoboolean

Include Mlp user info in response. Optional, false by default

includeTotalCountboolean

Include total user count in response. Optional, false by default

Response

Indicates that the request succeeded and that the requested information is in the response.

Idinteger

Unique user identifier.

SubscriberIdinteger

Unique subscriber ID.

UserNamestring

Username of the user.<br /> • For subscriber users, the username appears as User Id on the "General Info" tab of the user profile page.<br /> • For provider users, the username is listed as UserID under "Access" on the "General" tab of the user profile page.

FullNamestring

Full name of the user.<br /> • For subscriber users, the full name appears as User Name on the "General Info" tab of the user profile page.<br /> • For provider users, you can see their first and last name under "Basic" on the "General" tab of the user profile page.

Emailstring

User’s email address.

PsmEmailstring

Email address through which a user can reset their password.

Disabledboolean

Defines if a user is deactivated.

IsLockedboolean

Defines if a user is locked.

Rolesstring[]

Secondary roles assigned to a subscriber user that determine their permissions and level of access to various Service Automation modules.

Permissionsstring[]

Permissions assigned to a subscriber user that determine whether they have full or read-only access to various Service Automation modules.

UserType'Corporate' | 'Dashboard' | 'ServiceChannel'

Subscriber user type defining their level of access to ServiceChannel:<br /> • Corporate — a user can work in Service Automation.<br /> • Dashboard — a user can only access the dashboard assigned to them.<br />0 is returned for provider users.

FeedRolestring

Changes

No recorded changes to this operation across all 1 revision of this API.