Users

Unlock User

patch

Authorizations

SessionCookie

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

patch

/api/users/{user_id}/unlock

HTTPcURLJavaScriptPython

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

No content

List Users

get

Authorizations

SessionCookie

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

404

Not found

422

Validation Error

application/json

get

/api/users

HTTPcURLJavaScriptPython

GET /api/users HTTP/1.1
Host: 
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": "2025-12-14T10:59:35.562Z",
      "last_login_attempt": "2025-12-14T10:59:35.562Z",
      "last_login": "2025-12-14T10:59:35.562Z",
      "mfa_configured": false
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Add User

post

Authorizations

SessionCookie

cookiestringRequired

Body

application/json

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

404

Not found

422

Validation Error

application/json

post

/api/users

HTTPcURLJavaScriptPython

POST /api/users HTTP/1.1
Host: 
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

HTTPBearer

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

HTTPcURLJavaScriptPython

GET /api/users/search HTTP/1.1
Host: 
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

SessionCookieHTTPBearer

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/users/{user_id}

HTTPcURLJavaScriptPython

GET /api/users/{user_id} HTTP/1.1
Host: 
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": "2025-12-14T10:59:35.562Z",
  "last_login_attempt": "2025-12-14T10:59:35.562Z",
  "last_login": "2025-12-14T10:59:35.562Z",
  "mfa_configured": false
}

Update User

post

Authorizations

SessionCookie

cookiestringRequired

Path parameters

user_idintegerRequired

Body

application/json

emailstringRequired

first_namestringRequired

last_namestringRequired

tenant_adminbooleanRequired

mfa_configuredany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/users/{user_id}

HTTPcURLJavaScriptPython

POST /api/users/{user_id} HTTP/1.1
Host: 
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

SessionCookie

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

/api/users/{user_id}

HTTPcURLJavaScriptPython

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

No content

Disable User

patch

Authorizations

SessionCookie

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

patch

/api/users/{user_id}/disable

HTTPcURLJavaScriptPython

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

No content

Enable User

patch

Authorizations

SessionCookie

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

patch

/api/users/{user_id}/enable

HTTPcURLJavaScriptPython

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

No content

Force Reset User Password

post

Authorizations

SessionCookie

cookiestringRequired

Path parameters

user_idintegerRequired

Body

application/json

emailstringRequired

first_namestringRequired

last_namestringRequired

tenant_adminbooleanRequired

mfa_configuredany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/users/{user_id}/force_reset_password

HTTPcURLJavaScriptPython

POST /api/users/{user_id}/force_reset_password HTTP/1.1
Host: 
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

SessionCookie

cookiestringRequired

Path parameters

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/users/{user_id}/reset_password

HTTPcURLJavaScriptPython

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

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

Enable Mfa

patch

Authorizations

SessionCookieHTTPBearer

cookiestringRequired

Responses

200

Successful Response

application/json

404

Not found

patch

/api/users/mfa/enable

HTTPcURLJavaScriptPython

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

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

Disable Mfa

patch

Authorizations

SessionCookieHTTPBearer

cookiestringRequired

Responses

200

Successful Response

application/json

404

Not found

patch

/api/users/mfa/disable

HTTPcURLJavaScriptPython

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

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

Generate Qr Code

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/users/mfa/generate

HTTPcURLJavaScriptPython

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

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