User Accounts User Accounts

User Accounts

Mounika Vukkadam Mounika Vukkadam

User Accounts

User accounts includes the details of all accounts within the LMS.

 

Get all user accounts:

Description
Returns all user accounts within the tenancy.
Request Method GET
Request URL {{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts
Authorisation Header Bearer {api_key}

 

Query String Parameters:

Parameter Data Type Details
requestid integer optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned
showSuspended boolean optional, if true suspended user accounts will be included
userFields boolean

optional, if true user account records will include all custom user fields

 

Example Response without requestId included:

{ 
"requestid": 161,
"status": "Processing"
}

Example Response with requestId included:

If request is still processing:

{ 
"requestid": 161,
"status": "Processing"
}

If request is complete:


{

"requestid": 161,
"status": "Complete",
"data": [
{
"userid": 33,
"username": "hope.renner@example.com",
"email": "hope.renner@example.com",
"firstname": "Hope",
"lastname": "Renner",
"lastaccess": "Never",
"lastupdated": "2021-05-03T00:49:23+00:00",
"suspended": "No",
"tenancyname": "Internal Staff"

},

{
"userid": 29,
"username": "toni54@example.com ",
"email": "toni54@example.com",
"firstname": "Toni",
"lastname": "Wardwina",
"lastaccess": "2020-05-15T06:45:55+00:00",
"lastupdated": "2022-04-03T09:42:29+00:00",
"suspended": "No",
"tenancyname": "Internal Staff"

}

]
}

Add comment

Please sign in to leave a comment.