3.2 Working With Endpoints

3.2.1 About Endpoints

The appliance provide user’s authentication in different places, ex. Microsoft Windows, Apple MacOS X or other custom applications and systems. The final destination of user’s authentication is endpoint. The endpoint could be a physical workstation or an application. The endpoints are combined in the events, the event is a logical separation for the endpoints. The Windows logon and Mac OS logon are different events, each event could had some set of the endpoints, and endpoints are Mac or Windows workstations. System has the following standard events.

Table 3-1 Supported Events List

Event name	Event identifier	Description
Windows logon	WINDOWS	Event for log on in Microsoft Windows, used for authentication on Windows based operation system.
Template management	TEMPLATES	Template (authenticator) management event, this event is used for the enrollment process, collecting authentication data and updating user’s template.
Endpoint management	ENDPOINTS	Endpoint management event, for management endpoints use this event.
NAM	NAM	Event for Advanced Authentication Access Manager.
NCA	NCA	Event for Advanced Authentication Cloud Access.
Admin user interface	ADMIN	The event for logon into Advanced Authentication Administrative Portal.
Radius Server	RADIUS	The event for logon by RADIUS server.
Helpdesk	HELPDESK	The event for logon into Advanced Authentication Helpdesk Portal.
MacOS logon	MACOS	The event for log on in Apple MacOS.

3.2.2 Create Endpoint

For creating endpoint, you could use the following resource with URI:

/endpoints

Resource provided by HTTP POST and has these parameters as JSON-object.

Table 3-2 URI Parameters for creating endpoint.

URI parameter name	Description
name	A name for the new endpoint.
typ	A type identifier of the new endpoint.
desc	A description of the new endpoint

The appliance supports this list of the endpoints types:

Table 3-3 Supported endpoint types

Type value	Type identifier	Description
TYP_UNKNOWN	1	The unknown type for the endpoint, use this value if you couldn’t use other identifier.
TYP_WINDOWS_CLIENT	2	The identifier for the Windows Clients.
TYP_NAM	3	The identifier for the Advanced Authentication Access Manager.
TYP_MACOS_CLIENT	4	The identifier for the Mac OS Clients.
TYP_LINUX_CLIENT	5	The identifier for the Linux Clients.
TYP_NCA	6	The identifier for the Advanced Authentication CloudAccess.
TYP_RADIUS	7	The identifier for the RADIUS client.

The resource returns a JSON-object, which contain the identifier and the secret of the created endpoint.

Table 3-4 Object with created endpoint.

Parameter name	Description
id	The identifier of the created endpoint.
secret	The secret of the created endpoint.

Example

The following example demonstrates how to create a new endpoint.

HTTP POST
https://authserver.example.com/api/v1/endpoints
equest
{
"name":"nam.company.local",
"typ":3,
"desc":"NAM endpoint"
}
Response
{
"id":"885f71c85b8711e5b507000c2951aca4",
"secret":"Mxy4NJLHEGYicviRqrPqdaxRo0RAQtYn"
}

3.2.3 Delete Endpoint

For deleting endpoint, you could use the following resource with URI:

/endpoints/{endpoint_id}?secret={endpoint_secret}

Resource is provided by HTTP DELETE. It has the following parameters.

URI Parameter Name	Parameter Description
endpoint_id	Endpoint identifier. Identifier of endpoint for deleting.
secret	The secret of the endpoint for deleting

Resource does not return any data. If the deletion is successful, the HTTP 200 status will be returned.ExampleEndpoint with identifier “42424242424242424242424242424242” and secret “1234567890” will be deleted in the following example.

HTTP DELETEhttps://authserver.example.com/api/v1/endpoints/42424242424242424242424242424242?secret=1234567890ResponseHTTP 200