Identity Syncronizer – API Gateway

blareweyrSoftware and s/w Development

Dec 13, 2013 (3 years and 7 months ago)

171 views





Identity Syncronizer


API Gateway


This document will explain the operations and give some insight into the
IDSync® API Gateway.



VERSION
1.0.1

12/13/2013


You can find updates of this file here: http://www.idsync.com/downloads


© InnerApps, LLC.
2013

|
Id
entity
Sync
ronizer


P a g e

|


i



Identity Syncronizer


䅐䤠G慴ew慹

TABLE OF CONTENTS

Start Here

................................
................................
................................
................................
................................
................................
...

1

Workflow

................................
................................
................................
................................
................................
................................
...

2

Setup

................................
................................
................................
................................
................................
................................
..........

2

Known Connection string Examples
................................
................................
................................
................................
...........................

4


GLOSSARY
Gateway
:
Shorthand for

the IDSync® API Gateway product.

API
:
Application Programming Interface. A means to allow two unrelated data
-
driven systems to talk to one another.

Config:

Shorthand for “configuration”.


















© InnerApps, LLC.
2013

|
Id
entity
Sync
ronizer


P a g e

|


1



Identity Syncronizer


䅐䤠G慴ew慹

START HERE

IDENTITY SYNCRONIZER


Customers of Pa
rallels® Operations Automation can now utilize Identity Syncronizer™ to integrate customer identity information
from Microsoft’s Active Directory via the use of a new Identity Connector and APS package. This new integration dramatically
improves a Service/
Cloud Provider’s ability to quickly on
-
board new customers and provision user’s access and privileges within their
Parallels® Operations Automation software by leveraging the end
-
customers Active Directory system as a centralized cloud identity
management
system.

DOCUMENT SCOPE

Customers of IDSync® can now enjoy the peace of mind of a secure public API. This utility acts as a secured proxy front
-
end facing
API endpoint, which in turn talks to (as of this documentation) Parallels API safely behind your exi
sting firewall(s).

This document will give some insight into
the workflow and aid in the set
up process of the utility.




© InnerApps, LLC.
2013

|
Id
entity
Sync
ronizer


P a g e

|


2



Identity Syncronizer


䅐䤠G慴ew慹

Figure
1

WORKFLOW


SETUP

As seen in
figure 1
, there are few fields to enter
information into.

As of this document, the only API we currently
support is Parallel’s POA and PBA APIs.

In this configuration we’re going to omit PBA’s
information. The POA API URL and port should
match the
local/network

IP (hostnames will work
too, however IP’s are pre
ferred as they do not
tend to change often inside networks). The
default POA API port is
8440
, consult with your
Parallels support representative or system
administrator if it is unknown to you.

The client URL
must
be secure (
https://)

as this is
the Gat
eway URL. Ideally this should be a
publically visible IP

address and the port should be
in the 8000
-
8999 range. You may experiment with
other ports, but only the range above was tested.


Log Level
is a designation fields to the level of verbosity your l
ogs will be. Lastly the
Authorized Users Only

check
-
box is for setting
up specified users to have access to the gateway for an even more secure approach.

API Request
Sent

Gateway
Recieved


Tokenized Security Validation


Human/Sanity Checks

Proccess &
Return


If successful security validation:


Proccesses request


Sends to true API behind firewalls


Recieves actual response payload


Relays it back to end
-
user/application




© InnerApps, LLC.
2013

|
Id
entity
Sync
ronizer


P a g e

|


3



Identity Syncronizer


䅐䤠G慴ew慹

Figure
3

In the event authorized users are needed, checking
the box in
figure 1 will enable a new tab of the
same name.

The
Connection String

field i
s a freely
-
typed
dropdown field that you will have to enter an
XpoProvider

connection
-
string into. Examples for
said connections string can be found near the end
of this document.

Once the connection string is set, click “
C
onnect…”
on the lower left
-
side of the form.
A verbose error
messag
e will appear in the event it cannot connect.
To copy the message to your clipboard to paste into
an email simply press “CTRL+C” while focus is inside
the message box.

If successful the
Connection String

field will disable
as well as the button you just clicked; then the data
table in the middle of the form will allow you insert
new users.

While Username and
Password may be self
-
explanatory; Account
ID/Number

is a required
field

and Subscription
ID,
whil
e optional, is a filter on
which subscription IDSync®
will apply to.

Consult your Parallels
representative or system
administrator for these
details.

During the IDSync®
installation process the
Username and Password
may

be used to create your
“Gateway Se
cret” that with
authenticate against the
gateway.

It is beyond the scope of this
document to
advise

on the
installation of IDSync®
Management Studio.

Figure
2


© InnerApps, LLC.
2013

|
Id
entity
Sync
ronizer


P a g e

|


4



Identity Syncronizer


䅐䤠G慴ew慹

KNOWN CONNECTION STR
ING EXAMPLES


AccessConnectionProvider: MSAccess


XpoProvider=MSAccess;Provider=Micr
osoft.Jet.OLEDB.4.0;Data Source=C:
\
mydatabase.mdb;User Id=admin;Password=;


DataSetDataStore: XmlDataSet


XpoProvider=XmlDataSet;Data Source=C:
\
mydatabase.xml;Read Only=false


InMemoryDataStore: InMemoryDataStore


XpoProvider=InmemoryDataStore;Data
Source=C:
\
mydatabase.xml;Read Only=false


MSSqlConnectionProvider: MSSqlServer


XpoProvider=MSSqlServer;Data Source=(local);User ID=username;Password=password;Initial Catalog=database;Persist Security Info
=true


AdvantageConnectionProvider: Advantage


XpoP
rovider=Advantage;
\
\
myserver
\
myvolume
\
mypat
\
mydd.add;ServerType=local;User ID=ASSSYS;TrimTrailingSpaces=true


AsaConnectionProvider: Asa


XpoProvider=Asa;Uid=MyUsername;PWD=MyPassword;DBF=c:
\
mydatabase.db;Persist Security Info=true


AseConnectionPrvider: A
se


XpoProvider=Ase;Port=5000;Data Source=MyAseServer;User ID=MyUserName;Password=MyPassword;Initial
Catalog=MyDatabase;Persist Security Info=true


DB2ConnectionProvider: DB2


XpoProvider=DB2;Server=MyAddress:MyPortNumber;User
ID=MyUserName;Password=MyPassword;Database=MyDatabase;Persist
Security Info=true


FirebirdConnectionProvider: Firebird


XpoProvider=Firebird;DataSource=localhost;User=SYSDBA;Password=masterkey;Database=MyDatabase.fdb;ServerType=0;Charset=NONE


MSSqlCEConne
ctionProvider: MSSqlServerCE


XpoProvider=MSSqlServerCE;Data Source=MyDatabase.sdf;Password=MyPassword


MySqlConnectionProvider: MySql


XpoProvider=MySql;Server=MyServerAddress;User ID=MyUserName;Password=MyPassword;Database=MyDatabase;Persist Security
Inf
o= true;Charset=utf8


ODPConnectionProvider: ODP


XpoProvider=ODP;Data Source=TORCL;User ID=MyUserName;Password=MyPassword


OracleConnectionProvider: Oracle


XpoProvider=Oracle;Data Source=TORCL;User ID=MyUserName;Password=MyPassword


PervasiveSqlConnectio
nProvider: Pervasive


XpoProvider=Pervasive;Server=MyServerAddress;UID=MyUserName;PWD=MyPassword;ServerDSN=MyDatabase


PostgreSqlConnectionProvider: Postgres


XpoProvider=Postgres;Server=127.0.0.1;User ID=MyUserName;Password=MyPassword;Database=MyDatabase;
Encoding=UNICODE


SQLiteConnectionProvider: SQLite


XpoProvider=SQLite;Data Source=filename


VistaDBConnectionProvider: VistaDB


XpoProvider=VistaDB;Data Source=C:
\
mydatabase.vdb4