Jump to: navigation, search

Difference between revisions of "RESTPost (Activity)"

(Created page with "This activity verifies login information and retrieves an Authentication Object using the UBIK USAM Service. <!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT...")
 
Line 5: Line 5:
 
= Description =
 
= Description =
 
{{ActivityInfoBox
 
{{ActivityInfoBox
−
| title = Authenticate
+
| title = RESTPost
−
| name = Authenticate
+
| name = RESTPost
 
| image =  
 
| image =  
−
| imagecaption = Activity Authenticate
+
| imagecaption = Activity RESTPost
 
| purpose = Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
 
| purpose = Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
 
| category = UBIK Web
 
| category = UBIK Web
Line 20: Line 20:
 
! Argument !! Type !! Direction !! Purpose  
 
! Argument !! Type !! Direction !! Purpose  
 
|- align="left"
 
|- align="left"
−
| Application || {{String}} || In || An Application is used to identify Contexts, the Application name have to be configured in the client's settings
+
| Body || {{String}} || In ||  
 
|- align="left"
 
|- align="left"
−
| AuthenticationResult || {{AuthenticationResult}} || Out || A valid Authentication Token, be aware, that these kind of tokens are only supported for short period of Time.
+
| DisplayName || {{String}} || ||  
 
|- align="left"
 
|- align="left"
−
| Context || {{String}} || In || A Context is used to identify a View and all relevant Scopes, the Context name have to be configured in the client's settings
+
| Error || {{String}} || Out ||  
 
|- align="left"
 
|- align="left"
−
| DisplayName || {{String}} || In || Name of the File
+
| DisplayName || {{String}} || In ||  
 
|- align="left"
 
|- align="left"
−
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
+
| Headers || {{String}} || In ||  
 
|- align="left"
 
|- align="left"
−
| Login || {{String}} || In || The Login Object holds the necessary information for managing logins to UBIK®,  each Login name must be unique
+
| MethodName || {{String}} || In ||  
 
|- align="left"
 
|- align="left"
−
| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
+
| Parameter || {{String}} || In ||  
 
|- align="left"
 
|- align="left"
−
| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
+
| Response || {{String}} || Out ||  
 
|- align="left"
 
|- align="left"
−
| OperatingSystem || {{OSTypes}} || In || An operating system (OS) is system software that manages computer hardware, software resources, and provides common services for computer programs
+
| Result || {{String}} || Out ||  
 
|- align="left"
 
|- align="left"
−
| Password || {{String}} || In || Configures the options for a username/password style authentication
+
| Url || {{String}} || In ||  
 
|- align="left"
 
|- align="left"
 
| Result || {{Boolean}} || Out || True or False
 
| Result || {{Boolean}} || Out || True or False
−
|- align="left"
 
−
| Satellite || {{String}} || In || Configuration of allowed devices to connect to the system
 
−
|- align="left"
 
−
| ServiceVersion || {{String}} || In || Current client version
 
−
|- align="left"
 
−
| USAMUrl || {{String}} || In || Combination of Authentication Server and Authentication Service Path
 
 
|- align="left"
 
|- align="left"
 
|}
 
|}
Line 151: Line 145:
  
  
−
=Example=
 
−
Exemplary values to get Token.
 
  
−
{| class="wikitable" | width = "50%"
 
−
|-
 
−
! Argument!! Value
 
−
|- align="left"
 
−
| Application || "APP_MT"
 
−
|- align="left"
 
−
| AuthenticationResult || "token"
 
−
|- align="left"
 
−
| Context || "CMT_MT"
 
−
|- align="left"
 
−
| DispalyName || "Authenticate"
 
−
|- align="left"
 
−
| Geo || "New UBIK.Kernel.GeoInformation(18, 42, 333)"
 
−
|- align="left"
 
−
| Login || "MHM"
 
−
|- align="left"
 
−
| Manufacturer || "mein HP"
 
−
|- align="left"
 
−
| Model || "Probook...."
 
−
|- align="left"
 
−
| OperatingSystem || "UBIK.Service.DTO.V220.OSTypes.X_IOS"
 
−
|- align="left"
 
−
| Password || ""
 
−
|- align="left"
 
−
| Result || ""
 
−
|- align="left"
 
−
| Satellite || "myDevice"
 
−
|- align="left"
 
−
| ServiceVersion || "264"
 
−
|- align="left"
 
−
| USAMUrl || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/USAM/USAM.svc"
 
−
|}
 
  
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->

Revision as of 10:15, 26 March 2020

This activity verifies login information and retrieves an Authentication Object using the UBIK USAM Service.


[edit]

Description

RESTPost
Name RESTPost
Purpose Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
Category UBIK Web
Returns true if successful
Version 3.5

Arguments

Argument Type Direction Purpose
Body String In
DisplayName String
Error String Out
DisplayName String In
Headers String In
MethodName String In
Parameter String In
Response String Out
Result String Out
Url String In
Result Boolean Out True or False


Usage

Use this activity to verify the login information and retrieve an Authentication Object using the UBIK USAM Service.


Example

Exemplary values to get Token.

Argument Value
Application "APP_MT"
AuthenticationResult "token"
Context "CMT_MT"
DispalyName "Authenticate"
Geo "New UBIK.Kernel.GeoInformation(18, 42, 333)"
Login "MHM"
Manufacturer "mein HP"
Model "Probook...."
OperatingSystem "UBIK.Service.DTO.V220.OSTypes.X_IOS"
Password ""
Result ""
Satellite "myDevice"
ServiceVersion "264"
USAMUrl "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/USAM/USAM.svc"


See also


Description

Authenticate
Name Authenticate
Purpose Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
Category UBIK Web
Returns true if successful
Version 3.5

Arguments

Argument Type Direction Purpose
Application String In An Application is used to identify Contexts, the Application name have to be configured in the client's settings
AuthenticationResult AuthenticationResult Out A valid Authentication Token, be aware, that these kind of tokens are only supported for short period of Time.
Context String In A Context is used to identify a View and all relevant Scopes, the Context name have to be configured in the client's settings
DisplayName String In Name of the File
Geo GeoInformation In Location (Latitude, Longitude, Altitude)
Login String In The Login Object holds the necessary information for managing logins to UBIK®, each Login name must be unique
Manufacturer String In Computer Manufacturer, e.g., HP, DELL and and so forth
Model String In Computer model, e.g., Pavilion, Inspiron and and so forth
OperatingSystem OSTypes In An operating system (OS) is system software that manages computer hardware, software resources, and provides common services for computer programs
Password String In Configures the options for a username/password style authentication
Result Boolean Out True or False
Satellite String In Configuration of allowed devices to connect to the system
ServiceVersion String In Current client version
USAMUrl String In Combination of Authentication Server and Authentication Service Path


Usage

Use this activity to verify the login information and retrieve an Authentication Object using the UBIK USAM Service.



See also

Retrieved from "https://wiki.augmensys.com/index.php?title=RESTPost_(Activity)&oldid=22201"