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

GetAccessesList

Request

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

Security
AuthorizationHeader
Query
latest_activity_time_gtstring

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

identity_typestring

Identity type

directory_typestring

Directory Type

Enum"On-premise""Cloud IDP"
directory_namestring

Directory Name

identitystring

Identity Name

assetstring

Asset Name

asset_typestring

Asset Type

frominteger

Page number

sizeinteger

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

scorenumber

Filters accesses 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

curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/accesses?latest_activity_time_gt=string&identity_type=string&directory_type=On-premise&directory_name=string&identity=string&asset=string&asset_type=string&from=0&size=0&score=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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

GetAccessDetails

Request

Returns access details

Security
AuthorizationHeader
Query
identity_namestringrequired

Identity Name

identity_typestringrequired

Identity Type

asset_namestringrequired

Asset Name

asset_typestringrequired

Asset Type

directory_namestring

Directory Name if present

curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/access/details?identity_name=string&identity_type=string&asset_name=string&asset_type=string&directory_name=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
errorstring
resultobject
successboolean
Response
application/json
{
  "error": "string",
  "result": {
    "_id": "string",
    "flow_count": 0,
    "latest_activity_time": "2019-08-24T14:15:22Z",
    "score": 0,
    "asset_protocol": "string",
    "asset_is_known": true,
    "identity_is_known": true,
    "identity_system": { … }
  },
  "success": true
}

ListAccessSourceHosts

Request

Returns list of source hosts associated with an access, sorted by latest activity time in descending order.

Security
AuthorizationHeader
Query
identifierstringrequired

Access ID

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 access source 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/access/sourcehosts?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
}

ListAccessDestHosts

Request

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

Security
AuthorizationHeader
Query
identifierstringrequired

Access ID

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 access destination 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/access/destinationhosts?identifier=string&from=0&size=0&latest_activity_time_gt=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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

Assets

Operations

Identities

Operations

IdentitySystems

Operations