Skip to content

GetAccessDetails

Request

Returns access details

Endpoint: GET /v1/access/details. Authentication: requires AuthorizationHeader bearer token unless this operation's security is changed. Required AuthMind permission/scope: posture (grant this scope on the API token in Admin > API Tokens; a token without it receives 403 Forbidden). Documented parameters: identity_name, identity_type, asset_name, asset_type, directory_name. Response parsing: inspect success; on failure inspect error, errors, or message depending on the referenced schema.

Security
AuthorizationHeader
Query
identity_namestringrequired

Identity Name

This parameter is required for the endpoint to execute successfully.

identity_typestringrequired

Identity Type

This parameter is required for the endpoint to execute successfully.

asset_namestringrequired

Asset Name

This parameter is required for the endpoint to execute successfully.

asset_typestringrequired

Asset Type

This parameter is required for the endpoint to execute successfully.

directory_namestring

Directory Name if present

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

Responses

Request completed successfully. See the referenced schema for the response envelope and result payload.

Bodyapplication/json
errorstring

Error message returned when the request fails. This is free-form, human-readable text intended for logging/display -- AuthMind does not define a stable, cross-endpoint error-code contract for it. Branch integration logic on the HTTP status code and the success boolean, not on the contents of this string.

resultobject

Primary response payload for this endpoint.

Example:
{
  "_id": "64f1a2b3c4d5e6f7890a1b2c",
  "flow_count": 128,
  "latest_activity_time": "2024-08-01T10:31:42.000Z",
  "score": 72.5,
  "asset_protocol": "Kerberos",
  "asset_is_known": true,
  "identity_is_known": true,
  "identity_system": {
    "auth_fail_count": 7,
    "auth_success_count": 193,
    "auth_failed_percent": 3.5,
    "directory_category_list": [ … ],
    "failed_auth_list": [ … ],
    "is_directory_public": false,
    "directory_hostname": "ad01.example.auto.local"
  }
}
successboolean

Indicates whether the request was successful.

Response
{
  "error": "",
  "result": {
    "_id": "64f1a2b3c4d5e6f7890a1b2c",
    "flow_count": 128,
    "latest_activity_time": "2024-08-01T10:31:42.000Z",
    "score": 72.5,
    "asset_protocol": "Kerberos",
    "asset_is_known": true,
    "identity_is_known": true,
    "identity_system": { … }
  },
  "success": true
}