Files
a2a-platform e45ff7e55d deploy
2026-06-29 00:38:27 +00:00

15 KiB

name, description
name description
admin-routes Handle 37 OpenAPI operation(s) under /api/v1/admin/{org_slug} for the admin route group.

admin API Routes

Handle 37 OpenAPI operation(s) under /api/v1/admin/{org_slug} for the admin route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

api_admin_magic_consume_api_v1_admin_org_slug_auth_ma_13806ba8d2

  • Operation ID: api_admin_magic_consume_api_v1_admin_org_slug_auth_magic_consume_get
  • Route: GET /api/v1/admin/{org_slug}/auth/magic-consume
  • Mode: READ
  • Summary: Consume a magic sign-in link (browser-facing)
  • Parameters:
    • org_slug in path required
    • token in query required
  • Operation ID: api_admin_issue_magic_link_api_v1_admin_org_slug_auth_magic_link_post
  • Route: POST /api/v1/admin/{org_slug}/auth/magic-link
  • Mode: WRITE
  • Summary: Issue a magic sign-in link
  • Parameters:
    • org_slug in path required
  • Body: JSON request body accepted.

api_admin_issue_token_api_v1_admin_org_slug_auth_token_post

  • Operation ID: api_admin_issue_token_api_v1_admin_org_slug_auth_token_post
  • Route: POST /api/v1/admin/{org_slug}/auth/token
  • Mode: WRITE
  • Summary: Issue a user token
  • Parameters:
    • org_slug in path required
  • Body: JSON request body accepted.

api_admin_get_user_certificates_api_v1_admin_org_slug_e5a0e75737

  • Operation ID: api_admin_get_user_certificates_api_v1_admin_org_slug_certifications_user_id_get
  • Route: GET /api/v1/admin/{org_slug}/certifications/{user_id}
  • Mode: READ
  • Summary: Get user certificates
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_award_certificate_api_v1_admin_org_slug_cer_a55aec2729

  • Operation ID: api_admin_award_certificate_api_v1_admin_org_slug_certifications_user_id_course_
  • Route: POST /api/v1/admin/{org_slug}/certifications/{user_id}/{course_uuid}/award
  • Mode: WRITE
  • Summary: Manually award a certificate
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • course_uuid in path required

api_admin_revoke_certificate_api_v1_admin_org_slug_ce_585016dce1

  • Operation ID: api_admin_revoke_certificate_api_v1_admin_org_slug_certifications_user_id_user_c
  • Route: DELETE /api/v1/admin/{org_slug}/certifications/{user_id}/{user_certification_uuid}
  • Mode: WRITE
  • Summary: Revoke a user's certificate
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • user_certification_uuid in path required

api_admin_check_course_access_api_v1_admin_org_slug_c_33e8055eda

  • Operation ID: api_admin_check_course_access_api_v1_admin_org_slug_courses_course_uuid_access_u
  • Route: GET /api/v1/admin/{org_slug}/courses/{course_uuid}/access/{user_id}
  • Mode: READ
  • Summary: Check user course access
  • Parameters:
    • org_slug in path required
    • course_uuid in path required
    • user_id in path required

api_admin_get_course_analytics_api_v1_admin_org_slug_a01b54e7f8

  • Operation ID: api_admin_get_course_analytics_api_v1_admin_org_slug_courses_course_uuid_analyti
  • Route: GET /api/v1/admin/{org_slug}/courses/{course_uuid}/analytics
  • Mode: READ
  • Summary: Aggregate stats for a course
  • Parameters:
    • org_slug in path required
    • course_uuid in path required

api_admin_list_course_enrollments_api_v1_admin_org_sl_ea439e26eb

  • Operation ID: api_admin_list_course_enrollments_api_v1_admin_org_slug_courses_course_uuid_enro
  • Route: GET /api/v1/admin/{org_slug}/courses/{course_uuid}/enrollments
  • Mode: READ
  • Summary: List users enrolled in a course
  • Parameters:
    • org_slug in path required
    • course_uuid in path required
    • page in query
    • limit in query

api_admin_bulk_enroll_api_v1_admin_org_slug_enrollmen_c76b6c3285

  • Operation ID: api_admin_bulk_enroll_api_v1_admin_org_slug_enrollments_bulk_post
  • Route: POST /api/v1/admin/{org_slug}/enrollments/bulk
  • Mode: WRITE
  • Summary: Bulk enroll users in a course
  • Parameters:
    • org_slug in path required
  • Body: JSON request body accepted.

api_admin_bulk_unenroll_api_v1_admin_org_slug_enrollm_1d6da8f703

  • Operation ID: api_admin_bulk_unenroll_api_v1_admin_org_slug_enrollments_bulk_unenroll_post
  • Route: POST /api/v1/admin/{org_slug}/enrollments/bulk/unenroll
  • Mode: WRITE
  • Summary: Bulk unenroll users from a course
  • Parameters:
    • org_slug in path required
  • Body: JSON request body accepted.

api_admin_get_user_enrollments_api_v1_admin_org_slug_d860a65110

  • Operation ID: api_admin_get_user_enrollments_api_v1_admin_org_slug_enrollments_user_id_get
  • Route: GET /api/v1/admin/{org_slug}/enrollments/{user_id}
  • Mode: READ
  • Summary: Get user enrollments
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_unenroll_user_api_v1_admin_org_slug_enrollm_0bc9c6c065

  • Operation ID: api_admin_unenroll_user_api_v1_admin_org_slug_enrollments_user_id_course_uuid_de
  • Route: DELETE /api/v1/admin/{org_slug}/enrollments/{user_id}/{course_uuid}
  • Mode: WRITE
  • Summary: Unenroll user from course
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • course_uuid in path required

api_admin_enroll_user_api_v1_admin_org_slug_enrollmen_80a503c510

  • Operation ID: api_admin_enroll_user_api_v1_admin_org_slug_enrollments_user_id_course_uuid_post
  • Route: POST /api/v1/admin/{org_slug}/enrollments/{user_id}/{course_uuid}
  • Mode: WRITE
  • Summary: Enroll user in course
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • course_uuid in path required

api_admin_get_all_user_progress_api_v1_admin_org_slug_5980bde222

  • Operation ID: api_admin_get_all_user_progress_api_v1_admin_org_slug_progress_user_id_get
  • Route: GET /api/v1/admin/{org_slug}/progress/{user_id}
  • Mode: READ
  • Summary: Get all user progress
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_uncomplete_activity_api_v1_admin_org_slug_p_333dafc4cf

  • Operation ID: api_admin_uncomplete_activity_api_v1_admin_org_slug_progress_user_id_activities_
  • Route: DELETE /api/v1/admin/{org_slug}/progress/{user_id}/activities/{activity_uuid}/complete
  • Mode: WRITE
  • Summary: Undo activity completion
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • activity_uuid in path required

api_admin_complete_activity_api_v1_admin_org_slug_pro_a0e5004bd3

  • Operation ID: api_admin_complete_activity_api_v1_admin_org_slug_progress_user_id_activities_ac
  • Route: POST /api/v1/admin/{org_slug}/progress/{user_id}/activities/{activity_uuid}/complete
  • Mode: WRITE
  • Summary: Mark activity as completed
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • activity_uuid in path required

api_admin_get_user_progress_api_v1_admin_org_slug_pro_eadf9c3840

  • Operation ID: api_admin_get_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid_g
  • Route: GET /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}
  • Mode: READ
  • Summary: Get user progress in course
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • course_uuid in path required

api_admin_complete_course_api_v1_admin_org_slug_progr_c218814127

  • Operation ID: api_admin_complete_course_api_v1_admin_org_slug_progress_user_id_course_uuid_com
  • Route: POST /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}/complete
  • Mode: WRITE
  • Summary: Mark entire course as completed
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • course_uuid in path required

api_admin_reset_user_progress_api_v1_admin_org_slug_p_31449b62bc

  • Operation ID: api_admin_reset_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid
  • Route: POST /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}/reset
  • Mode: WRITE
  • Summary: Reset a user's progress in a course
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • course_uuid in path required

api_admin_get_user_trail_detail_api_v1_admin_org_slug_232a8bff43

  • Operation ID: api_admin_get_user_trail_detail_api_v1_admin_org_slug_trails_user_id_get
  • Route: GET /api/v1/admin/{org_slug}/trails/{user_id}
  • Mode: READ
  • Summary: Get user trail with full progress breakdown
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_get_user_course_trail_detail_api_v1_admin_o_61e79d638b

  • Operation ID: api_admin_get_user_course_trail_detail_api_v1_admin_org_slug_trails_user_id_cour
  • Route: GET /api/v1/admin/{org_slug}/trails/{user_id}/courses/{course_uuid}
  • Mode: READ
  • Summary: Get user trail breakdown for a single course
  • Parameters:
    • org_slug in path required
    • user_id in path required
    • course_uuid in path required

api_admin_create_usergroup_api_v1_admin_org_slug_usergroups_post

  • Operation ID: api_admin_create_usergroup_api_v1_admin_org_slug_usergroups_post
  • Route: POST /api/v1/admin/{org_slug}/usergroups
  • Mode: WRITE
  • Summary: Create a user group
  • Parameters:
    • org_slug in path required
  • Body: JSON request body accepted.

api_admin_delete_usergroup_api_v1_admin_org_slug_user_6deba06a8c

  • Operation ID: api_admin_delete_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uuid_delet
  • Route: DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}
  • Mode: WRITE
  • Summary: Delete a user group
  • Parameters:
    • org_slug in path required
    • usergroup_uuid in path required

api_admin_remove_course_from_usergroup_api_v1_admin_o_ba616ff1d6

  • Operation ID: api_admin_remove_course_from_usergroup_api_v1_admin_org_slug_usergroups_usergrou
  • Route: DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/courses/{course_uuid}
  • Mode: WRITE
  • Summary: Revoke a cohort's access to a course
  • Parameters:
    • org_slug in path required
    • usergroup_uuid in path required
    • course_uuid in path required

api_admin_add_course_to_usergroup_api_v1_admin_org_sl_cac4a6b452

  • Operation ID: api_admin_add_course_to_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uui
  • Route: POST /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/courses/{course_uuid}
  • Mode: WRITE
  • Summary: Grant a cohort access to a course
  • Parameters:
    • org_slug in path required
    • usergroup_uuid in path required
    • course_uuid in path required

api_admin_list_usergroup_members_api_v1_admin_org_slu_61091a34a8

  • Operation ID: api_admin_list_usergroup_members_api_v1_admin_org_slug_usergroups_usergroup_uuid
  • Route: GET /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members
  • Mode: READ
  • Summary: List members of a user group
  • Parameters:
    • org_slug in path required
    • usergroup_uuid in path required
    • page in query
    • limit in query

api_admin_remove_usergroup_member_api_v1_admin_org_sl_c10689c1d9

  • Operation ID: api_admin_remove_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uui
  • Route: DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members/{user_id}
  • Mode: WRITE
  • Summary: Remove a user from a user group
  • Parameters:
    • org_slug in path required
    • usergroup_uuid in path required
    • user_id in path required

api_admin_add_usergroup_member_api_v1_admin_org_slug_1138e931f8

  • Operation ID: api_admin_add_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uuid_m
  • Route: POST /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members/{user_id}
  • Mode: WRITE
  • Summary: Add a user to a user group
  • Parameters:
    • org_slug in path required
    • usergroup_uuid in path required
    • user_id in path required

api_admin_provision_user_api_v1_admin_org_slug_users_post

  • Operation ID: api_admin_provision_user_api_v1_admin_org_slug_users_post
  • Route: POST /api/v1/admin/{org_slug}/users
  • Mode: WRITE
  • Summary: Provision a user
  • Parameters:
    • org_slug in path required
  • Body: JSON request body accepted.

api_admin_get_user_by_email_api_v1_admin_org_slug_use_a0d33c23a8

  • Operation ID: api_admin_get_user_by_email_api_v1_admin_org_slug_users_by_email_email_get
  • Route: GET /api/v1/admin/{org_slug}/users/by-email/{email}
  • Mode: READ
  • Summary: Look up a user by email
  • Parameters:
    • org_slug in path required
    • email in path required

api_admin_remove_user_api_v1_admin_org_slug_users_user_id_delete

  • Operation ID: api_admin_remove_user_api_v1_admin_org_slug_users_user_id_delete
  • Route: DELETE /api/v1/admin/{org_slug}/users/{user_id}
  • Mode: WRITE
  • Summary: Remove a user from the organization
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_update_user_profile_api_v1_admin_org_slug_u_2b4c820274

  • Operation ID: api_admin_update_user_profile_api_v1_admin_org_slug_users_user_id_patch
  • Route: PATCH /api/v1/admin/{org_slug}/users/{user_id}
  • Mode: WRITE
  • Summary: Update a user's profile
  • Parameters:
    • org_slug in path required
    • user_id in path required
  • Body: JSON request body accepted.

api_admin_anonymize_user_api_v1_admin_org_slug_users_c139c61306

  • Operation ID: api_admin_anonymize_user_api_v1_admin_org_slug_users_user_id_anonymize_post
  • Route: POST /api/v1/admin/{org_slug}/users/{user_id}/anonymize
  • Mode: WRITE
  • Summary: GDPR right-to-be-forgotten
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_export_user_data_api_v1_admin_org_slug_user_6635cbdeac

  • Operation ID: api_admin_export_user_data_api_v1_admin_org_slug_users_user_id_export_get
  • Route: GET /api/v1/admin/{org_slug}/users/{user_id}/export
  • Mode: READ
  • Summary: Full GDPR data export for a user
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_get_user_groups_api_v1_admin_org_slug_users_d6394b6aa3

  • Operation ID: api_admin_get_user_groups_api_v1_admin_org_slug_users_user_id_groups_get
  • Route: GET /api/v1/admin/{org_slug}/users/{user_id}/groups
  • Mode: READ
  • Summary: List user groups a user belongs to
  • Parameters:
    • org_slug in path required
    • user_id in path required

api_admin_change_user_role_api_v1_admin_org_slug_user_8865c0c139

  • Operation ID: api_admin_change_user_role_api_v1_admin_org_slug_users_user_id_role_patch
  • Route: PATCH /api/v1/admin/{org_slug}/users/{user_id}/role
  • Mode: WRITE
  • Summary: Change a user's org role
  • Parameters:
    • org_slug in path required
    • user_id in path required
  • Body: JSON request body accepted.