Retrieve a list of instance variables

curl --request POST \
  --url http://localhost:3000/api/user/settings \
  --header 'x-access-token: <api-key>'

{
  "success": true,
  "message": "Setting updated!",
  "data": [
    {
      "_id": "687e6ee393c79717445848de",
      "key": "variable-2",
      "value": "variable value",
      "institution": "6631915765bb0a94cfd6ca99",
      "user": "6430d02554cd4e00403e8b05",
      "status": "active",
      "admin_only": true,
      "institution_shared": true,
      "editable_others": true,
      "institution_data": {
        "_id": "6631915765bb0a94cfd6ca99",
        "name": "scarlet.hugo.praxis-ai.instructure.com",
        "ainame": "Scarlet"
      },
      "user_data": {
        "_id": "6430d02554cd4e00403e8b05",
        "email": "[email protected]",
        "fname": "Hugo",
        "lname": "Lebegue"
      },
      "index": 1
    }
  ]
}

POST

api

user

settings

Retrieve a list of instance variables

curl --request POST \
  --url http://localhost:3000/api/user/settings \
  --header 'x-access-token: <api-key>'

{
  "success": true,
  "message": "Setting updated!",
  "data": [
    {
      "_id": "687e6ee393c79717445848de",
      "key": "variable-2",
      "value": "variable value",
      "institution": "6631915765bb0a94cfd6ca99",
      "user": "6430d02554cd4e00403e8b05",
      "status": "active",
      "admin_only": true,
      "institution_shared": true,
      "editable_others": true,
      "institution_data": {
        "_id": "6631915765bb0a94cfd6ca99",
        "name": "scarlet.hugo.praxis-ai.instructure.com",
        "ainame": "Scarlet"
      },
      "user_data": {
        "_id": "6430d02554cd4e00403e8b05",
        "email": "[email protected]",
        "fname": "Hugo",
        "lname": "Lebegue"
      },
      "index": 1
    }
  ]
}

Authorizations

x-access-token

string

header

required

JWT token passed in x-access-token header

Response

Successfully retrieved user settings

success

boolean

Whether the operation was successful

Example:

true

message

string

Success message

Example:

"Setting updated!"

data

object[]

Show child attributes

data._id

string

Setting unique identifier

Example:

"687e6ee393c79717445848de"

data.key

string

Setting key name

Example:

"variable-2"

data.value

string

Setting value

Example:

"variable value"

data.institution

string

Institution ID this setting belongs to

Example:

"6631915765bb0a94cfd6ca99"

data.user

string

User ID this setting belongs to

Example:

"6430d02554cd4e00403e8b05"

data.status

enum<string>

Setting status

Available options:

active,

inactive

Example:

"active"

data.admin_only

boolean

Whether setting is admin-only

Example:

true

data.institution_shared

boolean

Whether setting is shared across institution

Example:

true

data.editable_others

boolean

Whether setting can be edited by others

Example:

true

data.institution_data

object

Show child attributes

data.institution_data._id

string

Institution unique identifier

Example:

"6631915765bb0a94cfd6ca99"

data.institution_data.name

string

Institution domain name

Example:

"scarlet.hugo.praxis-ai.instructure.com"

data.institution_data.ainame

string

AI assistant name for the institution

Example:

"Scarlet"

data.user_data

object

Show child attributes

data.user_data._id

string

User unique identifier

Example:

"6430d02554cd4e00403e8b05"

data.user_data.email

string<email>

User email address

Example:

"[email protected]"

data.user_data.fname

string

User first name

Example:

"Hugo"

data.user_data.lname

string

User last name

Example:

"Lebegue"

data.index

integer

Setting display order index

Example:

1

Delete a specific user file Update an instance variable

⌘I

API Documentation

Runtime API

Administrator API

Retrieve a list of instance variables

Authorizations

Response