API Docs

__METHOD= GET . __PATH= /almaws/v1/users/staff-login-report .

Retrieve Staff Login Report.

This Web service retrieves a list of login events.

Resource URL

GET /almaws/v1/users/staff-login-report

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
login_date_fromxs:stringRequiredRetrieve events from this Date (YYYY-MM-DD). Optional.
login_date_toxs:stringRequiredRetrieve events until this Date, included (YYYY-MM-DD). Optional.
successfulxs:stringOptional. Default: trueFilters successful attempts or failed login attempts.Optional values: all, true and failed-login-attempts. optional. By default this is true.
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional.Default value: 0, which means that the first results will be returned.

Body Parameters

None

Output

This method returns a Staff Login Reports object. See doc

Possible Error Codes

CodeMessage