# AuthMind API 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. Version: 1.0.0 License: AuthMind Terms of Use ## Servers ``` {{.Host}}/amapi/v1 ``` ## Security ### AuthorizationHeader Authenticate with Authmind API token. We can get API token from step 7 of Getting Started. Type: http Scheme: bearer ## Download OpenAPI description [AuthMind API](https://apidoc.authmind.com/_spec/docs.yaml) ## Users ### ListRoles - [GET /roles](https://apidoc.authmind.com/docs/users/paths/~1roles/get.md): Fetches list of roles. User must have a valid token with required permissions. ### ListUsers - [GET /users](https://apidoc.authmind.com/docs/users/paths/~1users/get.md): Fetches list of active users associated with a company. User must have a valid token with required permissions. ### AddUser - [POST /user](https://apidoc.authmind.com/docs/users/paths/~1user/post.md): Add user by specifying relevant fields. User must have a valid token with required permissions. ### DeleteUser - [DELETE /user](https://apidoc.authmind.com/docs/users/paths/~1user/delete.md): 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. ### UpdateUser - [PATCH /user](https://apidoc.authmind.com/docs/users/paths/~1user/patch.md): 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. ## Issues ### GetIssueList - [GET /getIssues](https://apidoc.authmind.com/docs/issues/paths/~1getissues/get.md): 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 ### GetIssueDetails - [GET /getIssueDetails](https://apidoc.authmind.com/docs/issues/paths/~1getissuedetails/get.md): Get specific details about an issue and all related incidents for the issue. ## Accesses ### GetAccessesList - [GET /accesses](https://apidoc.authmind.com/docs/accesses/paths/~1accesses/get.md): Returns list of accesses sorted by latest activity time in descending order. ### GetAccessDetails - [GET /access/details](https://apidoc.authmind.com/docs/accesses/paths/~1access~1details/get.md): Returns access details ### ListAccessSourceHosts - [GET /access/sourcehosts](https://apidoc.authmind.com/docs/accesses/paths/~1access~1sourcehosts/get.md): Returns list of source hosts associated with an access, sorted by latest activity time in descending order. ### ListAccessDestHosts - [GET /access/destinationhosts](https://apidoc.authmind.com/docs/accesses/paths/~1access~1destinationhosts/get.md): Returns a list of destination hosts associated with an access sorted by latest activity time in descending order. ## Assets ### ListAssets - [GET /assets](https://apidoc.authmind.com/docs/assets/paths/~1assets/get.md): Returns list of assets sorted by latest activity time in descending order. ### GetAssetDetails - [GET /asset/details](https://apidoc.authmind.com/docs/assets/paths/~1asset~1details/get.md): Returns asset details ### ListAssetHosts - [GET /asset/hosts](https://apidoc.authmind.com/docs/assets/paths/~1asset~1hosts/get.md): Returns a list of hosts associated with an asset sorted by latest activity time in descending order. ## Identities ### ListIdentities - [GET /identities](https://apidoc.authmind.com/docs/identities/paths/~1identities/get.md): Returns a list of identities sorted by latest activity time in descending order. ### GetIdentityDetail - [GET /identity/details](https://apidoc.authmind.com/docs/identities/paths/~1identity~1details/get.md): Returns identity details ### ListIdentityHosts - [GET /identity/hosts](https://apidoc.authmind.com/docs/identities/paths/~1identity~1hosts/get.md): Returns a list of hosts associated with an identity sorted by latest activity time in descending order. ## IdentitySystems ### GetIdentitySystemsList - [GET /identitysystems](https://apidoc.authmind.com/docs/identitysystems/paths/~1identitysystems/get.md): Returns List of identity systems sorted by latest activity time in descending order. ### GetIdentitySystemDetails - [GET /identitysystem/details](https://apidoc.authmind.com/docs/identitysystems/paths/~1identitysystem~1details/get.md): Returns identity system details