Jump to: navigation, search

Difference between revisions of "Authenticate (Activity)"

(→‎Arguments)
(→‎Example)
 
(29 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
This activity pushes a single content object to {{UBIK}} Push service participants.
+
This activity verifies login information and retrieves an Authentication Object using the UBIK USAM Service.
  
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
Line 5: Line 5:
 
= Description =
 
= Description =
 
{{ActivityInfoBox
 
{{ActivityInfoBox
−
| title = PushContent
+
| title = Authenticate
−
| name = PushContent
+
| name = Authenticate
 
| image =  
 
| image =  
−
| imagecaption = Activity PushContent
+
| imagecaption = Activity Authenticate
−
| purpose = Push a single object
+
| purpose = Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
−
| category = UBIK Push
+
| category = UBIK Web
 
| returns = true if successful
 
| returns = true if successful
−
| version = 2.4.2+
+
| version = 3.5.0+
 
}}
 
}}
  
Line 20: Line 20:
 
! Argument !! Type !! Direction !! Purpose  
 
! Argument !! Type !! Direction !! Purpose  
 
|- align="left"
 
|- align="left"
−
| Application || {{String}} || In ||  
+
| Application || {{String}} || In || An Application is used to identify Contexts, the Application name have to be configured in the client's settings
 
|- align="left"
 
|- align="left"
−
| AuthenticationResult || {{AuthenticationResult}} || Out || A valid Authentication Token. Use (e.g.) Authenticate - Activity to create a Token. If this parameter is empty, the system generates a temporary debug token. But be aware, that these kind of tokens are only supported as long as the USAM Service is in debug mode.
+
| AuthenticationResult || {{AuthenticationResult}} || Out || A valid Authentication Token, be aware, that these kind of tokens are only supported for short period of Time.
 
|- align="left"
 
|- align="left"
−
| Context || {{String}} || In ||  
+
| 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
 
|- align="left"
 
|- align="left"
−
| DisplayName || {{String}} || In || Name of the File
+
| DisplayName || {{String}} || || Name of the File
 
|- align="left"
 
|- align="left"
−
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Sea level)
+
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
 
|- 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.
+
| Login || {{String}} || In || The Login Object holds the necessary information for managing logins to UBIK®,  each Login name must be unique
 
|- align="left"
 
|- align="left"
−
| Manufacturer || {{String}} || In || Computer Manufacturer
+
| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
 
|- align="left"
 
|- align="left"
−
| Model || {{String}} || In || Computer model
+
| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
 
|- 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.
+
| OperatingSystem || {{OSTypes}} || In || An operating system (OS) is system software that manages computer hardware, software resources, and provides common services for computer programs
 
|- align="left"
 
|- align="left"
−
| Password || {{String}} || In || A password, sometimes called a passcode, is a memorized secret, string of characters including letters, digits, or other symbols, used to confirm the identity of a user
+
| Password || {{String}} || In || Configures the options for a username/password style authentication
 
|- align="left"
 
|- align="left"
−
| Result || {{Boolean}} || Out ||  
+
| Result || {{Boolean}} || Out || True or False
 
|- align="left"
 
|- align="left"
−
| Satellite || {{String}} || In ||  
+
| Satellite || {{String}} || In || Configuration of allowed devices to connect to the system
 
|- align="left"
 
|- align="left"
−
| ServiceVersion || {{String}} || In ||  
+
| ServiceVersion || {{String}} || In || Current client version
 
|- align="left"
 
|- align="left"
 
| USAMUrl || {{String}} || In || Combination of Authentication Server and Authentication Service Path
 
| USAMUrl || {{String}} || In || Combination of Authentication Server and Authentication Service Path
Line 52: Line 52:
  
 
===Usage===
 
===Usage===
−
Use this activity to push a single object to certain {{UBIK}} Clients. The criterions to which clients the object should be actually pushed can be defined with subsequent PushCriterion activities.  
+
Use this activity to verify the login information and retrieve an Authentication Object using the UBIK USAM Service.
−
It is a nestable activity, which means it can host any amount of sub-activities that will be processed sequentially. The hosted activities are typically Push criterions like PushCriterionLogin, either as direct children but also wrapped within looping activities like ForEach or While.
+
 
  
 
=Example=
 
=Example=
−
This example pushes the object with the defined UID to all clients of its hosting [[Activity:CreatePushScope (Activity)|CreatePushScope]] activity as defined in its subsequent criterions; if no criterions are defined the push will be received by all clients of the push service.
+
Exemplary values to get Token.
  
 
{| class="wikitable" | width = "50%"
 
{| class="wikitable" | width = "50%"
Line 62: Line 62:
 
! Argument!! Value
 
! Argument!! Value
 
|- align="left"
 
|- align="left"
−
| UBIKObjectUID|| new System.Guid("f5eea25c-9ad4-4be4-b11a-5814a4160c3e")
+
| 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 || "User"
 +
|- align="left"
 +
| Manufacturer || "my PC"
 +
|- align="left"
 +
| Model || "......."
 +
|- align="left"
 +
| OperatingSystem || "UBIK.Service.DTO.V220.OSTypes.X_IOS"
 +
|- align="left"
 +
| Password || ""
 +
|- align="left"
 +
| Result || ""
 +
|- align="left"
 +
| Satellite || "myDevice"
 +
|- align="left"
 +
| ServiceVersion || "350"
 +
|- align="left"
 +
| USAMUrl || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/USAM/USAM.svc"
 
|}
 
|}
  
Line 69: Line 95:
 
==See also==
 
==See also==
 
* [[Workflow Designer]]
 
* [[Workflow Designer]]
−
* [[Activity:CreatePushScope (Activity)]]
 

Latest revision as of 11:47, 22 April 2020

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


[edit]

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.0+

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 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.


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 "User"
Manufacturer "my PC"
Model "......."
OperatingSystem "UBIK.Service.DTO.V220.OSTypes.X_IOS"
Password ""
Result ""
Satellite "myDevice"
ServiceVersion "350"
USAMUrl "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/USAM/USAM.svc"


See also

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