Skip to main content

TemplateSession

createTemplate​

Creates an authentication template by the identifier of an open session.

[POST] /api/v5/templateSession/createTemplate
Request object
{
 "SessionId": "00000000-0000-0000-0000-000000000000"
}

in the request object:

  • SessionId — required parameter. The GUID of the open session obtained from the openVerifySession method is specified.
Response object
"00000000-0000-0000-0000-000000000000"

openEnrollSession​

[POST] /api/v5/templateSession/openEnrollSession

openVerifySession​

Opens a session for authentication of the user specified in UserSearchParams in the application ApplicationId, using the authentication method ModeId.

[POST] /api/v5/templateSession/openVerifySession
Request object
{
  "UserSearchParams": {
    "Id": "string",
    "Email": "string",
    "Phone": "string",
    "NameFormat": 0,
    "Name": "string",
    "ApplicationId": "string"
  },
  "ModeId": "00000000-0000-0000-0000-000000000000",
  "ApplicationId": "string"
}

in the request object:

  • UserSearchParams — array of parameters for searching for the user;
    • Id — internal identifier of the user in Axidian Access;
    • Email — email of the user from the Active Directory catalog;
    • Phone — phone number of the user from the Active Directory catalog;
    • NameFormat — numeric value of the name format that will be specified in Name. The following formats are supported:
      • 0 — Undefined;
      • 1 — CanonicalName;
      • 2 — PrincipalName: name@domain.name;
      • 3 — SamCompatibleName: domain\logon-name;
      • 4 — DistinguishedName;
      • 5 — Sid;
  • ModeId — required parameter. String identifier of the authentication method used.
  • ApplicationId — required parameter. String identifier of the Axidian Access module.
Response object
GUID of the open session

"00000000-0000-0000-0000-000000000000"

openIdentifySession​

[POST] /api/v5/templateSession/openIdentifySession

prepareTemplateData​

Adds information about the user's template. 

[POST] /api/v5/templateSession/prepareTemplateData
Request object
{
  "Data": {},
  "SessionId": "00000000-0000-0000-0000-000000000000"
}

in the request object:

  • Data — the user's authentication data (a one-time code or password or other data depending on the authentication method used);
  • SessionId — identifier of the open session obtained in openVerifySession.
Response object
{
  "EnoughData": true,
  "BinaryData": "string",
  "StringData": "string"
}

in the response object:

  • EnoughData — indication that there is enough data from the client to build the template.
Example of a response object
{
  "ValidPropertiesMask": 1,
  "EnoughData": true,
  "BinaryData": null,
  "StringData": null
}