AuthnFactor Meta

Meta APIs for Identity Protection AuthnFactor

Download AuthnFactor Meta OpenAPI Document

End Points

/meta/protection/authnfactors/{factor_type}

Get All AuthnFactors

The Get All AuthnFactors API can be used to get the details of all authnFactors in your account.
OAuth Scope : id360.meta.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/meta/protection/authnfactors"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/meta/protection/authnfactors")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/meta/protection/authnfactors', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/meta/protection/authnfactors", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/meta/protection/authnfactors",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/meta/protection/authnfactors \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        {
            "factor_type": "EmailAuthenticator",
            "display_name": "Email Verification",
            "is_custom_factor": false,
            "display_order": 1
        },
        {
            "factor_type": "FIDOAuthenticator",
            "display_name": "FIDO2 Passkeys",
            "is_custom_factor": false,
            "display_order": 2
        },
        {
            "factor_type": "MicrosoftAuthenticator",
            "display_name": "Microsoft Authenticator",
            "is_custom_factor": false,
            "display_order": 3
        },
        {
            "factor_type": "GoogleAuthenticator",
            "display_name": "Google Authenticator",
            "is_custom_factor": false,
            "display_order": 4
        },
        {
            "factor_type": "SQAAuthenticator",
            "display_name": "SQA Authenticator",
            "is_custom_factor": false,
            "display_order": 5
        },
        {
            "factor_type": "SMSAuthenticator",
            "display_name": "SMS Verification",
            "is_custom_factor": false,
            "display_order": 6
        },
        {
            "factor_type": "DUOAuthenticator",
            "display_name": "Duo",
            "is_custom_factor": false,
            "display_order": 7
        },
        {
            "factor_type": "CustomTOTPAuthenticator",
            "display_name": "Custom TOTP Authenticator",
            "is_custom_factor": true,
            "display_order": 8
        },
        {
            "factor_type": "ZohoOneAuthAuthenticator",
            "display_name": "Zoho OneAuth TOTP",
            "is_custom_factor": false,
            "display_order": 9
        },
        {
            "factor_type": "SAMLAuthenticator",
            "display_name": "SAML Authenticator",
            "is_custom_factor": false,
            "display_order": 10
        },
        {
            "factor_type": "SmartCardAuthenticator",
            "display_name": "Smart Card Authentication",
            "is_custom_factor": false,
            "display_order": 11
        }
    ]
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Get AuthnFactor

The Get AuthnFactor API can be used to get the details of a specific authnFactor in your account.
OAuth Scope : id360.meta.READ

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/meta/protection/authnfactors/EmailAuthenticator"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/meta/protection/authnfactors/EmailAuthenticator")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/meta/protection/authnfactors/EmailAuthenticator', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("id360.manageengine.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/api/v1/meta/protection/authnfactors/EmailAuthenticator", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/meta/protection/authnfactors/EmailAuthenticator",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://id360.manageengine.com/api/v1/meta/protection/authnfactors/EmailAuthenticator \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": {
        "factor_type": "EmailAuthenticator",
        "display_name": "Email Verification",
        "display_order": 1,
        "is_custom_factor": true,
        "factor_details": {
            "fido_rp_id": "id360.manageengine.com",
            "saml_provider_list": [
                {
                    "name": "okta",
                    "label": "Okta"
                },
                {
                    "name": "onelogin",
                    "label": "Onelogin"
                }
            ]
        }
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "---",
        "title": "AuthnFactor Not Found",
        "detail": "This AuthnFactor type does not exist."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}