Skip to content

AuthMind API (1.0.0)

Welcome to AuthMind API documentation. This guide is designed to help developers understand how to integrate and interact with our APIs effectively. Here, you will find detailed information on the various endpoints, request and response formats, authentication mechanisms, and best practices for using our APIs.

AuthMind APIs are built to provide seamless access to our services, allowing you to enhance your applications with powerful features and functionalities. Whether you are looking to retrieve data or manage resources, our comprehensive API documentation will guide you through each step of the process.

Key Sections of this Documentation

Getting Started: Learn how to generate tokens to access the APIs and API documentation.

Endpoints: Detailed descriptions of each endpoint, including parameters, request, and response structures.

We are committed to providing a user-friendly API experience. Let's get started!

Getting Started

  1. Log in to AuthMind and go to the Admin section.
  2. From the left navigation, click API Tokens. The Manage API Tokens page is displayed
  3. From the top-right side, click Add. The Add API Client dialog is displayed.
  4. Enter a name for the client.
  5. By default, a one-year expiration date is set from the creation date of the token. You can change this date, as required.
  6. Click Submit. A success message is displayed. You can also see a Token Details dialog that contains the API token (JWT).
  7. Copy the token.
  8. Click OK to close the Token Details dialog. You can see the token is listed on the Manage API Tokens page.
Download OpenAPI description
docs.json
docs.yaml
Overview
URL

https://www.authmind.com

AuthMind

support@authmind.com

License

AuthMind Terms of Use

Languages
Servers
Mock server

https://apidoc.authmind.com/_mock/docs/

https://apidoc.authmind.com/{{.Host}}/amapi/v1/

Users

Operations

Issues

Operations

GetIssueList

Request

Get a list of issue to import into your SIEM. Issues are one or more incidents that have been grouped by the Issue Keys. To receive a stream of the latest issues, save the issue id as bookmark and query on some interval for the latest issues that > this bookmark, ie the latest issue id you have previously queried. For additional details about each issue, you can query the GetIssueDetails API for the specific issue id

Security
AuthorizationHeader
Query
issue_typestring

Used to retrieve only a specific issue type. If left empty, the issues will be retrieved for all the types.(recommended)

Enum"Access from Anonymous IP""Access from Public VPN""Access from Unauthorized Countries""Access to Anonymous IP""Access to Public VPN""Access to Unauthorized Countries""Auth Hash Quality""Auth Hash Security""Auth Protocol Quality""Compromised Password"
issue_id_gtstring

Used to retrieve latest issues by issue id. All issues > this parameter will be returned (recommended)

issue_time_gtstring(date-time)

Used to retrieve latest issues by Date / Time. All issues > this parameter will be returnedIf neither the issue_id_gt parameter field or this field is provided as parameter, the returns will default to the last 7 days. e.g. '2024-01-02 15:04:05'

sort_orderstring

Sorting order, Default value is DESC.

Enum"ASC""DESC"
sort_bystring

Field to sort by, Default value is issue_time.

Enum"issue_id""issue_time""flow_count""incident_count""risk"
frominteger

Starting point for pagination, Default value 0.

sizeinteger

Maximum number of records to return for pagination, Default value 1000.

curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/getIssues?issue_type=Access+from+Anonymous+IP&issue_id_gt=string&issue_time_gt=2019-08-24T14%3A15%3A22Z&sort_order=ASC&sort_by=issue_id&from=0&size=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful response

Bodyapplication/json
successboolean

Indicates if the request was successful.

resultsArray of objects
metadataobject

Response metadata

Response
application/json
{
  "success": true,
  "results": [
    { … }
  ],
  "metadata": {}
}

GetIssueDetails

Request

Get specific details about an issue and all related incidents for the issue.

Security
AuthorizationHeader
Query
issue_idstringrequired

Issue Id to fetch issue details. e.g. 17263-1722579276407

sort_orderstring

Sorting order, Default value is DESC.

Enum"ASC""DESC"
sort_bystring

Sort by field for incidents, Default value is last_seen.

Enum"incident_id""incident_risk""flow_count""last_seen""first_seen"
frominteger

Starting point for pagination, Default value 0.

sizeinteger

Maximum number of records to return for pagination, Default value 1000.

curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/getIssueDetails?issue_id=string&sort_order=ASC&sort_by=incident_id&from=0&size=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful response.

Bodyapplication/json
successboolean

Indicates if the request was successful.

resultsArray of objects
metadataobject

Response metadata.

Response
application/json
{
  "success": true,
  "results": [
    { … }
  ],
  "metadata": {}
}

Accesses

Operations

Assets

Operations

Identities

Operations

IdentitySystems

Operations