{"items":[{"type":"link","label":"AuthMind API","link":"/v1/docs","routeSlug":"/v1/docs","content":{"contentType":"overview","meta":{"name":"AuthMind API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"docs.json","url":"/_bundle/@v1/docs.json?download"},{"kind":"download","label":"docs.yaml","url":"/_bundle/@v1/docs.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.authmind.com","url":"https://www.authmind.com"},{"kind":"email","title":"AuthMind","email":"support@authmind.com","label":"support@authmind.com","withCopyButton":true,"copyContent":"support@authmind.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"AuthMind Terms of Use","url":"https://www.authmind.com/saas-term"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"AuthMind API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}],"sectionId":"/v1/docs"}],"sectionId":"/v1/docs"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/key-sections-of-this-documentation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Sections of this Documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Learn how to generate tokens to access the APIs and API documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Detailed descriptions of each endpoint, including parameters, request, and response structures."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We are committed to providing a user-friendly API experience. Let's get started!"},"children":[]}]}]}]}],"sectionId":"/v1/docs/section/key-sections-of-this-documentation"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to AuthMind and go to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From the left navigation, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Tokens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage API Tokens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page is displayed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From the top-right side, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Client dialog is displayed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter a name for the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, a one-year expiration date is set from the creation date of the token. You can change this date, as required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A success message is displayed. You can also see a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog that contains the API token (JWT)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click OK to close the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog. You can see the token is listed on the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage API Tokens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page."},"children":[]}]}]}]}]}],"sectionId":"/v1/docs/section/getting-started"}]}]}},{"type":"link","label":"Key Sections of this Documentation","link":"/v1/docs/section/key-sections-of-this-documentation","routeSlug":"/v1/docs/section/key-sections-of-this-documentation","content":null},{"type":"link","label":"Getting Started","link":"/v1/docs/section/getting-started","routeSlug":"/v1/docs/section/getting-started","content":null},{"type":"group","label":"Users","link":"/v1/docs/users","routeSlug":"/v1/docs/users","items":[{"label":"ListRoles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/users/paths/~1v1~1roles/get","routeSlug":"/v1/docs/users/paths/~1v1~1roles/get","metadata":{"seo":{"title":"ListRoles","description":"Fetches list of roles. User must have a valid token with required permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListRoles","isWebhook":false,"pointer":"/paths/~1v1~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListRoles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches list of roles. User must have a valid token with required permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/roles","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/v1/roles","href":"users/paths/~1v1~1roles/get","summary":"ListRoles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.RolesResultStruct"}},"schemaId":"components/schemas/models.RolesResultStruct"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.RolesResultStruct","exampleIds":["paths/~1v1~1roles/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/models.RolesResultStruct","exampleIds":["paths/~1v1~1roles/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.RolesResultStruct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.RolesResultStruct"}}},{"code":"401"},{"code":"403","schemaId":"schema_28","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}}},{"code":"500","schemaId":"components/schemas/models.RolesResultStruct","exampleIds":["paths/~1v1~1roles/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.RolesResultStruct","exampleIds":["paths/~1v1~1roles/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/paths/~1v1~1roles/get"}],"panels":[]}]},"httpPath":"/v1/roles"},{"label":"ListUsers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/users/paths/~1v1~1users/get","routeSlug":"/v1/docs/users/paths/~1v1~1users/get","metadata":{"seo":{"title":"ListUsers","description":"Fetches list of active users associated with a company. User must have a valid token with required permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListUsers","isWebhook":false,"pointer":"/paths/~1v1~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListUsers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches list of active users associated with a company. User must have a valid token with required permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Records per page. By default no of records per page is 50."},{"name":"identifier","in":"query","schemaId":"schema_30","description":"Name or email Id of the user to search"},{"name":"sort_by","in":"query","schemaId":"schema_31","description":"Sort by field name"},{"name":"order","in":"query","schemaId":"schema_32","description":"Order by asc or desc"}],"pointer":"/paths/~1v1~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/users","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"identifier","in":"query","schemaId":"schema_30"},{"name":"sort_by","in":"query","schemaId":"schema_31"},{"name":"order","in":"query","schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","403","500"],"pointer":"/v1/users","href":"users/paths/~1v1~1users/get","summary":"ListUsers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.UsersResultStruct"}},"schemaId":"components/schemas/models.UsersResultStruct"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.UsersResultStruct","exampleIds":["paths/~1v1~1users/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/models.UsersResultStruct","exampleIds":["paths/~1v1~1users/get/responses/400/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.UsersResultStruct"}},"schemaId":"components/schemas/models.UsersResultStruct"}],"pointer":"/paths/~1v1~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.UsersResultStruct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.UsersResultStruct"}}},{"code":"400","schemaId":"components/schemas/models.UsersResultStruct","exampleIds":["paths/~1v1~1users/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.UsersResultStruct","exampleIds":["paths/~1v1~1users/get/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_28","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}}},{"code":"500","schemaId":"components/schemas/models.UsersResultStruct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.UsersResultStruct"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/paths/~1v1~1users/get"}],"panels":[]}]},"httpPath":"/v1/users"},{"label":"AddUser","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/users/paths/~1v1~1user/post","routeSlug":"/v1/docs/users/paths/~1v1~1user/post","metadata":{"seo":{"title":"AddUser","description":"Add user by specifying relevant fields. User must have a valid token with required permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"AddUser","isWebhook":false,"pointer":"/paths/~1v1~1user/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AddUser","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add user by specifying relevant fields. User must have a valid token with required permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/models.User"}},"schemaId":"components/schemas/models.User","pointer":"/paths/~1v1~1user/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/user","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/models.User"}},"responseCodes":["200","400","403","500"],"pointer":"/v1/user","href":"users/paths/~1v1~1user/post","summary":"AddUser"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"schemaId":"components/schemas/models.User","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/models.User"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse"}},"schemaId":"components/schemas/models.FinalUserResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/400/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1user/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.FinalUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse"}}},{"code":"400","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_28","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}}},{"code":"500","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/paths/~1v1~1user/post"}],"panels":[]}]},"httpPath":"/v1/user"},{"label":"DeleteUser","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/users/paths/~1v1~1user/delete","routeSlug":"/v1/docs/users/paths/~1v1~1user/delete","metadata":{"seo":{"title":"DeleteUser","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"DeleteUser","isWebhook":false,"pointer":"/paths/~1v1~1user/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DeleteUser","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_30","description":"Email of the user to delete"},{"name":"id","in":"query","schemaId":"schema_30","description":"Id of the user to delete"}],"pointer":"/paths/~1v1~1user/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/user","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","schemaId":"schema_30"},{"name":"id","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/v1/user","href":"users/paths/~1v1~1user/delete","summary":"DeleteUser"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1user/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/400/content/application~1json/example"]}}},{"code":"401"},{"code":"403","schemaId":"schema_28","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}}},{"code":"500","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/paths/~1v1~1user/delete"}],"panels":[]}]},"httpPath":"/v1/user"},{"label":"UpdateUser","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/users/paths/~1v1~1user/patch","routeSlug":"/v1/docs/users/paths/~1v1~1user/patch","metadata":{"seo":{"title":"UpdateUser","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"UpdateUser","isWebhook":false,"pointer":"/paths/~1v1~1user/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateUser","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_30","description":"Email of the user to update"},{"name":"id","in":"query","schemaId":"schema_30","description":"Id of the user to be updated"}],"pointer":"/paths/~1v1~1user/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/models.UserParams"}},"schemaId":"components/schemas/models.UserParams","pointer":"/paths/~1v1~1user/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/user","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","schemaId":"schema_30"},{"name":"id","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/models.UserParams"}},"responseCodes":["200","400","401","403","500"],"pointer":"/v1/user","href":"users/paths/~1v1~1user/patch","summary":"UpdateUser"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"schemaId":"components/schemas/models.UserParams","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/models.UserParams"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1user/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/400/content/application~1json/example"]}}},{"code":"401"},{"code":"403","schemaId":"schema_28","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}}},{"code":"500","schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.FinalUserResponse","exampleIds":["paths/~1v1~1user/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/paths/~1v1~1user/patch"}],"panels":[]}]},"httpPath":"/v1/user"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/roles","summary":"ListRoles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/paths/~1v1~1roles/get","deprecated":false},{"title":"/v1/users","summary":"ListUsers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/paths/~1v1~1users/get","deprecated":false},{"title":"/v1/user","summary":"AddUser","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/paths/~1v1~1user/post","deprecated":false},{"title":"/v1/user","summary":"DeleteUser","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/paths/~1v1~1user/delete","deprecated":false},{"title":"/v1/user","summary":"UpdateUser","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/users/paths/~1v1~1user/patch","deprecated":false}]}]}]}]}},{"type":"group","label":"Issues","link":"/v1/docs/issues","routeSlug":"/v1/docs/issues","items":[{"label":"ListIssues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/issues/paths/~1v1~1issues/get","routeSlug":"/v1/docs/issues/paths/~1v1~1issues/get","metadata":{"seo":{"title":"ListIssues","description":"Returns a list of issues. Defaults to Open status when status is not provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListIssues","isWebhook":false,"pointer":"/paths/~1v1~1issues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListIssues","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of issues. Defaults to Open status when status is not provided."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page"},{"name":"sort_by","in":"query","schemaId":"schema_33","description":"Sort by field name"},{"name":"order_by","in":"query","schemaId":"schema_32","description":"Order by field asc/desc. If not set it is by default descending."},{"name":"gen_timestamp_gt","in":"query","schemaId":"schema_30","description":"Latest activity time greater than"},{"name":"first_flow_time_gt","in":"query","schemaId":"schema_30","description":"first flow time greater than"},{"name":"risk","in":"query","schemaId":"schema_34","description":"Risk associated with the playbook selected. 4 is critical, 3 is high risk, 2 is medium and 1 means Low risk"},{"name":"issue_type","in":"query","schemaId":"schema_35","description":"Used to retrieve only a specific issue type. If left empty, the issues will be retrieved for all the types.(recommended)"},{"name":"playbook_name","in":"query","schemaId":"schema_30","description":"Playbook name"},{"name":"status","in":"query","schemaId":"schema_36","description":"Incident status. Defaults to Open when not provided."},{"name":"issue_id","in":"query","schemaId":"schema_30","description":"Issue id"}],"pointer":"/paths/~1v1~1issues/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/issues","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"sort_by","in":"query","schemaId":"schema_33"},{"name":"order_by","in":"query","schemaId":"schema_32"},{"name":"gen_timestamp_gt","in":"query","schemaId":"schema_30"},{"name":"first_flow_time_gt","in":"query","schemaId":"schema_30"},{"name":"risk","in":"query","schemaId":"schema_34"},{"name":"issue_type","in":"query","schemaId":"schema_35"},{"name":"playbook_name","in":"query","schemaId":"schema_30"},{"name":"status","in":"query","schemaId":"schema_36"},{"name":"issue_id","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/v1/issues","href":"issues/paths/~1v1~1issues/get","summary":"ListIssues"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesListResponse"}},"schemaId":"components/schemas/models.IssuesListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesListResponse","exampleIds":["paths/~1v1~1issues/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/models.IssuesListResponse","exampleIds":["paths/~1v1~1issues/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1issues/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.IssuesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesListResponse"}}},{"code":"401"},{"code":"403","schemaId":"schema_28","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}}},{"code":"500","schemaId":"components/schemas/models.IssuesListResponse","exampleIds":["paths/~1v1~1issues/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesListResponse","exampleIds":["paths/~1v1~1issues/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/issues/paths/~1v1~1issues/get"}],"panels":[]}]},"httpPath":"/v1/issues"},{"label":"ListIssueAccesses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/issues/paths/~1v1~1issue~1{incident_id}~1accesses/get","routeSlug":"/v1/docs/issues/paths/~1v1~1issue~1{incident_id}~1accesses/get","metadata":{"seo":{"title":"ListIssueAccesses","description":"Returns a list of issue accesses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListIssueAccesses","isWebhook":false,"pointer":"/paths/~1v1~1issue~1{incident_id}~1accesses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListIssueAccesses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of issue accesses"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"incident_id","in":"path","schemaId":"schema_30","description":"The unique identifier of the incident","required":true}],"pointer":"/paths/~1v1~1issue~1{incident_id}~1accesses/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page"},{"name":"sort_by","in":"query","schemaId":"schema_37","description":"Sort by field name"},{"name":"order_by","in":"query","schemaId":"schema_32","description":"Order by field asc/desc. If not set it is by default descending."}],"pointer":"/paths/~1v1~1issue~1{incident_id}~1accesses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/issue/{incident_id}/accesses","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[{"name":"incident_id","in":"path","required":true,"schemaId":"schema_30"}],"query":[{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"sort_by","in":"query","schemaId":"schema_37"},{"name":"order_by","in":"query","schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/v1/issue/{incident_id}/accesses","href":"issues/paths/~1v1~1issue~1{incident_id}~1accesses/get","summary":"ListIssueAccesses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesAccessListResponse"}},"schemaId":"components/schemas/models.IssuesAccessListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesAccessListResponse","exampleIds":["paths/~1v1~1issue~1{incident_id}~1accesses/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/models.IssuesAccessListResponse","exampleIds":["paths/~1v1~1issue~1{incident_id}~1accesses/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1issue~1{incident_id}~1accesses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.IssuesAccessListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesAccessListResponse"}}},{"code":"401"},{"code":"403","schemaId":"schema_28","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_28"}}},{"code":"500","schemaId":"components/schemas/models.IssuesAccessListResponse","exampleIds":["paths/~1v1~1issue~1{incident_id}~1accesses/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IssuesAccessListResponse","exampleIds":["paths/~1v1~1issue~1{incident_id}~1accesses/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/issues/paths/~1v1~1issue~1{incident_id}~1accesses/get"}],"panels":[]}]},"httpPath":"/v1/issue/{incident_id}/accesses"},{"label":"GetIssueList","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/issues/paths/~1v1~1getissues/get","routeSlug":"/v1/docs/issues/paths/~1v1~1getissues/get","metadata":{"seo":{"title":"GetIssueList","description":"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetIssueList","isWebhook":false,"pointer":"/paths/~1v1~1getIssues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetIssueList","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"issue_type","in":"query","schemaId":"schema_35","description":"Used to retrieve only a specific issue type. If left empty, the issues will be retrieved for all the types.(recommended)"},{"name":"issue_id_gt","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to retrieve latest issues by issue id.  All issues > this parameter will be returned (recommended)"},"children":[]}]}]}]},{"name":"issue_time_gt","in":"query","schemaId":"schema_38","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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'"},"children":[]}]}]}]},{"name":"sort_order","in":"query","schemaId":"schema_39","description":"Sorting order, Default value is DESC."},{"name":"sort_by","in":"query","schemaId":"schema_40","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort by, Default value is issue_time."},"children":[]}]}]}]},{"name":"from","in":"query","schemaId":"schema_29","description":"Starting point for pagination, Default value 0."},{"name":"size","in":"query","schemaId":"schema_29","description":"Maximum number of records to return for pagination, Default value 1000."}],"pointer":"/paths/~1v1~1getIssues/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/getIssues","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"issue_type","in":"query","schemaId":"schema_35"},{"name":"issue_id_gt","in":"query","schemaId":"schema_30"},{"name":"issue_time_gt","in":"query","schemaId":"schema_38"},{"name":"sort_order","in":"query","schemaId":"schema_39"},{"name":"sort_by","in":"query","schemaId":"schema_40"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/getIssues","href":"issues/paths/~1v1~1getissues/get","summary":"GetIssueList"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"400","description":"Invalid params or missing params.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}},"schemaId":"schema_42"},{"code":"401","description":"Authorization information is missing or invalid."}],"pointer":"/paths/~1v1~1getIssues/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"400","schemaId":"schema_42","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/issues/paths/~1v1~1getissues/get"}],"panels":[]}]},"httpPath":"/v1/getIssues"},{"label":"GetIssueDetails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/issues/paths/~1v1~1getissuedetails/get","routeSlug":"/v1/docs/issues/paths/~1v1~1getissuedetails/get","metadata":{"seo":{"title":"GetIssueDetails","description":"Get specific details about an issue and all related incidents for the issue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetIssueDetails","isWebhook":false,"pointer":"/paths/~1v1~1getIssueDetails/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetIssueDetails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get specific details about an issue and all related incidents for the issue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"issue_id","in":"query","schemaId":"schema_30","description":"Issue Id to fetch issue details. e.g. 17263-1722579276407","required":true},{"name":"sort_order","in":"query","schemaId":"schema_39","description":"Sorting order, Default value is DESC."},{"name":"sort_by","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort by field for incidents, Default value is last_seen."},"children":[]}]}]}]},{"name":"from","in":"query","schemaId":"schema_29","description":"Starting point for pagination, Default value 0."},{"name":"size","in":"query","schemaId":"schema_29","description":"Maximum number of records to return for pagination, Default value 1000."}],"pointer":"/paths/~1v1~1getIssueDetails/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/getIssueDetails","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"issue_id","in":"query","required":true,"schemaId":"schema_30"},{"name":"sort_order","in":"query","schemaId":"schema_39"},{"name":"sort_by","in":"query","schemaId":"schema_43"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/getIssueDetails","href":"issues/paths/~1v1~1getissuedetails/get","summary":"GetIssueDetails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"400","description":"Invalid params or missing params.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}},"schemaId":"schema_42"},{"code":"401","description":"Authorization information is missing or invalid."}],"pointer":"/paths/~1v1~1getIssueDetails/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"400","schemaId":"schema_42","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/issues/paths/~1v1~1getissuedetails/get"}],"panels":[]}]},"httpPath":"/v1/getIssueDetails"}],"content":{"contentType":"group","meta":{"name":"Issues"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issues","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/issues","summary":"ListIssues","prefix":{"name":"get","color":"get"},"badges":[],"link":"/issues/paths/~1v1~1issues/get","deprecated":false},{"title":"/v1/issue/{incident_id}/accesses","summary":"ListIssueAccesses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/issues/paths/~1v1~1issue~1{incident_id}~1accesses/get","deprecated":false},{"title":"/v1/getIssues","summary":"GetIssueList","prefix":{"name":"get","color":"get"},"badges":[],"link":"/issues/paths/~1v1~1getissues/get","deprecated":false},{"title":"/v1/getIssueDetails","summary":"GetIssueDetails","prefix":{"name":"get","color":"get"},"badges":[],"link":"/issues/paths/~1v1~1getissuedetails/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Accesses","link":"/v1/docs/accesses","routeSlug":"/v1/docs/accesses","items":[{"label":"GetAccessesList","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/accesses/paths/~1v1~1accesses/get","routeSlug":"/v1/docs/accesses/paths/~1v1~1accesses/get","metadata":{"seo":{"title":"GetAccessesList","description":"Returns list of accesses sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetAccessesList","isWebhook":false,"pointer":"/paths/~1v1~1accesses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetAccessesList","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of accesses sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"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'."},{"name":"identity_type","in":"query","schemaId":"schema_30","description":"Identity type"},{"name":"directory_type","in":"query","schemaId":"schema_45","description":"Directory Type"},{"name":"directory_name","in":"query","schemaId":"schema_30","description":"Directory Name"},{"name":"identity","in":"query","schemaId":"schema_30","description":"Identity Name"},{"name":"asset","in":"query","schemaId":"schema_30","description":"Asset Name"},{"name":"asset_type","in":"query","schemaId":"schema_30","description":"Asset Type"},{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 1000."},{"name":"score","in":"query","schemaId":"schema_46","description":"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"}],"pointer":"/paths/~1v1~1accesses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accesses","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"},{"name":"identity_type","in":"query","schemaId":"schema_30"},{"name":"directory_type","in":"query","schemaId":"schema_45"},{"name":"directory_name","in":"query","schemaId":"schema_30"},{"name":"identity","in":"query","schemaId":"schema_30"},{"name":"asset","in":"query","schemaId":"schema_30"},{"name":"asset_type","in":"query","schemaId":"schema_30"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"score","in":"query","schemaId":"schema_46"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/accesses","href":"accesses/paths/~1v1~1accesses/get","summary":"GetAccessesList"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAccessesListResponse"}},"schemaId":"components/schemas/models.OutputAccessesListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAccessesListResponse"}},"schemaId":"components/schemas/models.OutputAccessesListResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAccessesListResponse"}},"schemaId":"components/schemas/models.OutputAccessesListResponse"}],"pointer":"/paths/~1v1~1accesses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.OutputAccessesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAccessesListResponse"}}},{"code":"400","schemaId":"components/schemas/models.OutputAccessesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAccessesListResponse"}}},{"code":"500","schemaId":"components/schemas/models.OutputAccessesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAccessesListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accesses/paths/~1v1~1accesses/get"}],"panels":[]}]},"httpPath":"/v1/accesses"},{"label":"GetAccessDetails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/accesses/paths/~1v1~1access~1details/get","routeSlug":"/v1/docs/accesses/paths/~1v1~1access~1details/get","metadata":{"seo":{"title":"GetAccessDetails","description":"Returns access details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetAccessDetails","isWebhook":false,"pointer":"/paths/~1v1~1access~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetAccessDetails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns access details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"identity_name","in":"query","schemaId":"schema_30","description":"Identity Name","required":true},{"name":"identity_type","in":"query","schemaId":"schema_30","description":"Identity Type","required":true},{"name":"asset_name","in":"query","schemaId":"schema_30","description":"Asset Name","required":true},{"name":"asset_type","in":"query","schemaId":"schema_30","description":"Asset Type","required":true},{"name":"directory_name","in":"query","schemaId":"schema_30","description":"Directory Name if present"}],"pointer":"/paths/~1v1~1access~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/access/details","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"identity_name","in":"query","required":true,"schemaId":"schema_30"},{"name":"identity_type","in":"query","required":true,"schemaId":"schema_30"},{"name":"asset_name","in":"query","required":true,"schemaId":"schema_30"},{"name":"asset_type","in":"query","required":true,"schemaId":"schema_30"},{"name":"directory_name","in":"query","required":false,"schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/access/details","href":"accesses/paths/~1v1~1access~1details/get","summary":"GetAccessDetails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetails200FinalResponse"}},"schemaId":"components/schemas/models.AccessDetails200FinalResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}],"pointer":"/paths/~1v1~1access~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.AccessDetails200FinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetails200FinalResponse"}}},{"code":"400","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}},{"code":"500","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accesses/paths/~1v1~1access~1details/get"}],"panels":[]}]},"httpPath":"/v1/access/details"},{"label":"ListAccessSourceHosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/accesses/paths/~1v1~1access~1sourcehosts/get","routeSlug":"/v1/docs/accesses/paths/~1v1~1access~1sourcehosts/get","metadata":{"seo":{"title":"ListAccessSourceHosts","description":"Returns list of source hosts associated with an access, sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListAccessSourceHosts","isWebhook":false,"pointer":"/paths/~1v1~1access~1sourcehosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListAccessSourceHosts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of source hosts associated with an access, sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"identifier","in":"query","schemaId":"schema_30","description":"Access ID","required":true},{"name":"from","in":"query","schemaId":"schema_29","description":"Page number."},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 100."},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"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'."}],"pointer":"/paths/~1v1~1access~1sourcehosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/access/sourcehosts","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"identifier","in":"query","required":true,"schemaId":"schema_30"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/access/sourcehosts","href":"accesses/paths/~1v1~1access~1sourcehosts/get","summary":"ListAccessSourceHosts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}},"schemaId":"components/schemas/models.IdentityHostsResponseOut"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}},"schemaId":"components/schemas/models.IdentityHostsResponseOut"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}},"schemaId":"components/schemas/models.IdentityHostsResponseOut"}],"pointer":"/paths/~1v1~1access~1sourcehosts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.IdentityHostsResponseOut","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}}},{"code":"400","schemaId":"components/schemas/models.IdentityHostsResponseOut","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}}},{"code":"500","schemaId":"components/schemas/models.IdentityHostsResponseOut","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accesses/paths/~1v1~1access~1sourcehosts/get"}],"panels":[]}]},"httpPath":"/v1/access/sourcehosts"},{"label":"ListAccessDestHosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/accesses/paths/~1v1~1access~1destinationhosts/get","routeSlug":"/v1/docs/accesses/paths/~1v1~1access~1destinationhosts/get","metadata":{"seo":{"title":"ListAccessDestHosts","description":"Returns a list of destination hosts associated with an access sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListAccessDestHosts","isWebhook":false,"pointer":"/paths/~1v1~1access~1destinationhosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListAccessDestHosts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of destination hosts associated with an access sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"identifier","in":"query","schemaId":"schema_30","description":"Access ID","required":true},{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 100."},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"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'."}],"pointer":"/paths/~1v1~1access~1destinationhosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/access/destinationhosts","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"identifier","in":"query","required":true,"schemaId":"schema_30"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/access/destinationhosts","href":"accesses/paths/~1v1~1access~1destinationhosts/get","summary":"ListAccessDestHosts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}},"schemaId":"components/schemas/models.OutAssetHostsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}},"schemaId":"components/schemas/models.OutAssetHostsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}},"schemaId":"components/schemas/models.OutAssetHostsResponse"}],"pointer":"/paths/~1v1~1access~1destinationhosts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.OutAssetHostsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}}},{"code":"400","schemaId":"components/schemas/models.OutAssetHostsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}}},{"code":"500","schemaId":"components/schemas/models.OutAssetHostsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accesses/paths/~1v1~1access~1destinationhosts/get"}],"panels":[]}]},"httpPath":"/v1/access/destinationhosts"}],"content":{"contentType":"group","meta":{"name":"Accesses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accesses","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accesses","summary":"GetAccessesList","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accesses/paths/~1v1~1accesses/get","deprecated":false},{"title":"/v1/access/details","summary":"GetAccessDetails","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accesses/paths/~1v1~1access~1details/get","deprecated":false},{"title":"/v1/access/sourcehosts","summary":"ListAccessSourceHosts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accesses/paths/~1v1~1access~1sourcehosts/get","deprecated":false},{"title":"/v1/access/destinationhosts","summary":"ListAccessDestHosts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accesses/paths/~1v1~1access~1destinationhosts/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Assets","link":"/v1/docs/assets","routeSlug":"/v1/docs/assets","items":[{"label":"ListAssets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/assets/paths/~1v1~1assets/get","routeSlug":"/v1/docs/assets/paths/~1v1~1assets/get","metadata":{"seo":{"title":"ListAssets","description":"Returns list of assets sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListAssets","isWebhook":false,"pointer":"/paths/~1v1~1assets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListAssets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of assets sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 1000."},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"Returns list of assets having latest activity time greater than the specified time. The format of time is 'YYYY-MM-DD HH:MM:SS'."},{"name":"score","in":"query","schemaId":"schema_46","description":"Filters assets 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"},{"name":"asset_type","in":"query","schemaId":"schema_30","description":"Asset type"}],"pointer":"/paths/~1v1~1assets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/assets","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"},{"name":"score","in":"query","schemaId":"schema_46"},{"name":"asset_type","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/assets","href":"assets/paths/~1v1~1assets/get","summary":"ListAssets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAssetListResponse"}},"schemaId":"components/schemas/models.OutputAssetListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAssetListResponse"}},"schemaId":"components/schemas/models.OutputAssetListResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAssetListResponse"}},"schemaId":"components/schemas/models.OutputAssetListResponse"}],"pointer":"/paths/~1v1~1assets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.OutputAssetListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAssetListResponse"}}},{"code":"400","schemaId":"components/schemas/models.OutputAssetListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAssetListResponse"}}},{"code":"500","schemaId":"components/schemas/models.OutputAssetListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputAssetListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/paths/~1v1~1assets/get"}],"panels":[]}]},"httpPath":"/v1/assets"},{"label":"GetAssetDetails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/assets/paths/~1v1~1asset~1details/get","routeSlug":"/v1/docs/assets/paths/~1v1~1asset~1details/get","metadata":{"seo":{"title":"GetAssetDetails","description":"Returns asset details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetAssetDetails","isWebhook":false,"pointer":"/paths/~1v1~1asset~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetAssetDetails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns asset details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"asset_name","in":"query","schemaId":"schema_30","description":"Asset Name","required":true},{"name":"asset_type","in":"query","schemaId":"schema_30","description":"Asset Type","required":true}],"pointer":"/paths/~1v1~1asset~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/asset/details","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"asset_name","in":"query","required":true,"schemaId":"schema_30"},{"name":"asset_type","in":"query","required":true,"schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/asset/details","href":"assets/paths/~1v1~1asset~1details/get","summary":"GetAssetDetails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AssetDetails200FinalResponse"}},"schemaId":"components/schemas/models.AssetDetails200FinalResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}],"pointer":"/paths/~1v1~1asset~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.AssetDetails200FinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AssetDetails200FinalResponse"}}},{"code":"400","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}},{"code":"500","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/paths/~1v1~1asset~1details/get"}],"panels":[]}]},"httpPath":"/v1/asset/details"},{"label":"ListAssetHosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/assets/paths/~1v1~1asset~1hosts/get","routeSlug":"/v1/docs/assets/paths/~1v1~1asset~1hosts/get","metadata":{"seo":{"title":"ListAssetHosts","description":"Returns a list of hosts associated with an asset sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListAssetHosts","isWebhook":false,"pointer":"/paths/~1v1~1asset~1hosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListAssetHosts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of hosts associated with an asset sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"asset_name","in":"query","schemaId":"schema_30","description":"Asset Name","required":true},{"name":"asset_type","in":"query","schemaId":"schema_30","description":"Asset Type","required":true},{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 100."},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"Returns list of asset hosts having latest activity time greater than the specified time if provided. The format of time is 'YYYY-MM-DD HH:MM:SS'."}],"pointer":"/paths/~1v1~1asset~1hosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/asset/hosts","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"asset_name","in":"query","required":true,"schemaId":"schema_30"},{"name":"asset_type","in":"query","required":true,"schemaId":"schema_30"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/asset/hosts","href":"assets/paths/~1v1~1asset~1hosts/get","summary":"ListAssetHosts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}},"schemaId":"components/schemas/models.OutAssetHostsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}},"schemaId":"components/schemas/models.OutAssetHostsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}},"schemaId":"components/schemas/models.OutAssetHostsResponse"}],"pointer":"/paths/~1v1~1asset~1hosts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.OutAssetHostsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}}},{"code":"400","schemaId":"components/schemas/models.OutAssetHostsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}}},{"code":"500","schemaId":"components/schemas/models.OutAssetHostsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutAssetHostsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/paths/~1v1~1asset~1hosts/get"}],"panels":[]}]},"httpPath":"/v1/asset/hosts"}],"content":{"contentType":"group","meta":{"name":"Assets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assets","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/assets","summary":"ListAssets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/paths/~1v1~1assets/get","deprecated":false},{"title":"/v1/asset/details","summary":"GetAssetDetails","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/paths/~1v1~1asset~1details/get","deprecated":false},{"title":"/v1/asset/hosts","summary":"ListAssetHosts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/paths/~1v1~1asset~1hosts/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Identities","link":"/v1/docs/identities","routeSlug":"/v1/docs/identities","items":[{"label":"ListIdentities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/identities/paths/~1v1~1identities/get","routeSlug":"/v1/docs/identities/paths/~1v1~1identities/get","metadata":{"seo":{"title":"ListIdentities","description":"Returns a list of identities sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListIdentities","isWebhook":false,"pointer":"/paths/~1v1~1identities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListIdentities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of identities sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 1000."},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"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'."},{"name":"score","in":"query","schemaId":"schema_46","description":"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"},{"name":"type","in":"query","schemaId":"schema_30","description":"Identity type"},{"name":"identity_status","in":"query","schemaId":"schema_30","description":"Identity status"}],"pointer":"/paths/~1v1~1identities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/identities","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"},{"name":"score","in":"query","schemaId":"schema_46"},{"name":"type","in":"query","schemaId":"schema_30"},{"name":"identity_status","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/identities","href":"identities/paths/~1v1~1identities/get","summary":"ListIdentities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitiesListResponse"}},"schemaId":"components/schemas/models.OutputIdentitiesListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitiesListResponse"}},"schemaId":"components/schemas/models.OutputIdentitiesListResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitiesListResponse"}},"schemaId":"components/schemas/models.OutputIdentitiesListResponse"}],"pointer":"/paths/~1v1~1identities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.OutputIdentitiesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitiesListResponse"}}},{"code":"400","schemaId":"components/schemas/models.OutputIdentitiesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitiesListResponse"}}},{"code":"500","schemaId":"components/schemas/models.OutputIdentitiesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitiesListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/paths/~1v1~1identities/get"}],"panels":[]}]},"httpPath":"/v1/identities"},{"label":"GetIdentityDetail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/identities/paths/~1v1~1identity~1details/get","routeSlug":"/v1/docs/identities/paths/~1v1~1identity~1details/get","metadata":{"seo":{"title":"GetIdentityDetail","description":"Returns identity details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetIdentityDetail","isWebhook":false,"pointer":"/paths/~1v1~1identity~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetIdentityDetail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns identity details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"identifier","in":"query","schemaId":"schema_30","description":"Identity type","required":true}],"pointer":"/paths/~1v1~1identity~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/identity/details","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"identifier","in":"query","required":true,"schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/identity/details","href":"identities/paths/~1v1~1identity~1details/get","summary":"GetIdentityDetail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityDetails200FinalResponse"}},"schemaId":"components/schemas/models.IdentityDetails200FinalResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}],"pointer":"/paths/~1v1~1identity~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.IdentityDetails200FinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityDetails200FinalResponse"}}},{"code":"400","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}},{"code":"500","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/paths/~1v1~1identity~1details/get"}],"panels":[]}]},"httpPath":"/v1/identity/details"},{"label":"ListIdentityHosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/identities/paths/~1v1~1identity~1hosts/get","routeSlug":"/v1/docs/identities/paths/~1v1~1identity~1hosts/get","metadata":{"seo":{"title":"ListIdentityHosts","description":"Returns a list of hosts associated with an identity sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"ListIdentityHosts","isWebhook":false,"pointer":"/paths/~1v1~1identity~1hosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListIdentityHosts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of hosts associated with an identity sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"identifier","in":"query","schemaId":"schema_30","description":"Identity Name","required":true},{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 100."},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"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'."}],"pointer":"/paths/~1v1~1identity~1hosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/identity/hosts","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"identifier","in":"query","required":true,"schemaId":"schema_30"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/identity/hosts","href":"identities/paths/~1v1~1identity~1hosts/get","summary":"ListIdentityHosts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}},"schemaId":"components/schemas/models.IdentityHostsResponseOut"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}},"schemaId":"components/schemas/models.IdentityHostsResponseOut"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}},"schemaId":"components/schemas/models.IdentityHostsResponseOut"}],"pointer":"/paths/~1v1~1identity~1hosts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.IdentityHostsResponseOut","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}}},{"code":"400","schemaId":"components/schemas/models.IdentityHostsResponseOut","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}}},{"code":"500","schemaId":"components/schemas/models.IdentityHostsResponseOut","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentityHostsResponseOut"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/paths/~1v1~1identity~1hosts/get"}],"panels":[]}]},"httpPath":"/v1/identity/hosts"}],"content":{"contentType":"group","meta":{"name":"Identities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identities","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/identities","summary":"ListIdentities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identities/paths/~1v1~1identities/get","deprecated":false},{"title":"/v1/identity/details","summary":"GetIdentityDetail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identities/paths/~1v1~1identity~1details/get","deprecated":false},{"title":"/v1/identity/hosts","summary":"ListIdentityHosts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identities/paths/~1v1~1identity~1hosts/get","deprecated":false}]}]}]}]}},{"type":"group","label":"IdentitySystems","link":"/v1/docs/identitysystems","routeSlug":"/v1/docs/identitysystems","items":[{"label":"GetIdentitySystemsList","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/identitysystems/paths/~1v1~1identitysystems/get","routeSlug":"/v1/docs/identitysystems/paths/~1v1~1identitysystems/get","metadata":{"seo":{"title":"GetIdentitySystemsList","description":"Returns List of identity systems sorted by latest activity time in descending order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetIdentitySystemsList","isWebhook":false,"pointer":"/paths/~1v1~1identitysystems/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetIdentitySystemsList","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns List of identity systems sorted by latest activity time in descending order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"directory_type","in":"query","schemaId":"schema_45","description":"Directory Type"},{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Record per page. Default no of records per page is 50. Maximum allowed records per page is 1000."},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30","description":"Returns list of identitysystems having latest activity time greater than the specified time if provided. The format of time is 'YYYY-MM-DD HH:MM:SS'."},{"name":"score","in":"query","schemaId":"schema_46","description":"Filters identity system 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"}],"pointer":"/paths/~1v1~1identitysystems/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/identitysystems","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"directory_type","in":"query","schemaId":"schema_45"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"latest_activity_time_gt","in":"query","schemaId":"schema_30"},{"name":"score","in":"query","schemaId":"schema_46"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/identitysystems","href":"identitysystems/paths/~1v1~1identitysystems/get","summary":"GetIdentitySystemsList"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"}},"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"}},"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"}},"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"}],"pointer":"/paths/~1v1~1identitysystems/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.OutputIdentitySystemsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"}}},{"code":"400","schemaId":"components/schemas/models.OutputIdentitySystemsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"}}},{"code":"500","schemaId":"components/schemas/models.OutputIdentitySystemsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputIdentitySystemsListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitysystems/paths/~1v1~1identitysystems/get"}],"panels":[]}]},"httpPath":"/v1/identitysystems"},{"label":"GetIdentitySystemDetails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/identitysystems/paths/~1v1~1identitysystem~1details/get","routeSlug":"/v1/docs/identitysystems/paths/~1v1~1identitysystem~1details/get","metadata":{"seo":{"title":"GetIdentitySystemDetails","description":"Returns identity system details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"GetIdentitySystemDetails","isWebhook":false,"pointer":"/paths/~1v1~1identitysystem~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetIdentitySystemDetails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns identity system details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"identifier","in":"query","schemaId":"schema_30","description":"Identity Systems ID","required":true}],"pointer":"/paths/~1v1~1identitysystem~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/identitysystem/details","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"identifier","in":"query","required":true,"schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/identitysystem/details","href":"identitysystems/paths/~1v1~1identitysystem~1details/get","summary":"GetIdentitySystemDetails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentitySystemDetailFinal200Response"}},"schemaId":"components/schemas/models.IdentitySystemDetailFinal200Response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}},"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}],"pointer":"/paths/~1v1~1identitysystem~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.IdentitySystemDetailFinal200Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.IdentitySystemDetailFinal200Response"}}},{"code":"400","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}},{"code":"500","schemaId":"components/schemas/models.AccessDetailsFinalResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.AccessDetailsFinalResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitysystems/paths/~1v1~1identitysystem~1details/get"}],"panels":[]}]},"httpPath":"/v1/identitysystem/details"}],"content":{"contentType":"group","meta":{"name":"IdentitySystems"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IdentitySystems","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/identitysystems","summary":"GetIdentitySystemsList","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identitysystems/paths/~1v1~1identitysystems/get","deprecated":false},{"title":"/v1/identitysystem/details","summary":"GetIdentitySystemDetails","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identitysystems/paths/~1v1~1identitysystem~1details/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Playbooks","link":"/v1/docs/playbooks","routeSlug":"/v1/docs/playbooks","items":[{"label":"List playbooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/docs/playbooks/paths/~1v1~1playbooks/get","routeSlug":"/v1/docs/playbooks/paths/~1v1~1playbooks/get","metadata":{"seo":{"title":"List playbooks","description":"Returns active playbooks by default. Pass include_all=true to include inactive playbooks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List playbooks","isWebhook":false,"pointer":"/paths/~1v1~1playbooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List playbooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns active playbooks by default. Pass include_all=true to include inactive playbooks."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthorizationHeader","scopes":[],"type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_all","in":"query","schemaId":"schema_47","description":"Include inactive playbooks"},{"name":"q","in":"query","schemaId":"schema_30","description":"Search by playbook name"},{"name":"from","in":"query","schemaId":"schema_29","description":"Page number"},{"name":"size","in":"query","schemaId":"schema_29","description":"Records per page. Maximum allowed records per page is 200."},{"name":"sort_by","in":"query","schemaId":"schema_48","description":"Sort field"},{"name":"order_by","in":"query","schemaId":"schema_32","description":"Sort order (asc or desc)"}],"pointer":"/paths/~1v1~1playbooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/playbooks","servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"parameters":{"path":[],"query":[{"name":"include_all","in":"query","schemaId":"schema_47"},{"name":"q","in":"query","schemaId":"schema_30"},{"name":"from","in":"query","schemaId":"schema_29"},{"name":"size","in":"query","schemaId":"schema_29"},{"name":"sort_by","in":"query","schemaId":"schema_48"},{"name":"order_by","in":"query","schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthorizationHeader","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/playbooks","href":"playbooks/paths/~1v1~1playbooks/get","summary":"List playbooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/docs","description":"Mock server","isMockServer":true},{"url":"{{.Host}}/amapi"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputPlaybooksListResponse"}},"schemaId":"components/schemas/models.OutputPlaybooksListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputPlaybooksListResponse"}},"schemaId":"components/schemas/models.OutputPlaybooksListResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputPlaybooksListResponse"}},"schemaId":"components/schemas/models.OutputPlaybooksListResponse"}],"pointer":"/paths/~1v1~1playbooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/models.OutputPlaybooksListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputPlaybooksListResponse"}}},{"code":"400","schemaId":"components/schemas/models.OutputPlaybooksListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputPlaybooksListResponse"}}},{"code":"500","schemaId":"components/schemas/models.OutputPlaybooksListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/models.OutputPlaybooksListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/playbooks/paths/~1v1~1playbooks/get"}],"panels":[]}]},"httpPath":"/v1/playbooks"}],"content":{"contentType":"group","meta":{"name":"Playbooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Playbooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/playbooks","summary":"List playbooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/playbooks/paths/~1v1~1playbooks/get","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/models.RolesResultStruct":{"id":"components/schemas/models.RolesResultStruct","kind":"json-schema","title":"models.RolesResultStruct","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}}}},"components/schemas/models.ErrorStruct":{"id":"components/schemas/models.ErrorStruct","kind":"json-schema","title":"models.ErrorStruct","data":{"type":"object","properties":{"message":{"type":"string"}}}},"components/schemas/models.UserParams":{"id":"components/schemas/models.UserParams","kind":"json-schema","title":"models.UserParams","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"old_password":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true}}}},"components/schemas/models.User":{"id":"components/schemas/models.User","kind":"json-schema","title":"models.User","data":{"type":"object","required":["name","email","role"],"properties":{"name":{"type":"string","nullable":false},"email":{"type":"string","nullable":false},"role":{"type":"string","nullable":false},"password":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true}}}},"components/schemas/models.UserResult":{"id":"components/schemas/models.UserResult","kind":"json-schema","title":"models.UserResult","data":{"type":"object","properties":{"_id":{"type":"string"},"added_date":{"type":"string"},"email":{"type":"string"},"ip":{"description":"omitempty because it's not in the second object","type":"string"},"is_amops":{"type":"boolean"},"last_login":{"description":"omitempty because it's not in the second object","type":"string"},"name":{"type":"string"},"period":{"type":"string"},"role":{"type":"string"},"status":{"type":"integer"},"locale":{"type":"string"}}}},"components/schemas/models.ListUsersOutput":{"id":"components/schemas/models.ListUsersOutput","kind":"json-schema","title":"models.ListUsersOutput","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.UserResult"}},"total":{"type":"integer"}}}},"components/schemas/models.UsersResultStruct":{"id":"components/schemas/models.UsersResultStruct","kind":"json-schema","title":"models.UsersResultStruct","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.ListUsersOutput"},"success":{"type":"boolean"}}}},"components/schemas/models.IdentitySystem":{"id":"components/schemas/models.IdentitySystem","kind":"json-schema","title":"models.IdentitySystem","data":{"type":"object","properties":{"auth_fail_count":{"type":"integer"},"auth_success_count":{"type":"integer"},"auth_failed_percent":{"type":"number"},"directory_category_list":{"type":"array","items":{"type":"string"}},"failed_auth_list":{"type":"array","items":{"type":"string"}},"is_directory_public":{"type":"boolean"},"directory_hostname":{"type":"string"}}}},"components/schemas/models.AccessDetails200FinalResponse":{"id":"components/schemas/models.AccessDetails200FinalResponse","kind":"json-schema","title":"models.AccessDetails200FinalResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"object","properties":{"_id":{"type":"string"},"flow_count":{"type":"integer"},"latest_activity_time":{"type":"string","format":"date-time"},"score":{"type":"number"},"asset_protocol":{"type":"string"},"asset_is_known":{"type":"boolean"},"identity_is_known":{"type":"boolean"},"identity_system":{"$ref":"#/components/schemas/models.IdentitySystem"}}},"success":{"type":"boolean"}}}},"components/schemas/models.AccessDetailsFinalResponse":{"id":"components/schemas/models.AccessDetailsFinalResponse","kind":"json-schema","title":"models.AccessDetailsFinalResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"object"},"success":{"type":"boolean"}}}},"components/schemas/models.PlaybookDetail":{"id":"components/schemas/models.PlaybookDetail","kind":"json-schema","title":"models.PlaybookDetail","data":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"},"severity":{"type":"integer"}}}},"components/schemas/models.FinalResponsIssueDetails":{"id":"components/schemas/models.FinalResponsIssueDetails","kind":"json-schema","title":"models.FinalResponsIssueDetails","data":{"type":"object","properties":{"issue_type":{"type":"string"},"issue_risk":{"type":"integer"},"playbook_details":{"type":"array","items":{"$ref":"#/components/schemas/models.PlaybookDetail"}}}}},"components/schemas/models.AssetDetails200FinalResponse":{"id":"components/schemas/models.AssetDetails200FinalResponse","kind":"json-schema","title":"models.AssetDetails200FinalResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"object","properties":{"_id":{"type":"string"},"score":{"type":"number"},"latest_activity_time":{"type":"string","format":"date-time"},"flow_count":{"type":"integer"},"identity_count":{"type":"integer"},"is_known":{"type":"boolean"},"issue_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/models.FinalResponsIssueDetails"}}}},"success":{"type":"boolean"}}}},"components/schemas/models.AssetDetailsFinalResponse":{"id":"components/schemas/models.AssetDetailsFinalResponse","kind":"json-schema","title":"models.AssetDetailsFinalResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"object"},"success":{"type":"boolean"}}}},"components/schemas/models.IdentityDetailsFinalResponse":{"id":"components/schemas/models.IdentityDetailsFinalResponse","kind":"json-schema","title":"models.IdentityDetailsFinalResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"object"},"success":{"type":"boolean"}}}},"components/schemas/models.DetailResult":{"id":"components/schemas/models.DetailResult","kind":"json-schema","title":"models.DetailResult","data":{"type":"object","properties":{"full_name":{"type":"string"},"score":{"type":"number"},"latest_activity_time":{"type":"string","format":"date-time"},"flow_count":{"type":"integer"},"asset_count":{"type":"integer"},"is_known":{"type":"boolean"},"issue_count":{"type":"integer"},"issue_details":{"$ref":"#/components/schemas/models.FinalResponsIssueDetails"}}}},"components/schemas/models.IdentityDetails200FinalResponse":{"id":"components/schemas/models.IdentityDetails200FinalResponse","kind":"json-schema","title":"models.IdentityDetails200FinalResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.DetailResult"},"success":{"type":"boolean"}}}},"components/schemas/models.IdentityHostsMainResultResponseOut":{"id":"components/schemas/models.IdentityHostsMainResultResponseOut","kind":"json-schema","title":"models.IdentityHostsMainResultResponseOut","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.IdentityHostsResultResponseOut"}},"total":{"type":"integer"}}}},"components/schemas/models.IdentityHostsResponseOut":{"id":"components/schemas/models.IdentityHostsResponseOut","kind":"json-schema","title":"models.IdentityHostsResponseOut","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.IdentityHostsMainResultResponseOut"},"success":{"type":"boolean"}}}},"components/schemas/models.IdentityHostsResultResponseOut":{"id":"components/schemas/models.IdentityHostsResultResponseOut","kind":"json-schema","title":"models.IdentityHostsResultResponseOut","data":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"latest_activity_time":{"type":"string"},"state":{"type":"string"}}}},"components/schemas/models.IdentitySystemDetailFinalResponse":{"id":"components/schemas/models.IdentitySystemDetailFinalResponse","kind":"json-schema","title":"models.IdentitySystemDetailFinalResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"object"},"success":{"type":"boolean"}}}},"components/schemas/models.IdentitySystemDetailResult":{"id":"components/schemas/models.IdentitySystemDetailResult","kind":"json-schema","title":"models.IdentitySystemDetailResult","data":{"type":"object","properties":{"_id":{"type":"string"},"flow_count":{"type":"integer"},"latest_activity_time":{"type":"string","format":"date-time"},"identity_count":{"type":"integer"},"asset_count":{"type":"integer"},"auth_failed_percentage":{"type":"number"},"incident_count":{"type":"integer"},"score":{"type":"number"},"issue_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/models.FinalResponsIssueDetails"}},"category_info_details":{"type":"array","items":{"type":"string"}},"host_names":{"type":"array","items":{"type":"string"}},"services":{"type":"array","items":{"type":"string"}}}}},"components/schemas/models.IdentitySystemDetailFinal200Response":{"id":"components/schemas/models.IdentitySystemDetailFinal200Response","kind":"json-schema","title":"models.IdentitySystemDetailFinal200Response","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.IdentitySystemDetailResult"},"success":{"type":"boolean"}}}},"components/schemas/models.OutAccessOutput":{"id":"components/schemas/models.OutAccessOutput","kind":"json-schema","title":"models.OutAccessOutput","data":{"type":"object","properties":{"_id":{"type":"string"},"asset":{"type":"string"},"asset_protocol":{"type":"string"},"asset_type":{"type":"string"},"directory_name":{"type":"string"},"directory_type":{"type":"string"},"identity":{"type":"string"},"identity_type":{"type":"string"},"latest_activity_time":{"type":"string"},"score":{"type":"number"}}}},"components/schemas/models.OutAssetHostsMainResultResponse":{"id":"components/schemas/models.OutAssetHostsMainResultResponse","kind":"json-schema","title":"models.OutAssetHostsMainResultResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.OutAssetHostsResultResponse"}},"total":{"type":"integer"}}}},"components/schemas/models.OutAssetHostsResponse":{"id":"components/schemas/models.OutAssetHostsResponse","kind":"json-schema","title":"models.OutAssetHostsResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.OutAssetHostsMainResultResponse"},"success":{"type":"boolean"}}}},"components/schemas/models.OutAssetHostsResultResponse":{"id":"components/schemas/models.OutAssetHostsResultResponse","kind":"json-schema","title":"models.OutAssetHostsResultResponse","data":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"latest_activity_time":{"type":"string"},"state":{"type":"string"}}}},"components/schemas/models.OutAssetOutput":{"id":"components/schemas/models.OutAssetOutput","kind":"json-schema","title":"models.OutAssetOutput","data":{"type":"object","properties":{"_id":{"type":"string"},"latest_activity_time":{"type":"string"},"score":{"type":"number"},"type":{"type":"string"}}}},"components/schemas/models.FinalUserResponse":{"id":"components/schemas/models.FinalUserResponse","kind":"json-schema","title":"models.FinalUserResponse","data":{"type":"object","properties":{"errors":{"type":"string"},"success":{"type":"boolean"}}}},"components/schemas/models.OutIdentityOutput":{"id":"components/schemas/models.OutIdentityOutput","kind":"json-schema","title":"models.OutIdentityOutput","data":{"type":"object","properties":{"_id":{"type":"string"},"full_name":{"type":"string"},"identity_statuses":{"type":"array","items":{"type":"string"}},"latest_activity_time":{"type":"string"},"score":{"type":"number"},"type":{"type":"string"}}}},"components/schemas/models.OutIdentitySystemsOutput":{"id":"components/schemas/models.OutIdentitySystemsOutput","kind":"json-schema","title":"models.OutIdentitySystemsOutput","data":{"type":"object","properties":{"_id":{"type":"string"},"directory_type":{"type":"string"},"domain":{"type":"string"},"latest_activity_time":{"type":"string"},"name":{"type":"string"},"score":{"type":"number"}}}},"components/schemas/models.IssueAccessOut":{"id":"components/schemas/models.IssueAccessOut","kind":"json-schema","title":"models.IssueAccessOut","data":{"type":"object","properties":{"access_id":{"type":"integer"},"issue_id":{"type":"integer"},"user_id":{"type":"string"},"user_name":{"type":"string"},"resource_id":{"type":"string"},"resource_name":{"type":"string"},"access_type":{"type":"string"},"access_timestamp":{"type":"string"},"risk":{"type":"number"},"access_details_url":{"type":"string"}}}},"components/schemas/models.IssuesAccessListResponse":{"id":"components/schemas/models.IssuesAccessListResponse","kind":"json-schema","title":"models.IssuesAccessListResponse","data":{"type":"object","properties":{"error":{"type":"string"},"success":{"type":"boolean"},"result":{"type":"array","items":{"$ref":"#/components/schemas/models.IssueAccessOut"}},"total":{"type":"integer"}}}},"components/schemas/models.OutListAccessResultResponse":{"id":"components/schemas/models.OutListAccessResultResponse","kind":"json-schema","title":"models.OutListAccessResultResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.OutAccessOutput"}},"total":{"type":"integer"}}}},"components/schemas/models.OutListAssetResultResponse":{"id":"components/schemas/models.OutListAssetResultResponse","kind":"json-schema","title":"models.OutListAssetResultResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.OutAssetOutput"}},"total":{"type":"integer"}}}},"components/schemas/models.OutListIdentityResultResponse":{"id":"components/schemas/models.OutListIdentityResultResponse","kind":"json-schema","title":"models.OutListIdentityResultResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.OutIdentityOutput"}},"total":{"type":"integer"}}}},"components/schemas/models.OutListIdentitySystemsResultResponse":{"id":"components/schemas/models.OutListIdentitySystemsResultResponse","kind":"json-schema","title":"models.OutListIdentitySystemsResultResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.OutIdentitySystemsOutput"}},"total":{"type":"integer"}}}},"components/schemas/models.OutPlaybookOutput":{"id":"components/schemas/models.OutPlaybookOutput","kind":"json-schema","title":"models.OutPlaybookOutput","data":{"type":"object","properties":{"_id":{"type":"string","description":"Playbook ID"},"playbook_name":{"type":"string","description":"Playbook name"},"is_active":{"type":"boolean","description":"Whether the playbook is active"},"risk":{"type":"integer","description":"Risk level. 4 is critical, 3 is high, 2 is medium, 1 is low"},"modified_date":{"type":"string","description":"Last modified date (YYYY-MM-DD HH:MM:SS)"}}}},"components/schemas/models.OutListPlaybooksResultResponse":{"id":"components/schemas/models.OutListPlaybooksResultResponse","kind":"json-schema","title":"models.OutListPlaybooksResultResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/models.OutPlaybookOutput"}},"total":{"type":"integer"}}}},"components/schemas/models.OutputPlaybooksListResponse":{"id":"components/schemas/models.OutputPlaybooksListResponse","kind":"json-schema","title":"models.OutputPlaybooksListResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.OutListPlaybooksResultResponse"},"success":{"type":"boolean"}}}},"components/schemas/models.OutputAccessesListResponse":{"id":"components/schemas/models.OutputAccessesListResponse","kind":"json-schema","title":"models.OutputAccessesListResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.OutListAccessResultResponse"},"success":{"type":"boolean"}}}},"components/schemas/models.OutputAssetListResponse":{"id":"components/schemas/models.OutputAssetListResponse","kind":"json-schema","title":"models.OutputAssetListResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.OutListAssetResultResponse"},"success":{"type":"boolean"}}}},"components/schemas/models.OutputIdentitiesListResponse":{"id":"components/schemas/models.OutputIdentitiesListResponse","kind":"json-schema","title":"models.OutputIdentitiesListResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.OutListIdentityResultResponse"},"success":{"type":"boolean"}}}},"components/schemas/models.OutputIdentitySystemsListResponse":{"id":"components/schemas/models.OutputIdentitySystemsListResponse","kind":"json-schema","title":"models.OutputIdentitySystemsListResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"$ref":"#/components/schemas/models.OutListIdentitySystemsResultResponse"},"success":{"type":"boolean"}}}},"components/schemas/models.IssuesListResponse":{"id":"components/schemas/models.IssuesListResponse","kind":"json-schema","title":"models.IssuesListResponse","data":{"type":"object","properties":{"error":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/models.IssueListingOut"}},"success":{"type":"boolean"},"total":{"type":"integer"}}}},"components/schemas/models.IssueListingOut":{"id":"components/schemas/models.IssueListingOut","kind":"json-schema","title":"models.IssueListingOut","data":{"type":"object","properties":{"issue_id":{"type":"integer"},"message":{"type":"string"},"issue_flows_count":{"type":"integer"},"issue_access_count":{"type":"integer"},"first_flow_time":{"type":"string"},"gen_timestamp":{"type":"string"},"issue_type":{"type":"string"},"playbook_name":{"type":"string"},"risk":{"type":"number","format":"double"},"incident_accesses_url":{"type":"string"},"incident_access_api":{"type":"string"}}}},"schema_28":{"kind":"json-schema","data":{"type":"string","example":"Access denied: missing required permissions"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"string","enum":["name","email","added_date","last_login","status","ip","role"]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"]},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"string","enum":["issue_id","issue_flows_count","issue_access_count","gen_timestamp","playbook_name","risk","issue_type","first_flow_time"]},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"string","enum":["4","3","2","1"]},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string","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","Compromised User","Deviation in Daily Asset Activity","Enumeration of AD Admins","Enumeration of AD Users","Exposed Assets","Lack of MFA","Identity No MFA","Asset No MFA","Shadow Access","Shadow Assets","Shadow Identity Systems","Suspected AD NTLM Relay Attack","Suspected Attack on Disabled AD Account","Suspected Attack on Expired AD Account","Suspected Attack on Locked AD Account","Suspected AD Brute-force Attack","Suspected Identity Brute-force Attack","Suspected Directory/IdP Bot Attack","Suspected Directory/IdP Password Spray Attack","Suspicious Inbound Access","Suspicious Outbound Access","Unauthorized Asset Access","Unknown SaaS Access","Weak Password","Unauthorized Identity Access","Impossible Travel","Suspected Access Token Sharing"]},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"string","enum":["Open","Closed","Resolved"]},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","enum":["latest_activity_time","asset_name","asset_protocol","asset_type","identity_name","identity_type","flow_count","first_activity_time"]},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"string","enum":["ASC","DESC"]},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"string","enum":["issue_id","issue_time","flow_count","incident_count","risk"]},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the request was successful."},"results":{"type":"array","items":{"type":"object","properties":{"issue_time":{"type":"string","format":"date-time","description":"First timestamp when issue was captured.","example":"2024-08-01T10:31:42.000Z"},"issue_id":{"type":"string","description":"Issue Id.","example":"17263-1722579276407"},"issue_type":{"type":"string","description":"Type of the issue.","example":"Auth Hash Security"},"playbook_name":{"type":"string","description":"Playbook name associated with the issue.","example":"Auth Hash Security Playbook"},"issue_keys":{"type":"object","description":"Field name(s) on which the related Incidents were grouped to create the issue.","example":{"domain":"example.com","hash_algo":"sha256"}},"message":{"type":"string","description":"Description of the issue.","example":"The directory on example.com uses a weak hash algorithm md4 which is not secure and easy to crack."},"risk":{"type":"string","description":"Risk associated with the issue.","enum":["Low","Medium","High","Critical"]},"flow_count":{"type":"integer","description":"Total number of flows for the issue.","example":500},"incident_count":{"type":"integer","description":"Total number of incidents for the issue.","example":20},"incidents_url":{"type":"string","description":"URL link for the oldest issue incident on console.","example":"https://console.authmind.com/issues?q=id%3A3817066"},"issue_details_api":{"type":"string","description":"URL link for fetching the issue details.","example":"https://console.authmind.com/amapi/v1/getIssueDetails?issue_id=17263-1722579276407"}}}},"metadata":{"type":"object","description":"Response metadata"}}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","description":"Error string if request fails."},"success":{"type":"boolean","description":"Indicates if the request was successful."},"results":{"type":"string","nullable":true,"example":null}}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","enum":["incident_id","incident_risk","flow_count","last_seen","first_seen"]},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the request was successful."},"results":{"type":"array","items":{"type":"object","properties":{"first_seen":{"type":"string","format":"date-time","description":"Timestamp when the issue was first seen.","example":"2024-07-01T10:31:42.000Z"},"last_seen":{"type":"string","format":"date-time","description":"Timestamp when the issue was last seen.","example":"2024-08-01T10:31:42.000Z"},"risk":{"type":"string","description":"Risk associated with the issue.","enum":["Low","Medium","High","Critical"]},"message":{"type":"string","description":"Description of the issue.","example":"The directory on example.com uses a weak hash algorithm md4 which is not secure and easy to crack."},"issue_type":{"type":"string","description":"The issue type associated with the incident.","example":"Auth Hash Security"},"issue_keys":{"type":"object","description":"Field name(s) on which the related Incidents were grouped to create the issue.","example":{"domain":"example.com","hash_algo":"sha256"}},"incidents_url":{"type":"string","description":"URL link for the oldest issue incident on console.","example":"https://console.authmind.com/issues?q=id%3A3817066"},"total_flow_count":{"type":"integer","description":"Total number of flows for the issue.","example":100},"total_incident_count":{"type":"integer","description":"Total number of incidents for the issue.","example":1},"incidents":{"type":"array","items":{"type":"object","properties":{"asset_hostname":{"type":"string","description":"Hostname of the asset.","example":"example.auto.local"},"asset_name":{"type":"string","description":"Name of the asset.","example":"Kerberos App"},"asset_port":{"type":"integer","description":"Port associated with the asset.","example":88},"asset_protocol":{"type":"string","description":"Protocol associated with the asset.","example":"Kerberos"},"asset_type":{"type":"string","description":"Type of the asset.","example":"App"},"first_seen":{"type":"string","format":"date-time","description":"Timestamp when the incident was first seen.","example":"2024-08-01T10:31:42.000Z"},"flow_count":{"type":"integer","description":"Total number of flows for the incidents.","example":100},"identity_hostname":{"type":"string","description":"Hostname of the identity.","example":"example.auto.local"},"identity_name":{"type":"string","description":"Name of the identity.","example":"xyz@example.com"},"identity_type":{"type":"string","description":"Type of the identity.","example":"User"},"incident_id":{"type":"string","description":"Incident id.","example":3830559},"incident_risk":{"type":"string","enum":["Low","Medium","High","Critical"],"description":"Risk associated with the incident"},"incident_url":{"type":"string","description":"URL for searching the incident","example":"https://console.authmind.com/issues?q=id%3A3830559"},"incident_highlights":{"type":"string","description":"Highlights associated with the incident.","example":"<i><b>xyz.example.com</i></b> uses a weak password hash algorithm - <i><b>md4</i></b>"},"last_seen":{"type":"string","format":"date-time","description":"Timestamp when the incident was last seen.","example":"2024-08-01T10:31:42.000Z"},"playbook_name":{"type":"string","description":"Playbook name corresponding to the incident.","example":"Auth Hash Security Playbook"},"site_code":{"type":"string","description":"Code associated with the incident site.","example":"AD01"},"status":{"type":"string","description":"Status of the incident.","enum":["Open","Closed","Resolved"]}}}}}}},"metadata":{"type":"object","description":"Response metadata."}}},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","enum":["On-premise","Cloud IDP"]},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"number"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","enum":["playbook_name","risk","modified_date","is_active"]},"id":"schema_48"}},"exampleStore":{"paths/~1v1~1roles/get/responses/500/content/application~1json/example":{"value":{"error":"Internal Server Error","success":false,"result":[]},"id":"paths/~1v1~1roles/get/responses/500/content/application~1json/example"},"paths/~1v1~1users/get/responses/400/content/application~1json/example":{"value":{"result":{"total":0,"data":[]},"success":false,"error":"from must be >= 1"},"id":"paths/~1v1~1users/get/responses/400/content/application~1json/example"},"paths/~1v1~1user/post/responses/400/content/application~1json/example":{"value":{"errors":"Either id or email is required","success":false},"id":"paths/~1v1~1user/post/responses/400/content/application~1json/example"},"paths/~1v1~1user/post/responses/500/content/application~1json/example":{"value":{"errors":"Internal Server Error","success":false},"id":"paths/~1v1~1user/post/responses/500/content/application~1json/example"},"paths/~1v1~1user/delete/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1user/delete/responses/200/content/application~1json/example"},"paths/~1v1~1user/delete/responses/400/content/application~1json/example":{"value":{"errors":"Either id or email is required","success":false},"id":"paths/~1v1~1user/delete/responses/400/content/application~1json/example"},"paths/~1v1~1user/delete/responses/500/content/application~1json/example":{"value":{"errors":"Internal Server Error","success":false},"id":"paths/~1v1~1user/delete/responses/500/content/application~1json/example"},"paths/~1v1~1user/patch/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1user/patch/responses/200/content/application~1json/example"},"paths/~1v1~1user/patch/responses/400/content/application~1json/example":{"value":{"errors":"An error occurred while processing your request. Please ensure the input format is correct and try again.","success":false},"id":"paths/~1v1~1user/patch/responses/400/content/application~1json/example"},"paths/~1v1~1user/patch/responses/500/content/application~1json/example":{"value":{"errors":"Internal Server Error","success":false},"id":"paths/~1v1~1user/patch/responses/500/content/application~1json/example"},"paths/~1v1~1issues/get/responses/500/content/application~1json/example":{"value":{"error":"Internal Server Error","success":false,"result":[]},"id":"paths/~1v1~1issues/get/responses/500/content/application~1json/example"},"paths/~1v1~1issue~1{incident_id}~1accesses/get/responses/500/content/application~1json/example":{"value":{"error":"Internal Server Error","success":false,"result":[]},"id":"paths/~1v1~1issue~1{incident_id}~1accesses/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"AuthorizationHeader":{"id":"AuthorizationHeader","type":"http","scheme":"bearer","description":"Authenticate with Authmind API token. We can get API token from step 7 of Getting Started."}},"servers":[{"url":"/_mock/v1/docs","isMockServer":true,"description":"Mock server"},{"url":"{{.Host}}/amapi"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/v1/docs","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@v1/docs.json?download"},{"url":"/_bundle/@v1/docs.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"AuthMind API","description":"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.\n\nAuthMind 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.\n\n## Key Sections of this Documentation\n\n**Getting Started:** Learn how to generate tokens to access the APIs and API documentation.\n\n**Endpoints:** Detailed descriptions of each endpoint, including parameters, request, and response structures.\n\nWe are committed to providing a user-friendly API experience. Let's get started!\n\n## Getting Started\n1. Log in to AuthMind and go to the **Admin** section.\n2. From the left navigation, click **API Tokens**. The **Manage API Tokens** page is displayed\n3. From the top-right side, click **Add**. The **Add API** Client dialog is displayed.\n4. Enter a name for the client.\n5. By default, a one-year expiration date is set from the creation date of the token. You can change this date, as required.\n6. Click **Submit**. A success message is displayed. You can also see a **Token Details** dialog that contains the API token (JWT).\n7. Copy the token.\n8. Click OK to close the **Token Details** dialog. You can see the token is listed on the **Manage API Tokens** page.\n"}},"baseSlug":"/v1/docs","routesMapping":{}}