TIS Training API Documentation
  • Welcome!
  • Quick Start
  • Managing Users
  • Single Sign On (SSO)
    • General Options
    • Role and Group Mappings
    • Connection Types
      • Microsoft Entra ID (Formerly Azure AD)
      • Google Workspace
      • OpenID Connect (OIDC)
      • SAML (Security Assertion Markup Language)
  • SCORM Packages
  • Webhooks
  • API Reference
    • Users
      • 🔵GET users
      • 🔵GET users/seats
      • 🟢POST users
      • 🟠PUT users
      • 🟢POST users/password
      • 🟡PATCH users/enable
      • 🟡PATCH users/disable
      • 🔴DELETE users
    • Results
      • 🔵GET results
      • 🔵GET results/group
    • Groups
      • 🔵GET groups
      • 🟢POST groups/users
      • 🔴DELETE groups/users
    • 🔵GET courses
    • 🔵GET filters
    • 🟢POST login
    • â›”Standard Error Format
  • Webhook Reference
    • Standard Structure
    • Course Complete
    • Multi-Course Complete
  • OpenAPI Specification
Powered by GitBook
On this page
  • URL
  • Parameters
  • Responses
  1. API Reference
  2. Users

PATCH users/disable

Disables a user accounts access to the organisation.

PreviousPATCH users/enableNextDELETE users

Last updated 9 months ago

URL

PATCH https://training.tapintosafety.com.au/api/v2/users/{User Id}/disable

Parameters

URL Parameters

Name
Description

User Id*

The Id of the user to disable. Formatted as a GUID. A list of users can be found using .

* required

curl https://training.tapintosafety.com.au/api/v2/users/00000000-0000-0000-0000-000000000000/disable \
    -X PATCH                                             \
    -H "Authorization: Bearer $APIKey"

Responses

A 204 response will be received even if the specified user is already disabled.

204 - OK

No response body.

400 - Bad Request

Error Code: USER_NOT_FOUND

A user could not be found with the specified User Id

🟡
GET users