Users | API Documentation | Heeler User Guide

Enable Mfa

patch

Authorizations

cookiestringRequired

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

patch

/api/users/mfa/enable

PATCH /api/users/mfa/enable HTTP/1.1
Accept: */*

{
  "ok": true,
  "message": "text"
}

Disable Mfa

patch

Authorizations

cookiestringRequired

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

patch

/api/users/mfa/disable

PATCH /api/users/mfa/disable HTTP/1.1
Accept: */*

{
  "ok": true,
  "message": "text"
}

Generate Qr Code

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

anyOptional

404

Not found

get

/api/users/mfa/generate

GET /api/users/mfa/generate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unlock User

patch

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

patch

/api/users/{user_id}/unlock

PATCH /api/users/{user_id}/unlock HTTP/1.1
Accept: */*

No content

List Users

get

Authorizations

cookiestringRequired

Query parameters

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

totalintegerRequired

pagesintegerRequired

page_sizeintegerRequired

page_numberintegerRequired

404

Not found

422

Validation Error

application/json

get

/api/users

GET /api/users HTTP/1.1
Accept: */*

{
  "items": [
    {
      "id": 1,
      "email": "text",
      "first_name": "text",
      "last_name": "text",
      "is_active": true,
      "saml_enabled": true,
      "tenant_admin": true,
      "force_reset_password": false,
      "locked": false,
      "password_last_updated": "2026-03-18T21:19:20.014Z",
      "last_login_attempt": "2026-03-18T21:19:20.014Z",
      "last_login": "2026-03-18T21:19:20.014Z",
      "mfa_configured": false
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Add User

post

Authorizations

cookiestringRequired

Body

emailstringRequired

first_namestringRequired

last_namestringRequired

passwordany ofOptional

stringOptional

or

nullOptional

tenant_adminany ofOptionalDefault: false

booleanOptional

or

nullOptional

force_reset_passwordany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

post

/api/users

POST /api/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "password": "text",
  "tenant_admin": false,
  "force_reset_password": false
}

No content

Search Users

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/users/search

GET /api/users/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "contributors": [
    {
      "id": 1,
      "name": "text",
      "email": "text",
      "alternate_emails": [
        "text"
      ],
      "is_hidden": true,
      "user_types": [
        {
          "user_type": "bitbucket",
          "user_id": "text",
          "username": "text"
        }
      ],
      "services": -1,
      "applications": -1
    }
  ]
}

Get User By Id

get

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

idintegerRequired

emailstringRequired

first_namestringRequired

last_namestringRequired

is_activebooleanRequired

saml_enabledbooleanRequired

tenant_adminbooleanRequired

force_reset_passwordany ofOptionalDefault: false

booleanOptional

or

nullOptional

lockedany ofOptionalDefault: false

booleanOptional

or

nullOptional

password_last_updatedany ofOptional

string · date-timeOptional

or

nullOptional

last_login_attemptany ofOptional

string · date-timeOptional

or

nullOptional

last_loginany ofOptional

string · date-timeOptional

or

nullOptional

mfa_configuredany ofOptionalDefault: false

booleanOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/users/{user_id}

GET /api/users/{user_id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "is_active": true,
  "saml_enabled": true,
  "tenant_admin": true,
  "force_reset_password": false,
  "locked": false,
  "password_last_updated": "2026-03-18T21:19:20.014Z",
  "last_login_attempt": "2026-03-18T21:19:20.014Z",
  "last_login": "2026-03-18T21:19:20.014Z",
  "mfa_configured": false
}

Update User

post

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Body

emailstringRequired

first_namestringRequired

last_namestringRequired

tenant_adminbooleanRequired

mfa_configuredany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

post

/api/users/{user_id}

POST /api/users/{user_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "tenant_admin": true,
  "mfa_configured": false
}

No content

Delete User

delete

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

delete

/api/users/{user_id}

DELETE /api/users/{user_id} HTTP/1.1
Accept: */*

No content

Disable User

patch

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

patch

/api/users/{user_id}/disable

PATCH /api/users/{user_id}/disable HTTP/1.1
Accept: */*

No content

Enable User

patch

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

patch

/api/users/{user_id}/enable

PATCH /api/users/{user_id}/enable HTTP/1.1
Accept: */*

No content

Force Reset User Password

post

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Body

emailstringRequired

first_namestringRequired

last_namestringRequired

tenant_adminbooleanRequired

mfa_configuredany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/api/users/{user_id}/force_reset_password

POST /api/users/{user_id}/force_reset_password HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "tenant_admin": true,
  "mfa_configured": false
}

{
  "ok": true,
  "message": "text"
}

Reset Password For User

post

Reset a user's password and send them a password reset email. This endpoint can only be called by tenant admins.

Authorizations

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/api/users/{user_id}/reset_password

POST /api/users/{user_id}/reset_password HTTP/1.1
Accept: */*

{
  "ok": true,
  "message": "text"
}

hashtagEnable Mfa

hashtagDisable Mfa

hashtagGenerate Qr Code

hashtagUnlock User

hashtagList Users

hashtagAdd User

hashtagSearch Users

hashtagGet User By Id

hashtagUpdate User

hashtagDelete User

hashtagDisable User

hashtagEnable User

hashtagForce Reset User Password

hashtagReset Password For User

Enable Mfa

Disable Mfa

Generate Qr Code

Unlock User

List Users

Add User

Search Users

Get User By Id

Update User

Delete User

Disable User

Enable User

Force Reset User Password

Reset Password For User