api.md

User Service API

Table of Contents

• Query
• Objects
  • PaginationInfo
  • PublicUserInfo
  • UserInfo
• Inputs
  • DateTimeFilter
  • IntFilter
  • Pagination
  • StringFilter
• Enums
  • GlobalUserRole
  • SortDirection
• Scalars
  • Boolean
  • Date
  • DateTime
  • Int
  • LocalTime
  • String
  • Time
  • UUID
  • Url

Query

Field	Argument	Type	Description
findPublicUserInfos		[PublicUserInfo]!	Gets the publicly available information for a list of users with the specified IDs. If a user does not exist, null is returned for that user.
ids		[UUID!]!
currentUserInfo		UserInfo!	Gets the user information of the currently authorized user.
findUserInfos		[UserInfo]!	Gets all of the users' information for a list of users with the specified IDs. Only available to privileged users. If a user does not exist, null is returned for that user.
ids		[UUID!]!

Objects

PaginationInfo

Return type for information about paginated results.

Field	Argument	Type	Description
page		Int!	The current page number.
size		Int!	The number of elements per page.
totalElements		Int!	The total number of elements across all pages.
totalPages		Int!	The total number of pages.
hasNext		Boolean!	Whether there is a next page.

PublicUserInfo

Field	Argument	Type	Description
id		UUID!
userName		String!

UserInfo

Field	Argument	Type	Description
id		UUID!
userName		String!
firstName		String!
lastName		String!
realmRoles		[GlobalUserRole!]!

Inputs

DateTimeFilter

Filter for date values. If multiple filters are specified, they are combined with AND.

Field		Type	Description
after		DateTime	If specified, filters for dates after the specified value.
before		DateTime	If specified, filters for dates before the specified value.

IntFilter

Filter for integer values. If multiple filters are specified, they are combined with AND.

Field		Type	Description
equals		Int	An integer value to match exactly.
greaterThan		Int	If specified, filters for values greater than to the specified value.
lessThan		Int	If specified, filters for values less than to the specified value.

Pagination

Specifies the page size and page number for paginated results.

Field		Type	Description
page		Int!	The page number, starting at 0. If not specified, the default value is 0. For values greater than 0, the page size must be specified. If this value is larger than the number of pages, an empty page is returned.
size		Int!	The number of elements per page.

StringFilter

Filter for string values. If multiple filters are specified, they are combined with AND.

Field		Type	Description
equals		String	A string value to match exactly.
contains		String	A string value that must be contained in the field that is being filtered.
ignoreCase		Boolean!	If true, the filter is case-insensitive.

Enums

GlobalUserRole

Value	Description
SUPER_USER
COURSE_CREATOR

SortDirection

Specifies the sort direction, either ascending or descending.

Value	Description
ASC
DESC

Scalars

Boolean

Built-in Boolean

Date

An RFC-3339 compliant Full Date Scalar

DateTime

A slightly refined version of RFC-3339 compliant DateTime Scalar

Int

Built-in Int

LocalTime

24-hour clock time value string in the format hh:mm:ss or hh:mm:ss.sss.

String

Built-in String

Time

An RFC-3339 compliant Full Time Scalar

UUID

A universally unique identifier compliant UUID Scalar

Url

A Url scalar