API docs by Redocly

Dark Web Api API (0.0.1)

Download OpenAPI specification :Download

License: APACHE 2.0

Dark Web Api API documentation

organization-resource

Update organization

Use this resource to update the information of the organization you own

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
id
integer <int64 >

The organization ID, this field it's required only for update an organization.If you do not provide this value when you update an organization, you will get a Bad Request (400) error
orgName
required
string

The organization name
orgDescription
string [ 0 .. 512 ] characters

Any description you want to add to the organization
domains
Array of strings

The list of domains you want to monitor
emails
Array of strings

The list of emails you want to monitor
users
Array of strings

The list of usernames you want to monitor
ips
Array of strings

The list of IPs you want to monitor
phones
Array of strings

The list of phones you want to monitor

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "orgName": "string",
  • "orgDescription": "string",
  • "domains": [
    ],
  • "emails": [
    ],
  • "users": [
    ],
  • "ips": [
    ],
  • "phones": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "orgName": "string",
  • "orgImage": "string",
  • "orgDescription": "string",
  • "totalDomainBreaches": 0,
  • "totalEmailsBreaches": 0,
  • "totalIpsBreaches": 0,
  • "totalUsernamesBreaches": 0,
  • "totalPhonesBreaches": 0,
  • "totalBreaches": 0
}

Create organization

Use this resource to create an organization and start monitoring the information related to it

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
id
integer <int64 >

The organization ID, this field it's required only for update an organization.If you do not provide this value when you update an organization, you will get a Bad Request (400) error
orgName
required
string

The organization name
orgDescription
string [ 0 .. 512 ] characters

Any description you want to add to the organization
domains
Array of strings

The list of domains you want to monitor
emails
Array of strings

The list of emails you want to monitor
users
Array of strings

The list of usernames you want to monitor
ips
Array of strings

The list of IPs you want to monitor
phones
Array of strings

The list of phones you want to monitor

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "orgName": "string",
  • "orgDescription": "string",
  • "domains": [
    ],
  • "emails": [
    ],
  • "users": [
    ],
  • "ips": [
    ],
  • "phones": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "orgName": "string",
  • "orgImage": "string",
  • "orgDescription": "string",
  • "totalDomainBreaches": 0,
  • "totalEmailsBreaches": 0,
  • "totalIpsBreaches": 0,
  • "totalUsernamesBreaches": 0,
  • "totalPhonesBreaches": 0,
  • "totalBreaches": 0
}

Delete an organization

Use this resource to delete an organization and all the related information

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
id
required
integer <int64 >

Responses

Update breach state

You can change the state of the breach as you execute the mitigation actions

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
breachStatus
required
string
Enum: "OPEN" "IN_MITIGATION" "COMPLETED"

Possible mitigation states for a breach
organizationId
required
integer <int64 >

The organization ID
breachIds
required
Array of integers <int64 > [ items <int64 > ]

A list of breach IDs which

Responses

Request samples

Content type
application/json
{
  • "breachStatus": "OPEN",
  • "organizationId": 0,
  • "breachIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "orgName": "string",
  • "orgImage": "string",
  • "orgDescription": "string",
  • "totalDomainBreaches": 0,
  • "totalEmailsBreaches": 0,
  • "totalIpsBreaches": 0,
  • "totalUsernamesBreaches": 0,
  • "totalPhonesBreaches": 0,
  • "totalBreaches": 0
}

Retrieve an organization

Retrieves an organization with the given ID

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64 >

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "orgName": "string",
  • "orgDescription": "string",
  • "domains": [
    ],
  • "emails": [
    ],
  • "users": [
    ],
  • "ips": [
    ],
  • "phones": [
    ],
  • "totalDomainBreaches": 0,
  • "totalEmailsBreaches": 0,
  • "totalIpsBreaches": 0,
  • "totalUsernamesBreaches": 0,
  • "totalPhonesBreaches": 0,
  • "totalBreaches": 0
}

Live search

Perform an instant search for any information you want to verify

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
field
required
string
Enum: "email" "domain" "ipAddress" "username" "password" "name" "vin" "address" "phone" "databaseName"

The type of information you want to search for
search
required
string

The search term
dateIni
string

Initial date
dateEnd
string

End date
page
integer >= 0
Default: 0

Zero-based page index (0..N)
size
integer >= 1
Default: 20

The size of the page to be returned
sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search organizations

Search for organizations you own, or you have access. The search results are paginated

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
id.greaterThan
integer <int64 >
id.lessThan
integer <int64 >
id.greaterThanOrEqual
integer <int64 >
id.lessThanOrEqual
integer <int64 >
id.equals
integer <int64 >
id.notEquals
integer <int64 >
id.specified
boolean
id.in
Array of integers <int64 > [ items <int64 > ]
id.notIn
Array of integers <int64 > [ items <int64 > ]
orgName.contains
string
orgName.doesNotContain
string
orgName.equals
string
orgName.notEquals
string
orgName.specified
boolean
orgName.in
Array of strings
orgName.notIn
Array of strings
createdDate.greaterThan
string <date-time >
createdDate.lessThan
string <date-time >
createdDate.greaterThanOrEqual
string <date-time >
createdDate.lessThanOrEqual
string <date-time >
createdDate.equals
string <date-time >
createdDate.notEquals
string <date-time >
createdDate.specified
boolean
createdDate.in
Array of strings <date-time >
createdDate.notIn
Array of strings <date-time >
page
integer >= 0
Default: 0

Zero-based page index (0..N)
size
integer >= 1
Default: 20

The size of the page to be returned
sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export breaches from organization

Export to a CSV format the breaches from an organization

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
organizationId
required
integer <int64 >

The organization ID
breachType
required
string
Enum: "DOMAIN" "EMAIL" "IP" "USER" "PHONE"
Example: breachType=DOMAIN

The type of information you want to export from the organization
search
string

Any search term you want to specify to filter the results to export
fields
Array of strings
Example: fields=domain,email,username,password,name,address

The list of fields in which you want the search term will be performed
dateIni
string
Example: dateIni=2022-12-13T11:21:20.000Z

Datetime value to get results greater than or equal to the passed value
breachStatus
string
Enum: "OPEN" "IN_MITIGATION" "COMPLETED"
Example: breachStatus=COMPLETED

The state of the breaches
dateEnd
string
Example: dateEnd=2023-03-13T11:21:20.000Z

Datetime value to get results less than or equal to the passed value

Responses

Export live search results

You can export the results of a live search into a CSV file

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
field
required
string
Enum: "email" "domain" "ipAddress" "username" "password" "name" "vin" "address" "phone" "databaseName"

Specify the field you want to search for before export the results
search
required
string

The search term
dateIni
string
Example: dateIni=2022-12-13T11:21:20.000Z

Datetime value to get results greater than or equal to the passed value
dateEnd
string
Example: dateEnd=2022-12-14T11:21:20.000Z

Datetime value to get results less than or equal to the passed value

Responses

Breaches status stats

You can obtain generic statistics about the mitigation status of each breach in your organizations

Authorizations:
(bearerAuthApiKeyAuth)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "opened": 0,
  • "completed": 0,
  • "orgName": "string",
  • "mitigation": 0
}

Filter organization breaches

You can perform filtering over your organization's breaches

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
organizationId
required
integer <int64 >

The organization ID
breachType
required
string
Enum: "DOMAIN" "EMAIL" "IP" "USER" "PHONE"
Example: breachType=DOMAIN

The type of information you want filtering
search
string

Any search term you want apply
fields
Array of strings
Example: fields=domain,email,username,password,name,address

The list of fields in which you want the search term will be performed
dateIni
string
Example: dateIni=2022-12-13T11:21:20.000Z

Datetime value to get results greater than or equal to the passed value
dateEnd
string
Example: dateEnd=2023-03-13T11:21:20.000Z

Datetime value to get results less than or equal to the passed value
breachStatus
string
Enum: "OPEN" "IN_MITIGATION" "COMPLETED"
Example: breachStatus=COMPLETED

The state of the breaches
page
integer >= 0
Default: 0

Zero-based page index (0..N)
size
integer >= 1
Default: 20

The size of the page to be returned
sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get organization stats

Get some organization stats, see response object for reference

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
breachStatus
required
string
Enum: "OPEN" "IN_MITIGATION" "COMPLETED"
organizationId
required
integer <int64 >

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "totalBreaches": 0,
  • "orgName": "string",
  • "totalDomainBreaches": 0,
  • "totalIpsBreaches": 0,
  • "totalUsernamesBreaches": 0,
  • "totalEmailsBreaches": 0,
  • "totalPhonesBreaches": 0
}

Breach status stats by organization

You can get and filter breach stats by organization ID

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
organizationId
required
integer <int64 >

The organization ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "opened": 0,
  • "completed": 0,
  • "orgName": "string",
  • "mitigation": 0
}

mitigation-steps-resource

Update mitigation steps

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64 >
Request Body schema: application/json
id
integer <int64 >
mitigationKey
string
mitigationStatus
string
Enum: "NOT_STARTED" "IN_PROGRESS" "DONE"
mitigationProcessStartDate
string <date-time >
organizationBreachId
required
integer <int64 >
mitigationBreachType
string
mitigationRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mitigationKey": "string",
  • "mitigationStatus": "NOT_STARTED",
  • "mitigationProcessStartDate": "2019-08-24T14:15:22Z",
  • "organizationBreachId": 0,
  • "mitigationBreachType": "string",
  • "mitigationRequired": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mitigationKey": "string",
  • "mitigationStatus": "NOT_STARTED",
  • "mitigationProcessStartDate": "2019-08-24T14:15:22Z",
  • "organizationBreachId": 0,
  • "mitigationBreachType": "string",
  • "mitigationRequired": true
}

Retrieve all mitigation steps of a breach

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
breachId
required
integer <int64 >
page
integer >= 0
Default: 0

Zero-based page index (0..N)
size
integer >= 1
Default: 20

The size of the page to be returned
sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mitigationKey": "string",
  • "mitigationStatus": "NOT_STARTED",
  • "mitigationProcessStartDate": "2019-08-24T14:15:22Z",
  • "organizationBreachId": 0,
  • "mitigationBreachType": "string",
  • "mitigationRequired": true
}

user-resource

getAllUsers

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
login.contains
string
login.doesNotContain
string
login.equals
string
login.notEquals
string
login.specified
boolean
login.in
Array of strings
login.notIn
Array of strings
createdBy.contains
string
createdBy.doesNotContain
string
createdBy.equals
string
createdBy.notEquals
string
createdBy.specified
boolean
createdBy.in
Array of strings
createdBy.notIn
Array of strings
verificationStatus.equals
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
verificationStatus.notEquals
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
verificationStatus.specified
boolean
verificationStatus.in
Array of strings
Items Enum : "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
verificationStatus.notIn
Array of strings
Items Enum : "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
page
integer >= 0
Default: 0

Zero-based page index (0..N)
size
integer >= 1
Default: 20

The size of the page to be returned
sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

updateUser

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
id
integer <int64 >
login
string [ 1 .. 50 ] characters ^(?>[a-zA-Z0-9!$&*+=?^_`{ |}~.-]+@[a-zA-Z0-9-]...
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
required
string [ 5 .. 254 ] characters
optionalEmails
string
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string
phoneNumber
string [ 0 .. 20 ] characters
credits
number <float >
paymentMethodType
string
Enum: "CARD" "COUPON"
verificationStatus
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
createdBy
string [ 0 .. 300 ] characters
createdDate
string <date-time >
lastModifiedBy
string
lastModifiedDate
string <date-time >
authorities
Array of strings unique
object (RestrictionDTO )
accountType
required
string
Enum: "MSP" "COMPANY" "PERSONAL" "MSP_CHILD" "COMPANY_CHILD" "PERSONAL_CHILD"
legalCompanyName
string
tacAccepted
required
boolean
tfaActive
boolean
firstLogin
boolean
parentId
integer <int64 >
organizations
Array of integers <int64 > [ items <int64 > ]
fullName
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "optionalEmails": "string",
  • "imageUrl": "string",
  • "activated": true,
  • "langKey": "string",
  • "phoneNumber": "string",
  • "credits": 0,
  • "paymentMethodType": "CARD",
  • "verificationStatus": "UNVERIFIED",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "restriction": {
    },
  • "accountType": "MSP",
  • "legalCompanyName": "string",
  • "tacAccepted": true,
  • "tfaActive": true,
  • "firstLogin": true,
  • "parentId": 0,
  • "organizations": [
    ],
  • "fullName": "string"
}

createUser

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
id
integer <int64 >
login
string [ 1 .. 50 ] characters ^(?>[a-zA-Z0-9!$&*+=?^_`{ |}~.-]+@[a-zA-Z0-9-]...
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
required
string [ 5 .. 254 ] characters
optionalEmails
string
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string
phoneNumber
string [ 0 .. 20 ] characters
credits
number <float >
paymentMethodType
string
Enum: "CARD" "COUPON"
verificationStatus
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
createdBy
string [ 0 .. 300 ] characters
createdDate
string <date-time >
lastModifiedBy
string
lastModifiedDate
string <date-time >
authorities
Array of strings unique
object (RestrictionDTO )
accountType
required
string
Enum: "MSP" "COMPANY" "PERSONAL" "MSP_CHILD" "COMPANY_CHILD" "PERSONAL_CHILD"
legalCompanyName
string
tacAccepted
required
boolean
tfaActive
boolean
firstLogin
boolean
parentId
integer <int64 >
organizations
Array of integers <int64 > [ items <int64 > ]
fullName
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "optionalEmails": "string",
  • "imageUrl": "string",
  • "activated": true,
  • "langKey": "string",
  • "phoneNumber": "string",
  • "credits": 0,
  • "paymentMethodType": "CARD",
  • "verificationStatus": "UNVERIFIED",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "restriction": {
    },
  • "accountType": "MSP",
  • "legalCompanyName": "string",
  • "tacAccepted": true,
  • "tfaActive": true,
  • "firstLogin": true,
  • "parentId": 0,
  • "organizations": [
    ],
  • "fullName": "string"
}

updateVerificationStatus

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
userId
required
integer <int64 >
status
required
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
statusObservation
string

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "status": "UNVERIFIED",
  • "statusObservation": "string"
}

activateDeactivateUser

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
userId
required
integer <int64 >
activate
required
boolean

Responses

notifyByEmail

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
text
required
string
userIds
Array of integers <int64 > [ items <int64 > ]
global
required
boolean

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "userIds": [
    ],
  • "global": true
}

bulkInviteUser

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
Array
id
integer <int64 >
login
string [ 1 .. 50 ] characters ^(?>[a-zA-Z0-9!$&*+=?^_`{ |}~.-]+@[a-zA-Z0-9-]...
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
required
string [ 5 .. 254 ] characters
optionalEmails
string
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string
phoneNumber
string [ 0 .. 20 ] characters
credits
number <float >
paymentMethodType
string
Enum: "CARD" "COUPON"
verificationStatus
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
createdBy
string [ 0 .. 300 ] characters
createdDate
string <date-time >
lastModifiedBy
string
lastModifiedDate
string <date-time >
authorities
Array of strings unique
object (RestrictionDTO )
accountType
required
string
Enum: "MSP" "COMPANY" "PERSONAL" "MSP_CHILD" "COMPANY_CHILD" "PERSONAL_CHILD"
legalCompanyName
string
tacAccepted
required
boolean
tfaActive
boolean
firstLogin
boolean
parentId
integer <int64 >
organizations
Array of integers <int64 > [ items <int64 > ]
fullName
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

getUser

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
login
required
string^(?>[a-zA-Z0-9!$&*+=?^_`{ |}~.-]+@[a-zA-Z0-9-]...

Responses

deleteUser

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
login
required
string^(?>[a-zA-Z0-9!$&*+=?^_`{ |}~.-]+@[a-zA-Z0-9-]...

Responses

account-resource

deactivateTfa

Authorizations:
(bearerAuthApiKeyAuth)

Responses

registerAccount

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
id
integer <int64 >
login
string [ 1 .. 50 ] characters ^(?>[a-zA-Z0-9!$&*+=?^_`{ |}~.-]+@[a-zA-Z0-9-]...
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
required
string [ 5 .. 254 ] characters
optionalEmails
string
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string
phoneNumber
string [ 0 .. 20 ] characters
credits
number <float >
paymentMethodType
string
Enum: "CARD" "COUPON"
verificationStatus
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
createdBy
string [ 0 .. 300 ] characters
createdDate
string <date-time >
lastModifiedBy
string
lastModifiedDate
string <date-time >
authorities
Array of strings unique
object (RestrictionDTO )
accountType
required
string
Enum: "MSP" "COMPANY" "PERSONAL" "MSP_CHILD" "COMPANY_CHILD" "PERSONAL_CHILD"
legalCompanyName
string
tacAccepted
required
boolean
tfaActive
boolean
firstLogin
boolean
parentId
integer <int64 >
organizations
Array of integers <int64 > [ items <int64 > ]
password
string [ 4 .. 100 ] characters
fullName
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "optionalEmails": "string",
  • "imageUrl": "string",
  • "activated": true,
  • "langKey": "string",
  • "phoneNumber": "string",
  • "credits": 0,
  • "paymentMethodType": "CARD",
  • "verificationStatus": "UNVERIFIED",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "restriction": {
    },
  • "accountType": "MSP",
  • "legalCompanyName": "string",
  • "tacAccepted": true,
  • "tfaActive": true,
  • "firstLogin": true,
  • "parentId": 0,
  • "organizations": [
    ],
  • "password": "string",
  • "fullName": "string"
}

isAuthenticated

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getAccount

Authorizations:
(bearerAuthApiKeyAuth)

Responses

saveAccount

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
id
integer <int64 >
login
string [ 1 .. 50 ] characters ^(?>[a-zA-Z0-9!$&*+=?^_`{ |}~.-]+@[a-zA-Z0-9-]...
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
required
string [ 5 .. 254 ] characters
optionalEmails
string
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string
phoneNumber
string [ 0 .. 20 ] characters
credits
number <float >
paymentMethodType
string
Enum: "CARD" "COUPON"
verificationStatus
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
createdBy
string [ 0 .. 300 ] characters
createdDate
string <date-time >
lastModifiedBy
string
lastModifiedDate
string <date-time >
authorities
Array of strings unique
object (RestrictionDTO )
accountType
required
string
Enum: "MSP" "COMPANY" "PERSONAL" "MSP_CHILD" "COMPANY_CHILD" "PERSONAL_CHILD"
legalCompanyName
string
tacAccepted
required
boolean
tfaActive
boolean
firstLogin
boolean
parentId
integer <int64 >
organizations
Array of integers <int64 > [ items <int64 > ]
fullName
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "optionalEmails": "string",
  • "imageUrl": "string",
  • "activated": true,
  • "langKey": "string",
  • "phoneNumber": "string",
  • "credits": 0,
  • "paymentMethodType": "CARD",
  • "verificationStatus": "UNVERIFIED",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "restriction": {
    },
  • "accountType": "MSP",
  • "legalCompanyName": "string",
  • "tacAccepted": true,
  • "tfaActive": true,
  • "firstLogin": true,
  • "parentId": 0,
  • "organizations": [
    ],
  • "fullName": "string"
}

deleteAccount

Authorizations:
(bearerAuthApiKeyAuth)

Responses

setupPaymentMethod

Establishes a payment method for the user

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
type
required
string
Enum: "CARD" "COUPON"
data
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "CARD",
  • "data": "string"
}

finishTfaReset

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

requestPasswordReset

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

finishPasswordReset

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
key
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "newPassword": "string"
}

changePassword

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
currentPassword
required
string [ 4 .. 100 ] characters
newPassword
required
string [ 4 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string"
}

generateApiKey

Authorizations:
(bearerAuthApiKeyAuth)

Responses

activateInvitationAccount

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
key
required
string [ 1 .. 50 ] characters
newPassword
string
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
orgId
Array of integers <int64 > [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "newPassword": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "orgId": [
    ]
}

validateEmail

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
login
required
string

Responses

setupGoogleAuthenticator

Authorizations:
(bearerAuthApiKeyAuth)

Responses

finishSetupGoogleAuthenticator

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
code
required
string

Responses

configureStripe

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getCardDetails

Authorizations:
(bearerAuthApiKeyAuth)

Responses

cancelStripeConfiguration

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
setupIntentId
required
string

Responses

getUserStatistic

Authorizations:
(bearerAuthApiKeyAuth)

Responses

requestTfaReset

Authorizations:
(bearerAuthApiKeyAuth)

Responses

removeFirstLoginCondition

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getRemainingRestrictionStatus

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getAccountOrganizationPermission

Authorizations:
(bearerAuthApiKeyAuth)

Responses

emailExist

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
email
required
string

Responses

checkPaymentStatus

Check if the current user has enough credits or a card to pay for the application services

Authorizations:
(bearerAuthApiKeyAuth)

Responses

checkPaymentInformation

Check if the current user login has a payment method defined

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getApiKey

Authorizations:
(bearerAuthApiKeyAuth)

Responses

activateAccount

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
key
required
string

Responses

cancelSubscription

Authorizations:
(bearerAuthApiKeyAuth)

Responses

user-verification-info-resource

createUserVerificationInfo

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
createdDate
string <date-time >
id
integer <int64 >
legalCompanyName
required
string [ 0 .. 250 ] characters
registrationNumber
required
string
incorporationState
required
string
incorporationCountry
required
string
verificationStatus
required
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
verificationStatusObservation
string

Responses

Request samples

Content type
application/json
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "legalCompanyName": "string",
  • "registrationNumber": "string",
  • "incorporationState": "string",
  • "incorporationCountry": "string",
  • "verificationStatus": "UNVERIFIED",
  • "verificationStatusObservation": "string"
}

getUserVerificationInfo

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getUserVerificationInfo_1

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
id.greaterThan
integer <int64 >
id.lessThan
integer <int64 >
id.greaterThanOrEqual
integer <int64 >
id.lessThanOrEqual
integer <int64 >
id.equals
integer <int64 >
id.notEquals
integer <int64 >
id.specified
boolean
id.in
Array of integers <int64 > [ items <int64 > ]
id.notIn
Array of integers <int64 > [ items <int64 > ]
legalCompanyName.contains
string
legalCompanyName.doesNotContain
string
legalCompanyName.equals
string
legalCompanyName.notEquals
string
legalCompanyName.specified
boolean
legalCompanyName.in
Array of strings
legalCompanyName.notIn
Array of strings
registrationNumber.contains
string
registrationNumber.doesNotContain
string
registrationNumber.equals
string
registrationNumber.notEquals
string
registrationNumber.specified
boolean
registrationNumber.in
Array of strings
registrationNumber.notIn
Array of strings
incorporationState.contains
string
incorporationState.doesNotContain
string
incorporationState.equals
string
incorporationState.notEquals
string
incorporationState.specified
boolean
incorporationState.in
Array of strings
incorporationState.notIn
Array of strings
incorporationCountry.contains
string
incorporationCountry.doesNotContain
string
incorporationCountry.equals
string
incorporationCountry.notEquals
string
incorporationCountry.specified
boolean
incorporationCountry.in
Array of strings
incorporationCountry.notIn
Array of strings
verificationStatus.equals
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
verificationStatus.notEquals
string
Enum: "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
verificationStatus.specified
boolean
verificationStatus.in
Array of strings
Items Enum : "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
verificationStatus.notIn
Array of strings
Items Enum : "UNVERIFIED" "VERIFIED" "VERIFYING" "REJECTED" "PENDING"
createdBy.contains
string
createdBy.doesNotContain
string
createdBy.equals
string
createdBy.notEquals
string
createdBy.specified
boolean
createdBy.in
Array of strings
createdBy.notIn
Array of strings
page
integer >= 0
Default: 0

Zero-based page index (0..N)
size
integer >= 1
Default: 20

The size of the page to be returned
sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

user-jwt-controller

authorize

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
username
required
string [ 1 .. 50 ] characters
password
required
string [ 4 .. 100 ] characters
rememberMe
boolean

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "rememberMe": true
}

verifyTFACode

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
code
required
string

Responses

public-user-resource

getAllPublicUsers

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (Pageable)

Responses

getAuthorities

Authorizations:
(bearerAuthApiKeyAuth)

Responses

mitigation-history-resource

getAllMitigationHistories

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
breachId
required
integer <int64 >
page
integer >= 0
Default: 0

Zero-based page index (0..N)
size
integer >= 1
Default: 20

The size of the page to be returned
sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

chart-resource

singleOrganizationPercentStatistic

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
organizationId
required
integer <int64 >
top
required
integer <int32 >

Responses

organizationsGeneralStatistic

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
top
required
integer <int32 >

Responses

organizationsGeneralPercentStatistic

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
top
required
integer <int32 >

Responses

application-use-record-resource

getAllApplicationUseRecords

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UsageRecordCriteria )
required
object (Pageable)

Responses