Malwarebytes Users API
The Users API from Malwarebytes — 5 operation(s) for users.
OpenAPI Specification
openapi: 3.2.0
info:
title: Malwarebytes Users API
version: 1.0.0
description: 'Operations tagged Users across 2 of this provider''s published API definitions: malwarebytes-threatdown-nebula-openapi.json, malwarebytes-threatdown-oneview-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.threatdown.com
tags:
- name: Users
paths:
/nebula/v1/users/{id}:
servers:
- url: https://api.threatdown.com
delete:
description: Delete a nebula user.
summary: Delete a nebula user
security:
- client_credentials:
- write
- user_permissions:
- users.delete
status:
outage:
- auth
parameters:
- name: id
required: true
in: path
description: Valid UUID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
- name: authorization
required: true
in: header
description: Authorization token
schema:
type: string
- name: accountid
required: true
in: header
description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
responses:
'200':
description: Successful response
tags:
- Users
operationId: api.nebula.delete.users
get:
description: Get one user.
summary: Get one user
security:
- client_credentials:
- read
- user_permissions:
- users.view
status:
outage:
- auth
parameters:
- name: id
required: true
in: path
description: Valid UUID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
- name: authorization
required: true
in: header
description: Authorization token
schema:
type: string
- name: accountid
required: true
in: header
description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
responses:
'200':
description: response schema
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema
type: object
title: Nebula user model
description: Nebula user model
examples:
- id: 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
display_name: Alice Bob
email: alicebob@malwarebytes.com
last_login_at: '2018-10-05T15:15:36.116105Z'
unconfirmed_email: ''
ars_permission: true
role: SuperAdmin
impersonation_authorized_until: null
all_groups_access: true
group_ids: []
otp_enabled: false
otp_recovery_email: test@gmail.com
otp_recovery_email_status: Verified
required:
- id
- account_id
- display_name
- role
- all_groups_access
- group_ids
properties:
id:
type: string
title: The id schema
description: The unique identifier of the user.
default: ''
examples:
- 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
ars_permission:
type: boolean
title: ARS permission
description: ARS permission for the iuser
default: false
examples:
- false
account_id:
type: string
title: The account_id
description: Account id.
default: ''
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
display_name:
type: string
title: User display ame
description: The display name of the user.
default: ''
examples:
- Alice Bob
email:
type: string
title: Email
description: Email.
default: ''
examples:
- alicebob@malwarebytes.com
last_login_at:
type: string
title: The last time this user logged in
description: Last login time
default: ''
examples:
- '2018-10-05T15:15:36.116105Z'
unconfirmed_email:
type: string
title: Unconfirmed email
description: Unconfirmed email.
default: ''
examples:
- ''
role:
type: string
title: The Role of the user
description: The role of the user.
enum:
- SuperAdmin
- Admin
- ReadOnlyUser
examples:
- SuperAdmin
all_groups_access:
type: boolean
title: Whether the user has access to all groups or not (applies to admin and readonly users)
default: false
examples:
- true
group_ids:
type: array
title: The group_ids schema
default: []
additionalItems: true
items:
type: string
title: Unique identifier of groups to which this user is assigned to
otp_enabled:
type: boolean
title: The otp_enabled schema
description: Whether OTP is enabled or not.
default: false
examples:
- false
otp_recovery_email:
type: string
title: The opt recovery email
description: The opt recovery email
default: ''
examples:
- alicebob@malwarebytes.com
otp_recovery_email_status:
type: string
title: The opt recovery email status
description: The opt recovery email status
default: AwaitingSetup
examples:
- AwaitingSetup
- PendingVerification
- ExpiredVerification
- Verified
tags:
- Users
operationId: api.nebula.get.user
put:
description: Update user.
summary: Update user
security:
- client_credentials:
- write
- user_permissions:
- users.edit
status:
outage:
- auth
parameters:
- name: id
required: true
in: path
description: Valid UUID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
- name: authorization
required: true
in: header
description: Authorization token
schema:
type: string
- name: accountid
required: true
in: header
description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
requestBody:
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema
type: object
title: Nebula user model
description: Nebula user model
examples:
- role: SuperAdmin
all_groups_access: true
group_ids: []
required:
- role
- all_groups_access
- group_ids
properties:
role:
type: string
title: The Role of the user
description: The role of the user.
enum:
- SuperAdmin
- Admin
- ReadOnlyUser
examples:
- SuperAdmin
ars_permission:
type: boolean
title: ARS permission
description: ARS permission for the user
default: false
examples:
- false
all_groups_access:
type: boolean
title: Whether the user has access to all groups or not (applies to admin and readonly users)
default: false
examples:
- true
group_ids:
type: array
title: The group_ids schema
default: []
additionalItems: true
items:
type: string
title: Unique identifier of groups to which this user is assigned to
update_role_across_accounts:
description: update the role across all the user accounts
type: boolean
default: false
responses:
'200':
description: response schema
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema
type: object
title: Nebula user model
description: Nebula user model
examples:
- id: 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
display_name: Alice Bob
email: alicebob@malwarebytes.com
last_login_at: '2018-10-05T15:15:36.116105Z'
unconfirmed_email: ''
ars_permission: true
role: SuperAdmin
impersonation_authorized_until: null
all_groups_access: true
group_ids: []
otp_enabled: false
otp_recovery_email: test@gmail.com
otp_recovery_email_status: Verified
required:
- id
- account_id
- display_name
- role
- all_groups_access
- group_ids
properties:
id:
type: string
title: The id schema
description: The unique identifier of the user.
default: ''
examples:
- 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
ars_permission:
type: boolean
title: ARS permission
description: ARS permission for the iuser
default: false
examples:
- false
account_id:
type: string
title: The account_id
description: Account id.
default: ''
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
display_name:
type: string
title: User display ame
description: The display name of the user.
default: ''
examples:
- Alice Bob
email:
type: string
title: Email
description: Email.
default: ''
examples:
- alicebob@malwarebytes.com
last_login_at:
type: string
title: The last time this user logged in
description: Last login time
default: ''
examples:
- '2018-10-05T15:15:36.116105Z'
unconfirmed_email:
type: string
title: Unconfirmed email
description: Unconfirmed email.
default: ''
examples:
- ''
role:
type: string
title: The Role of the user
description: The role of the user.
enum:
- SuperAdmin
- Admin
- ReadOnlyUser
examples:
- SuperAdmin
all_groups_access:
type: boolean
title: Whether the user has access to all groups or not (applies to admin and readonly users)
default: false
examples:
- true
group_ids:
type: array
title: The group_ids schema
default: []
additionalItems: true
items:
type: string
title: Unique identifier of groups to which this user is assigned to
otp_enabled:
type: boolean
title: The otp_enabled schema
description: Whether OTP is enabled or not.
default: false
examples:
- false
otp_recovery_email:
type: string
title: The opt recovery email
description: The opt recovery email
default: ''
examples:
- alicebob@malwarebytes.com
otp_recovery_email_status:
type: string
title: The opt recovery email status
description: The opt recovery email status
default: AwaitingSetup
examples:
- AwaitingSetup
- PendingVerification
- ExpiredVerification
- Verified
tags:
- Users
operationId: api.nebula.put.users
/nebula/v1/users:
servers:
- url: https://api.threatdown.com
get:
description: Get nebula users.
summary: Get nebula users
security:
- client_credentials:
- read
- user_permissions:
- users.view
status:
outage:
- auth
parameters:
- name: authorization
required: true
in: header
description: Authorization token
schema:
type: string
- name: accountid
required: true
in: header
description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
- name: next_cursor
required: false
in: query
description: The pagination cursor for next set of results. For further documentation, check Pagination section.
schema:
type: string
responses:
'200':
description: response schema
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema
type: object
title: Get users response schema
description: Get users response schema.
examples:
- users:
- id: 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
display_name: Alice Bob
email: alicebob@malwarebytes.com
last_login_at: '2018-10-05T15:15:36.116105Z'
unconfirmed_email: ''
role: SuperAdmin
impersonation_authorized_until: null
all_groups_access: true
group_ids: []
otp_enabled: false
otp_recovery_email: test@gmail.com
otp_recovery_email_status: Verified
total_count: 1
next_cursor: eyJzdGFydF9pbmRleCI6MTAwfQ==
required:
- users
- total_count
- next_cursor
properties:
users:
type: array
title: List of users
description: List of users.
items:
$schema: http://json-schema.org/draft-07/schema
type: object
title: Nebula user model
description: Nebula user model
examples:
- id: 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
display_name: Alice Bob
email: alicebob@malwarebytes.com
last_login_at: '2018-10-05T15:15:36.116105Z'
unconfirmed_email: ''
ars_permission: true
role: SuperAdmin
impersonation_authorized_until: null
all_groups_access: true
group_ids: []
otp_enabled: false
otp_recovery_email: test@gmail.com
otp_recovery_email_status: Verified
required:
- id
- account_id
- display_name
- role
- all_groups_access
- group_ids
properties:
id:
type: string
title: The id schema
description: The unique identifier of the user.
default: ''
examples:
- 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
ars_permission:
type: boolean
title: ARS permission
description: ARS permission for the iuser
default: false
examples:
- false
account_id:
type: string
title: The account_id
description: Account id.
default: ''
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
display_name:
type: string
title: User display ame
description: The display name of the user.
default: ''
examples:
- Alice Bob
email:
type: string
title: Email
description: Email.
default: ''
examples:
- alicebob@malwarebytes.com
last_login_at:
type: string
title: The last time this user logged in
description: Last login time
default: ''
examples:
- '2018-10-05T15:15:36.116105Z'
unconfirmed_email:
type: string
title: Unconfirmed email
description: Unconfirmed email.
default: ''
examples:
- ''
role:
type: string
title: The Role of the user
description: The role of the user.
enum:
- SuperAdmin
- Admin
- ReadOnlyUser
examples:
- SuperAdmin
all_groups_access:
type: boolean
title: Whether the user has access to all groups or not (applies to admin and readonly users)
default: false
examples:
- true
group_ids:
type: array
title: The group_ids schema
default: []
additionalItems: true
items:
type: string
title: Unique identifier of groups to which this user is assigned to
otp_enabled:
type: boolean
title: The otp_enabled schema
description: Whether OTP is enabled or not.
default: false
examples:
- false
otp_recovery_email:
type: string
title: The opt recovery email
description: The opt recovery email
default: ''
examples:
- alicebob@malwarebytes.com
otp_recovery_email_status:
type: string
title: The opt recovery email status
description: The opt recovery email status
default: AwaitingSetup
examples:
- AwaitingSetup
- PendingVerification
- ExpiredVerification
- Verified
total_count:
type: integer
title: The total_count schema
description: Total count of users.
default: 0
examples:
- 1
next_cursor:
type: string
title: The pagination cursor for next set of results. For further documentation, check Pagination section.
examples:
- eyJzdGFydF9pbmRleCI6MTAwfQ==
tags:
- Users
operationId: api.nebula.get.users
post:
description: Create user.
summary: Create user
security:
- client_credentials:
- write
- user_permissions:
- users.create
status:
outage:
- auth
parameters:
- name: authorization
required: true
in: header
description: Authorization token
schema:
type: string
- name: accountid
required: true
in: header
description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
requestBody:
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema
type: object
title: Nebula user model
description: Nebula user model
examples:
- email: alicebob@malwarebytes.com
role: SuperAdmin
all_groups_access: true
group_ids: []
required:
- email
- role
- all_groups_access
- group_ids
properties:
email:
type: string
title: Email
description: Email.
examples:
- alicebob@malwarebytes.com
ars_permission:
type: boolean
title: ARS permission
description: ARS permission for the user
default: false
examples:
- false
role:
type: string
title: The Role of the user
description: The role of the user.
enum:
- SuperAdmin
- Admin
- ReadOnlyUser
examples:
- SuperAdmin
all_groups_access:
type: boolean
title: Whether the user has access to all groups or not (applies to admin and readonly users)
default: false
examples:
- true
group_ids:
type: array
title: The group_ids schema
default: []
additionalItems: true
items:
type: string
title: Unique identifier of groups to which this user is assigned to
responses:
'200':
description: response schema
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema
type: object
title: Nebula user model
description: Nebula user model
examples:
- id: 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
display_name: Alice Bob
email: alicebob@malwarebytes.com
last_login_at: '2018-10-05T15:15:36.116105Z'
unconfirmed_email: ''
ars_permission: true
role: SuperAdmin
impersonation_authorized_until: null
all_groups_access: true
group_ids: []
otp_enabled: false
otp_recovery_email: test@gmail.com
otp_recovery_email_status: Verified
required:
- id
- account_id
- display_name
- role
- all_groups_access
- group_ids
properties:
id:
type: string
title: The id schema
description: The unique identifier of the user.
default: ''
examples:
- 16ea2ecb-bc28-43e2-b66f-9edc48bef56f
ars_permission:
type: boolean
title: ARS permission
description: ARS permission for the iuser
default: false
examples:
- false
account_id:
type: string
title: The account_id
description: Account id.
default: ''
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
display_name:
type: string
title: User display ame
description: The display name of the user.
default: ''
examples:
- Alice Bob
email:
type: string
title: Email
description: Email.
default: ''
examples:
- alicebob@malwarebytes.com
last_login_at:
type: string
title: The last time this user logged in
description: Last login time
default: ''
examples:
- '2018-10-05T15:15:36.116105Z'
unconfirmed_email:
type: string
title: Unconfirmed email
description: Unconfirmed email.
default: ''
examples:
- ''
role:
type: string
title: The Role of the user
description: The role of the user.
enum:
- SuperAdmin
- Admin
- ReadOnlyUser
examples:
- SuperAdmin
all_groups_access:
type: boolean
title: Whether the user has access to all groups or not (applies to admin and readonly users)
default: false
examples:
- true
group_ids:
type: array
title: The group_ids schema
default: []
additionalItems: true
items:
type: string
title: Unique identifier of groups to which this user is assigned to
otp_enabled:
type: boolean
title: The otp_enabled schema
description: Whether OTP is enabled or not.
default: false
examples:
- false
otp_recovery_email:
type: string
title: The opt recovery email
description: The opt recovery email
default: ''
examples:
- alicebob@malwarebytes.com
otp_recovery_email_status:
type: string
title: The opt recovery email status
description: The opt recovery email status
default: AwaitingSetup
examples:
- AwaitingSetup
- PendingVerification
- ExpiredVerification
- Verified
tags:
- Users
operationId: api.nebula.post.users
/oneview/v1/users:
servers:
- url: https://api.threatdown.com
post:
description: Create a new OneView User
summary: Create new user
security:
- client_credentials:
- write
- user_permissions:
- users.create
status:
outage:
- auth
- ov
parameters:
- name: authorization
required: true
in: header
description: Authorization token
schema:
type: string
requestBody:
content:
application/json:
schema:
$schema: http://json-schema.org/draft-07/schema
type: object
title: The body for creating a new user
description: The payload
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/malwarebytes/refs/heads/main/openapi/malwarebytes-users-api-openapi.yml