Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iSpring Learn user API

User operations

iSpring Learn user API is one of 20 APIs that iSpring Learn publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include user. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 27 operations across 21 paths, and defines 29 schemas. It is described by OpenAPI 3.0.0, at version 3.0.

Requests are made against a single base URL, https://api-learn.ispring.com.

27 operations 21 paths 29 schemas 3 DELETE8 GET16 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0
Base URL
https://api-learn.ispringlearn.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iSpring Learn user API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 27

Across 21 paths, the API surfaces 27 operations — 3 DELETE, 8 GET, 16 POST. Each is listed below with its method, path, parameters, and response codes.

user 27

User operations

GET
/user
Get user list
GetUsers 4 params → 200400401403
POST
/user
Add a new user
AddUser 13 params body → 201400401403
GET
/user/{userId}
Get user profile
GetUserProfile 1 param → 200400401403
POST
/user/{userId}
Update user profile
UpdateUserProfile 8 params body → 200400401403
DELETE
/user/{userId}
Delete user
RemoveUser 1 param → 204400401403
POST
/users/find_existing
Find existing users
FindExistingUsers 1 param body → 200400401403
GET
/user/{userId}/v2
Get user profile
GetUserProfileV2 1 param → 200400401403
GET
/user/v2
Get user list
GetUsersV2 4 params → 200400401403
GET
/usersdeprecated
List users
ListUsers 6 params → 200400401403
GET
/users/v2
List users
ListUsersV2 7 params → 200400401403
POST
/users/v2
List users
ListUsersV2ByPost body → 200400401403
GET
/user/profile/fields
Get user profile fields
GetUserProfileFields → 200400401403
POST
/user/{userId}/password
Update user password
UpdateUserPassword 2 params body → 200400401403
POST
/user/{userId}/status
Activate/Deactivate user
ChangeUserStatus 2 params body → 200400401403
POST
/user/{userId}/subordination
Change user subordination
ChangeUserSubordination 1 param body → 204400401403
POST
/user/{userId}/scheduled_deactivation
Schedule user deactivation
ScheduleUserDeactivation 1 param body → 200400401403
DELETE
/user/{userId}/scheduled_deactivation
Delete scheduled deactivation date
RemoveScheduledUserDeactivation 1 param → 200400401403
POST
/user/{userId}/scheduled_termination
Schedule user termination
ScheduleUserTermination 1 param body → 200400401403
DELETE
/user/{userId}/scheduled_termination
Delete scheduled termination date
RemoveScheduledUserTermination 1 param → 200400401403
POST
/user/{userId}/groups/remove
Remove user from groups
RemoveUserFromGroups 2 params body → 200400401403
GET
/role
Get role list
GetRoles → 200400401403
POST
/users/activate
activate users
Activate users 1 param body → 200400401403
POST
/users/deactivate
deactivate users
Deactivate users 1 param body → 200400401403
POST
/users/terminate
terminate users
Terminate users 1 param body → 200400401403
POST
/user/list
Get users list
GetPagedUsersList body → 200400401403
POST
/users/work-leave-status
Update work leave statuses
UpdateWorkLeaveStatuses body → 200400401403
POST
/users/work-leave-status/delete
Remove work leave statuses
RemoveWorkLeaveStatuses 1 param body → 200400401403

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are UserV2 (16 properties), User (16 properties), NewUser (12 properties), UserFieldInfo (8 properties). Each schema is shown below with its type and property counts.

Subordination
object
2 properties 1 required
UpdateWorkLeaveStatusesRequest
object
1 property
GetPagedUsersListResponse
object
3 properties
ErrorResponse
object
2 properties 2 required
UpdateUserPassword
object
1 property 1 required
UserProfileFields
object
3 properties 2 required
RemoveUserGroups
object
1 property 1 required
UserRoleEnum
string
GetPagedUsersListRequest
object
6 properties
UserV2
object
16 properties 11 required
WorkLeaveReason
string
UpdateUser
object
7 properties
ChangeUserSubordination
object
2 properties
NewUser
object
12 properties 2 required
ProfileFieldsDateRangeItem
object
3 properties 3 required
UserRole
object
3 properties 1 required
Role
object
4 properties 4 required
ScheduledUserTermination
object
1 property 1 required
ArrayOfIds
array
UsersPage
object
2 properties 1 required
UserStatus
integer
1 - active, 3 - inactive, 5 - terminated
User
object
16 properties 11 required
WorkLeaveStatus
object
3 properties 2 required
WorkLeaveStatusData
object
4 properties 2 required
ScheduledUserDeactivation
object
1 property 1 required
UserFieldInfo
object
8 properties 8 required
UpdateUserStatus
object
1 property 1 required
ProfileFieldsFilterItem
object
2 properties 2 required
UsersPageV2
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ispring-user-api-openapi.yml Raw ↑

Other APIs iSpring Learn publishes across the network.

iSpring Learn assignments API
iSpring Learn certificate API
iSpring Learn content API
iSpring Learn department API
iSpring Learn departments API
iSpring Learn enrollment API
iSpring Learn gamification API
iSpring Learn group API
iSpring Learn jobtraining API
iSpring Learn learning_track API
iSpring Learn performance-management API
iSpring Learn quizzes API