User Registrations

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Query parameters

idintegerOptional

Canvas user ID

Responses

200

Getting a specific user registration

application/json

get

/api/v1/user_registrations/{id}

HTTPcURLJavaScriptPython

GET /api/v1/user_registrations/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific user registration

{
  "user_registration": {
    "canvas_user_id": 1,
    "catalog": {
      "id": 15,
      "name": "Domain Account 15"
    },
    "name": "User 1",
    "email": "[email protected]",
    "custom_fields": {
      "favorite_color": "#BADA55",
      "code_of_conduct": "1",
      "age": "19"
    },
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000"
  }
}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Query parameters

fromstringOptional

Earliest date/time to return (optional, String). Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.

tostringOptional

Latest date/time to return (optional, String). See 'from' above for format.

Responses

200

Listing user registrations

application/json

Responseobject

get

/api/v1/user_registrations

HTTPcURLJavaScriptPython

GET /api/v1/user_registrations HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing user registrations

{
  "user_registrations": [
    {
      "canvas_user_id": 2,
      "catalog": {
        "id": 16,
        "name": "Domain Account 16"
      },
      "name": "User 2",
      "email": "[email protected]",
      "custom_fields": {
        "favorite_color": "#BADA55",
        "code_of_conduct": "1",
        "age": "19"
      },
      "created_at": "2024/01/01 00:00:00 +0000",
      "updated_at": "2024/01/01 00:00:00 +0000"
    }
  ]
}

post

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/x-www-form-urlencoded

namestringOptional

Full name

emailstringOptional

E-mail address (will also serve as login)

catalog_idstringOptional

ID of subcatalog to associate with user (optional)

custom_fieldsstringOptional

Hash of custom field values, e.g. { 'phone': '867-5309' } (optional)

Responses

201

Registering a user

application/json

post

/api/v1/user_registrations

HTTPcURLJavaScriptPython

POST /api/v1/user_registrations HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 73

"name='text'&email='text'&catalog_id='text'&custom_fields='text'"

201

Registering a user

{
  "user_registration": {
    "canvas_user_id": 1234,
    "catalog": {
      "id": 17,
      "name": "Domain Account 17"
    },
    "name": "Barack Obama",
    "email": "[email protected]",
    "custom_fields": {
      "phone": "[phone]"
    },
    "created_at": "2024-01-01T00:00:00+00:00",
    "updated_at": "2024-01-01T00:00:00+00:00"
  }
}