Learnifier
  1. Users
Learnifier
  • Course Designs
    • Lists all global course design templates
      GET
  • Organization Units
    • Get Organization Unit with External Id
      GET
    • Organization Units
      GET
    • Adds an Organization Unit
      POST
    • Get Organization Unit
      GET
    • Updates an Organization Unit
      PATCH
  • Users
    • Gets a participation by external id
      GET
    • Gets a user by external id
      GET
    • Lists all users
      GET
    • Adds a user
      POST
    • User information
      GET
    • Updates user information
      PATCH
    • User profile picture
      GET
    • Returns information about the projects the user is a participant in.
      GET
  • Projects
    • Gets Organization Unit by external id
      GET
    • Organization Unit Projects
      GET
    • Create project
      POST
    • Deletes the project
      DELETE
    • Project information
      GET
    • Update project information
      PATCH
    • Project participants
      GET
    • Add participant
      POST
    • Deletes a participant
      DELETE
    • Activate participant
      POST
    • Participant login link
      POST
    • Project team members
      GET
  • Global User Groups
    • List Global User Groups.
    • List of all users in group.
  • User Groups
    • List User Groups.
    • Create a User Group.
    • Get user group
    • List of all users in group.
    • Add user group member.
    • Remove user group member.
  1. Users

Lists all users

GET
/users
Users
Lists all users. Only api callers that have full access can call this method.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://learnifier.com/users'
Response Response Example
200 - Example 1
[
    {
        "authorizationPossible": true,
        "displayName": "Jane Doe",
        "externalId": "string",
        "firstLogin": "2019-08-24T14:15:22Z",
        "firstName": "Jane",
        "hardLock": true,
        "homeOrg": 1234,
        "id": "81590981-1e05-4fd5-aa15-15bc4b06cf7f",
        "lastLogin": "2019-08-24T14:15:22Z",
        "lastName": "Doe",
        "locked": true,
        "prefs": {
            "locale": "sv-SE"
        },
        "primaryEmail": "user@example.com",
        "backOfficeRoles": [
            {
                "id": "string",
                "name": "string"
            }
        ],
        "clientRoles": [
            {
                "id": "string",
                "roles": [
                    {
                        "id": "string",
                        "name": "string"
                    }
                ]
            }
        ]
    }
]

Request

Query Params
limit
integer 
optional
The maximum number of users to return
offset
integer 
optional
The offset to start listing users from

Responses

🟢200List with users
application/json
Body
array of:
authorizationPossible
boolean 
optional
True if the user can authorize herself/himself
displayName
string 
optional
Full name of the user
Example:
Jane Doe
externalId
string 
optional
The external id (foreign key). Must not exceed 255 characters.
firstLogin
string <date-time>
optional
The timestamp when the first login was made. This value can be null.
firstName
string 
optional
The first name of the user (or given name)
Example:
Jane
hardLock
boolean 
optional
True if the user is locked and the lock has been set by an administrator
homeOrg
integer <int64>
optional
The primary organization for the user. Must match the id of an Organization Unit.
Example:
1234
id
string <uuid>
optional
The id of the user this participation belongs to
Example:
81590981-1e05-4fd5-aa15-15bc4b06cf7f
lastLogin
string <date-time>
optional
The timestamp when the last login was made. This value can be null.
lastName
string 
optional
The last name of the user (or surname)
Example:
Doe
locked
boolean 
optional
Lock status. A locked user will not be able to access the platform.
prefs
object 
UserPreferences
optional
locale
string <locale>
optional
The preferred locale. This value can be null if no specific preference has been selected.
Example:
sv-SE
primaryEmail
string <email>
optional
The primary email for this user. If the user has no email this value is null.
backOfficeRoles
array[object (BackOfficeRole) {2}] 
optional
id
string 
required
The id of the role
name
string 
required
The name of the role
clientRoles
array[object (ClientRoles) {2}] 
optional
A list with client roles
id
string 
optional
An organization unit id
roles
array[object (ClientRole) {2}] 
optional
A list with client roles
🔴500Unexpected error
Previous
Gets a user by external id
Next
Adds a user
Built with