Docebo
Docebo is a learning management system (LMS) that can provide training for your employees, partners, and customers. It's easy to use for both administrators and learners, encouraging learner engagement and adoption.
Authorization
Basic Auth
The Basic Auth type of authentication is the default selection because it’s the most commonly used form of authentication for Docebo. To configure Basic Auth, select the Basic Auth or Query string authentication type in the Auth Type.
When using the basic auth authentication type, the following data is also sent:
Input | Description | Examples |
---|---|---|
Client Id | This is unique for each partner, and is provided by Docebo | xxxx |
Client Secret | This is unique for each partner, and is provided by Docebo | xxxx |
For more information visit Docebo basic auth doc
OAuth2.0
Docebo APIs use the OAuth 2.0 framework in most third-party cases. It includes authentication and authorization for web servers, installed and client-side applications. OAuth 2.0 app credentials can be obtained on the Docebo API and SSO App settings page.
Your client application will request an access token from the LMS, extract a token from the response and send it to each REST API that you’d like to access.
When you create your Docebo App you must be sure to enter Sapper's OAuth callback URL -Sapper - as a Callback URL.
To authorize OAuth 2.0 app for Docebo you need to provide the below information's.
Input | Description | Examples |
---|---|---|
Client ID | This is unique for each partner, and is provided by Docebo | xxxx |
Client Secret | This is unique for each partner, and is provided by Docebo | xxxx |
Grant Type | In OAuth 2.0, the term “grant type” refers to the way an application gets an access token. OAuth 2.0 defines several grant types, including the authorization code flow. OAuth 2.0 extensions can also define new grant types. | password |
Scope | It manages the connection to a specified Docebo instance and provides a scope for all subsequent Docebo activities. | api |
Username | Provide a valid username for the given Docebo account user want to connect. | exampleUser |
Password | It’s a string of characters that allows access to the respective Docebo user account. | xxxx |
Access Token | In general, applications use access tokens to make API requests on behalf of a user. | 87b567fa3de847fb3adef9492b294bb83f8cd266 |
Token Type | Select the appropriate type of token for receiving the access token key. | Bearer |
Refresh Token | A refresh token is a special token that is used to obtain additional access tokens. This allows you to have short-time access tokens without having to collect credentials every time one expires. | 7db6e6a331223fa0473cfcdf62eb8fec26407a5b
|
For more information please visit Docebo APIs Authentication doc
Docebo Connections
Docebo Basic Connection
Input | Key | Description | Example |
Select Application | application | Select Docebo application | Docebo |
Connection type | connection type | Select the type of connection. | Rest |
Rest Connection Type | Rest Connection Type | Select the Basic connection type | Basic |
Connection Name | name | Provide a name for the connection. | Docebo |
Connection Description | description | Provide a description for the connection. | NA |
Host Name | host | Provide a string value for the URL of user's Docebo account. | |
Username | username | Provide a valid username for the given Docebo account user want to connect. | exampleUser |
Password | password | Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value. | exampleSecurePassword |
Header Field | header | Provide the path of the endpoint for authentication. | Authorization |
Header Prefix | header prefix | Select the header prefix - | Basic |
Docebo OAuth2.0 Connection
Input | Key | Description | Example |
Select Application | application | Select Docebo application | Docebo |
Connection Type | connection type | Select the type of connection. | REST |
REST Connection Type | rest connection type | Select the type of REST connection. | OAuth2.0 |
Connection Name | name | Provide a name for the connection. | Docebo connection |
Connection Description | description | Provide a description for the connection. |
|
Host Name | host | Provide a string value for the URL of user's Docebo account. |
|
Grant Type | grant type | Provide the grant type - authorization code, password, client credentials. | authorization code, password, client credentials. |
Actions
Create User
Create User | key: createUser
Input | Key | Description | Example |
---|---|---|---|
User Id | userID | A user identification or user ID is an entity used to identify of a user on Docebo | |
Level | Level | There are three user levels available within your platform: Users, Power Users, and Superadmins. The user level is set for the first time when the user is created in the platform, but can be changed over time from the user management area. | Users, Power Users, and Superadmins |
emailID | Email id is an unique address of the users used for sending emails. | ||
First Name | firstName | Provide the first name of the user. | John |
Last Name | lastName | Provide the last name of the user. | Smith |
Password | password | A password is a string of characters used to verify the identity of a user during the authentication process. | xxxxxxxx |
Enroll User in a Course
Enroll User in a Course | key: enrollUserinCourse
Input | Key | Description | Example |
---|---|---|---|
Course ID | courseID | A course ID is a unique identifier created for every Mastering course in the Docebo platform. It contains the course creator's last name and five digits. | 865321 |
User ID | userID | A user identification or user ID is an entity used to identify of a user on Docebo |
Get All Courses
Get all Courses | key: getallCourses
Update User
Update User | key: updateUser
Input | Key | Description | Example |
---|---|---|---|
User ID | userID | A user identification or user ID is an entity used to identify of a user on Docebo |
Get all Users
Get all Users | key: getallUsers