To uninstall a web application
- OR -
Click Finish on the last page to end the program.
You will find an overview of supplied methods under SOAP Web Service . In the following there are some examples of a web service client calls in the programming language C#.
Authentication is carried out though an authentication string which contains an authentication module and the login data to use. You must create an instance of the web service and the object for the login data to log in to the system. The login data is passed to following calls.
Example:
var svc = new Q1IMServiceSoapClient();
var login = new LoginInformation
{ AuthString = "Module=DialogUser;User=viadmin;Password=" };
| Authentication Module | Example |
|---|---|
| System user | Module=DialogUser;User=<user name>;Password=<password> |
| Employee | Module=Person;User=<central user account>;Password=<password> |
| Active Directory user account (role based) | Module=RoleBasedADSAccount |
| Active Directory user account (manual input/role based) | Module=RoleBasedManualADS;User=<AD user name>;Password=<AD password> |
You can find an overview of the authentication module under One Identity Manager Authentication Module.
This method returns an array of objects, which correspond to the given WHERE clause. The returned array contains the object's primary key and a special key, [DISPLAY], which contains the object's display value.
Example:
Q1IMService.KeyValuePair[][] objects = svc.GetListObject(login, "Person",
"FirstName like 'Hal%'");
This method works in the same way as GetListObject and allows you to enter details of additional columns to be loaded.
Example:
In the example, the columns FirstName and LastName are available.
Q1IMService.KeyValuePair[][] objects = svc.GetListObjectWithDisplays(login, "Person",
"FirstName like 'Hal%'",
new [] {"FirstName", "LastName"});
All the properties of the object, defined through the primary key, are loaded by the method.
Example:
Q1IMService.KeyValuePair[] singleValues = svc.GetCompleteSingleObject(login,
"Person", "UID_Person", "746a5662-054b-4531-a889-1c135dad4c05");
Properties of a single object are loaded with this method.
Example:
In the example, the columns FirstName and LastName and the display value are loaded. The display value is given in the key [DISPLAY].
Q1IMService.KeyValuePair[] values = svc.GetSingleObject(login, "Person",
"UID_Person", "746a5662-054b-4531-a889-1c135dad4c05",
new[] { "FirstName", "LastName" });
This method changes individual properties of an object.
Example:
In the example, the column Description of the employee with the corresponding UID_Person is modified.
var values = new[]
{
new Q1IMService.KeyValuePair
{
Key = "Description",
Value = "Created by webservice"
}
};
svc.ChangeSingleObject(login, "Person", "UID_Person",
"746a5662-054b-4531-a889-1c135dad4c05", values);
Modifying an object with this method is done in the same way as with ChangeSingleObject, but here the primary key value is passed as a Key-Value-Pair-Array.
Example:
var values = new[]
{
new Q1IMService.KeyValuePair
{
Key = "Description",
Value = "Created by webservice"
}
};
var keys = new[]
{
new Q1IMService.KeyValuePair
{
Key = "UID_Person",
Value = "746a5662-054b-4531-a889-1c135dad4c05"
}
};
svc.ChangeSingleObjectEx(login, "Person", keys, values);
This method deletes an object.
Example:
In this example, the employee with the corresponding UID is deleted from the database.
svc.DeleteSingleObject(login, "Person",
"UID_Person", "746a5662-054b-4531-a889-1c135dad4c05");
It is possible to delete objects with multicolumn primary key (as from M:N tables) with this method.
Example:
svc.DeleteSingleObjectEx (
login,
"OrgHasApp",
new []
{
new Q1IMService.KeyValuePair { Key = "UID_Org", Value = <UID> },
new Q1IMService.KeyValuePair { Key = "UID_Application", Value = <UID>}
});
A new object is created in the database with this object.
Example:
In this example, the employee "Jon Doe" is created.
var values = new[]
{
new Q1IMService.KeyValuePair {Key = "FirstName", Value = "John"},
new Q1IMService.KeyValuePair {Key = "LastName", Value = "Doe"}
};
svc.CreateSingleObject(login, "Person", values);
This method checks the existence of an object.
Example:
bool exists = svc.Exists(login, "Person",
"UID_Person", "746a5662-054b-4531-a889-1c135dad4c05");
This method can be implemented to find a single property.
Example:
string description = svc.GetSingleProperty(login, "Person",
"UID_Person", "746a5662-054b-4531-a889-1c135dad4c05",
"Description");
The SOAP Web Service support a method "InvokeCustomizer", which calls a function for an object in the database. The first three parameters specify the object on which the method is called. The parameter customizerName provides the function name. An array of strings follows which contains the fully qualified name of the parameter data types. These are passed to the calling function. The following array of strings contains textual representation of the parameter.
How the function works
If the calling function does not have any parameter, the function for the parameter "parameterTypes" and "parameter" "null" can be passed.
Example:
In this example, the method "TestMethod" is called for a Person type object with the primary key UID_Person and the given value. In this case, both parameters of type "System.String" and "System.Int32" with the values "Foo" and "4711" are passed.
svc.InvokeCustomizer (login, "Person",
"UID_Person", "0000644F-C139-4B25-8D1C-5ECB93067E79",
"TestMethod",
new [] {"System.String", "System. Int32"},
new [] {"foo", "4711"});
The method can call a dialog method on an object. Dialog methods do not have any parameters and no return values. The call is similar to the InvokeCustomizer call.
Example:
In this example, the method "TestDialogMethod" is called for a specific person. "TestDialogMethod" is the name of the method corresponding to DialogMethod.MethodName.
svc.InvokeDialogMethod (login,
"Person",
"UID_Person", "746a5662-054b-4531-a889-1c135dad4c05",
"TestDialogMethod");
A specific event is generated by this method. There is the option to enter other generating parameters.
public void FireGenEvent(
string objectType, string pkName, string pkValue,
strincolumng eventName, KeyValuePair[] parameters);
Example:
In this example, the event "EXPORT_DATA" is generated without additional parameters.
svc.FireGenEvent(login, "Person",
"UID_Person", "746a5662-054b-4531-a889-1c135dad4c05",
"EXPORT_DATA", new Q1IMService.KeyValuePair[] { });
This method calls a One Identity Manager script function.
Example:
In the example, the script VI_BuildInitials is called.
svc.CallFunction(login, "VI_BuildInitials",
new string [] {"John", "Doe"});
The One Identity Manager enables data exchange with other vendor’s systems using SMPL. SMPL stands for Service Provisioning Markup Language and defines a standardized interface for exchanging provisioning information. SPML version 2 (SPMLv2) was published in April 2006 by the Organization for the Advancement of Structured Information Standards (OASIS, www.oasis-open.org). The interface provides a means to simplify and standardize data exchange in the context of complex provisioning solutions and environments.
The One Identity Manager can be implemented as SPML client or as SPML provider. At this point we shall only go into the One Identity Manager configuration as SPML provider. The SPML Provider supports the entire One Identity Manager schema. The objects and relations to be administrated through the SPML provider can be configured to meet customer requirements.
A web service called the SPML Web Service, is provided for the function of SMPL service provider. SPML Web Service conforms to SPMLv2 and its implementation is based on the OASIS publication. It makes the main operations such as adding, deleting and changing objects available as well as extensions for searching and referencing objects.
SPML Web Service supports the SPMLv2 functions defined in the following:
| Function | Description |
|---|---|
| listTargetsRequest | Returns the provider target system with its specific schema. The SPML provider supports the One Identity Manager schema exclusively. |
| addRequest | Adds a new object in the given provider target system with the given properties. |
| lookupRequest | Returns the properties of a object identified by a key. |
| modifyRequest | Changes the properties of a key identified object in the given provider target system. |
| deleteRequest | Deletes a key identified object in the provider target system. |
| searchRequest | Returns all objects in the provider target system that fulfill the search criterion. |
| iterateRequest | Returns other data sets from a search assuming not all of search results have been sent to the client. |
| closeIteratorRequest | Closes an active search and informs the provider that no further results are required. |
The extension "reference" makes it possible to maintain references between different provider target system objects. There are two different types of references for this.
References of type "owner" results in One Identity Manager in foreign key relations.
Reference of type "memberOf" result in One Identity Manager many-to-many assignments.
© 2023 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy
