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

Accesses

Operations

Assets

Operations

Identities

Operations

ListIdentities

Request

Returns a list of identities sorted by latest activity time in descending order.

Security
AuthorizationHeader
Query
frominteger

Page number

sizeinteger

Record per page. Default no of records per page is 50. Maximum allowed records per page is 1000.

latest_activity_time_gtstring

Returns list of identities having latest activity time greater than the specified time if provided. The format of time is 'YYYY-MM-DD HH:MM:SS'.

scorenumber

Filters identities to include only those with a posture score greater than or equal to the specified value. Score must be greater than or equal to 0.0

typestring

Identity type

identity_statusstring

Identity status

curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/identities?from=0&size=0&latest_activity_time_gt=string&score=0&type=string&identity_status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
errorstring
resultobject(models.OutListIdentityResultResponse)
successboolean
Response
application/json
{
  "error": "string",
  "result": {
    "data": [ … ],
    "total": 0
  },
  "success": true
}

GetIdentityDetail

Request

Returns identity details

Security
AuthorizationHeader
Query
identifierstringrequired

Identity type

curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/identity/details?identifier=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
errorstring
resultobject(models.DetailResult)
successboolean
Response
application/json
{
  "error": "string",
  "result": {
    "full_name": "string",
    "score": 0,
    "latest_activity_time": "2019-08-24T14:15:22Z",
    "flow_count": 0,
    "asset_count": 0,
    "is_known": true,
    "issue_count": 0,
    "issue_details": { … }
  },
  "success": true
}

ListIdentityHosts

Request

Returns a list of hosts associated with an identity sorted by latest activity time in descending order.

Security
AuthorizationHeader
Query
identifierstringrequired

Identity Name

frominteger

Page number

sizeinteger

Record per page. Default no of records per page is 50. Maximum allowed records per page is 100.

latest_activity_time_gtstring

Returns list of identity hosts having latest activity time greater than the specified time if provided. The format of time is 'YYYY-MM-DD HH:MM:SS'.

curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/identity/hosts?identifier=string&from=0&size=0&latest_activity_time_gt=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
errorstring
resultobject(models.IdentityHostsMainResultResponseOut)
successboolean
Response
application/json
{
  "error": "string",
  "result": {
    "data": [ … ],
    "total": 0
  },
  "success": true
}

IdentitySystems

Operations