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

ListRoles

Request

Fetches list of roles. User must have a valid token with required permissions.

Security
AuthorizationHeader
curl -i -X GET \
  https://apidoc.authmind.com/_mock/docs/roles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
errorstring
resultArray of strings
successboolean
Response
application/json
{
  "error": "string",
  "result": [
    "string"
  ],
  "success": true
}

ListUsers

Request

Fetches list of active users associated with a company. User must have a valid token with required permissions.

Security
AuthorizationHeader
Query
frominteger

Page number

sizeinteger

Records per page. By default no of records per page is 50.

identifierstring

Name or email Id of the user to search

sort_bystring

Sort by field name

Enum"name""email""added_date""last_login""status""ip""role"
orderstring

Order by asc or desc

Enum"asc""desc"
curl -i -X GET \
  'https://apidoc.authmind.com/_mock/docs/users?from=0&size=0&identifier=string&sort_by=name&order=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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

AddUser

Request

Add user by specifying relevant fields. User must have a valid token with required permissions.

Security
AuthorizationHeader
Bodyapplication/jsonrequired
namestringrequired
emailstringrequired
rolestringrequired
passwordstring or null
localestring or null
curl -i -X POST \
  https://apidoc.authmind.com/_mock/docs/user \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "email": "string",
    "role": "string",
    "password": "string",
    "locale": "string"
  }'

Responses

OK

Bodyapplication/json
errorsstring
successboolean
Response
application/json
{
  "errors": "string",
  "success": true
}

DeleteUser

Request

Delete user by specifying id or email. Either id or email is required. If both are provided then an error is returned. The user must have a token with valid permissions.

Security
AuthorizationHeader
Query
emailstring

Email of the user to delete

idstring

Id of the user to delete

curl -i -X DELETE \
  'https://apidoc.authmind.com/_mock/docs/user?email=string&id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
errorsstring
successboolean
Response
application/json
{
  "success": true
}

UpdateUser

Request

Update user by specifying id or email. Either id or email is required. If both are provided then an error is returned. The user must have a token with valid permissions.

Security
AuthorizationHeader
Query
emailstring

Email of the user to update

idstring

Id of the user to be updated

Bodyapplication/jsonrequired
namestring or null
emailstring or null
rolestring or null
old_passwordstring or null
passwordstring or null
localestring or null
curl -i -X PATCH \
  'https://apidoc.authmind.com/_mock/docs/user?email=string&id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "email": "string",
    "role": "string",
    "old_password": "string",
    "password": "string",
    "locale": "string"
  }'

Responses

OK

Bodyapplication/json
errorsstring
successboolean
Response
application/json
{
  "success": true
}

Issues

Operations

Accesses

Operations

Assets

Operations

Identities

Operations

IdentitySystems

Operations