> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Brainier

> How to set up the Brainier connector, plus the actions that are available.

![Brainier](https://stackone-logos.com/api/brainier/filled/svg)

v2.1.0[See changelog](https://docs.stackone.com/connectors/brainier/changelog.md)

[47 actions](#actions) · 1 auth method

LMS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Elan/LMS REST API) · Connector Profile](https://docs.stackone.com/connectors/brainier/guides/connector-profile/oauth-2-0-elan-lms-rest-api.md)
>
> Uses client credentials to obtain access tokens. Requires creating an API Client in the Brainier LMS administration sett...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Elan/LMS REST API) · Link Account](https://docs.stackone.com/connectors/brainier/guides/link-account/oauth-2-0-elan-lms-rest-api.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

Assignments

Authors

Bookmarks

Forms

Groups

LearningObjects

Roles

Tags

UserObjectRecords

Users

No scopes found

47 actions

ActionDescriptionRequired scopes

Get Multiple Users Info`brainier_get_multiple_users_info`

Retrieve user information for users that meet filter criteria

`Users`

Get Single User Info`brainier_get_single_user_info`

Retrieve all user information for a given user ID

`Users`

Update User Info`brainier_update_user_info`

Update a pre-existing user with new information (assignment changes may take up to an hour to propagate)

`Users`

Create User`brainier_create_user`

Create a new user with the information provided (assignment changes may take up to an hour to propagate)

`Users`

Upload User Avatar`brainier_upload_user_avatar`

Upload an image file to be used as the avatar of a user

`Users`

Get Multiple Groups Info`brainier_get_multiple_groups_info`

Retrieve group information for groups that meet filter criteria

`Groups`

Get Single Group Info`brainier_get_single_group_info`

Retrieve all group information for a given group ID

`Groups`

Add User To Group`brainier_add_user_to_group`

Add a single user to the specified group within the context of a role (assignment changes may take up to an hour to prop...

`Groups`

Update Group Info`brainier_update_group_info`

Update a pre-existing group with new information provided

`Groups`

Create Group`brainier_create_group`

Create a new group with the information provided

`Groups`

Remove User From Group`brainier_remove_user_from_group`

Remove a single user from a group (assignment changes may take up to an hour to propagate)

`Groups`

Get Multiple Roles Info`brainier_get_multiple_roles_info`

Retrieve role information for roles that meet filter criteria

`Roles`

Get Single Role Info`brainier_get_single_role_info`

Retrieve all role information for a given role ID

`Roles`

Get Multiple Learning Objects Info`brainier_get_multiple_learning_objects_info`

Retrieve learning object information for multiple learning objects based on filter criteria

`LearningObjects`

Get Learning Object Info`brainier_get_learning_object_info`

Retrieve all learning object information for a given object ID

`LearningObjects`

Get Learning Object Comments`brainier_get_learning_object_comments`

Retrieve all comments for a given learning object

`LearningObjects`

Get Object Access`brainier_get_object_access`

Retrieve the users and groups who have been granted access to a learning object

`LearningObjects`

Create Object Access`brainier_create_object_access`

Grant front-end access to a learning object for a user or group (must pass either user\_id or group\_id, but not both)

`LearningObjects`

Remove Object Access`brainier_remove_object_access`

Remove front-end access to a learning object for a user or group (must pass either user\_id or group\_id, but not both)

`LearningObjects`

Get Class Schedules Info`brainier_get_class_schedules_info`

Retrieve all schedule information for a given class object

`LearningObjects`

Get User Object Records`brainier_get_user_object_records`

Retrieve started or completed records in the system, with optional date and filter parameters

`UserObjectRecords`

Create User Object Record`brainier_create_user_object_record`

Create a record for a user/object combination with a status such as Complete or Failed

`UserObjectRecords`

Update User Object Record`brainier_update_user_object_record`

Update the status of a user object record (e.g., moving from Started to Complete)

`UserObjectRecords`

Unregister From Class`brainier_unregister_from_class`

Delete a user object record to unregister a user from a class (only works for class objects)

`UserObjectRecords`

Get Form Questions And Answers`brainier_get_form_questions_and_answers`

Retrieve all questions and possible answers for a quiz or survey

`Forms`

Get Form Options`brainier_get_form_options`

Retrieve additional configuration options for a quiz or survey set in the Brainier LMS backend

`Forms`

Get User Form Answers`brainier_get_user_form_answers`

Retrieve answers provided by a user for all questions in a quiz or survey for a single record

`Forms`

Send Form Answers`brainier_send_form_answers`

Submit answers provided by a user for questions in a quiz or survey

`Forms`

Get Assignments`brainier_list_assignments`

Retrieve all assignment batches that the caller has access to

`Assignments`

Create Assignment`brainier_create_assignment`

Create an empty assignment batch (can also create a bookmark or recommendation)

`Assignments`

Get Assigned Users`brainier_get_assigned_users`

Retrieve all user IDs that are part of an assignment (individually or through a group)

`Assignments`

Create Assigned User`brainier_create_assigned_user`

Add a user to an assignment batch

`Assignments`

Remove Assigned User`brainier_remove_assigned_user`

Remove a user from an assignment batch

`Assignments`

Get Assigned Groups`brainier_get_assigned_groups`

Retrieve all group IDs that are part of an assignment

`Assignments`

Create Assigned Group`brainier_create_assigned_group`

Add a group to an assignment batch

`Assignments`

Remove Assigned Group`brainier_remove_assigned_group`

Remove a group from an assignment batch

`Assignments`

Get Assigned Objects`brainier_get_assigned_objects`

Retrieve all learning object IDs that are part of an assignment

`Assignments`

Create Assigned Object`brainier_create_assigned_object`

Add a learning object to an assignment batch

`Assignments`

Remove Assigned Object`brainier_remove_assigned_object`

Remove a learning object from an assignment batch

`Assignments`

Get Assignments By User`brainier_get_assignments_by_user`

Retrieve all assigned objects and assignment information for a particular user

`Assignments`

Get Tags`brainier_get_tags`

Retrieve all system tags or tags associated with objects the user has access to

`Tags`

Get Bookmarked Objects`brainier_get_bookmarked_objects`

Retrieve all learning objects that the caller has bookmarked

`Bookmarks`

Create Bookmark`brainier_create_bookmark`

Bookmark a learning object for the current user

`Bookmarks`

Remove Bookmark`brainier_remove_bookmark`

Remove a bookmark for a learning object

`Bookmarks`

Get Object Authors`brainier_get_object_authors`

Retrieve all authors associated with a learning object

`Authors`

Get All Object Authors`brainier_get_all_object_authors`

Retrieve all authors the caller has access to (associated with accessible objects)

`Authors`

Get Objects By Author`brainier_get_objects_by_author`

Retrieve all learning objects that have the specified user or faculty as an author

`Authors`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.