Jump to: navigation, search

Changes


RESTPost (Activity)

6,942 bytes added, 10:09, 26 March 2020
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..."
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 -->

= Description =
{{ActivityInfoBox
| title = Authenticate
| name = Authenticate
| image =
| imagecaption = Activity 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===
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| Application || {{String}} || In || An Application is used to identify Contexts, the Application name have to be configured in the client's settings
|- align="left"
| AuthenticationResult || {{AuthenticationResult}} || Out || A valid Authentication Token, be aware, that these kind of tokens are only supported for short period of Time.
|- 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
|- align="left"
| DisplayName || {{String}} || In || Name of the File
|- align="left"
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
|- align="left"
| Login || {{String}} || In || The Login Object holds the necessary information for managing logins to UBIKĀ®, each Login name must be unique
|- align="left"
| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
|- align="left"
| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
|- 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
|- align="left"
| Password || {{String}} || In || Configures the options for a username/password style authentication
|- align="left"
| 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"
|}


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

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

==See also==
* [[Workflow Designer]]
* [[Activity:CreatePushScope (Activity)]]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 -->

= Description =
{{ActivityInfoBox
| title = Authenticate
| name = Authenticate
| image =
| imagecaption = Activity 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===
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| Application || {{String}} || In || An Application is used to identify Contexts, the Application name have to be configured in the client's settings
|- align="left"
| AuthenticationResult || {{AuthenticationResult}} || Out || A valid Authentication Token, be aware, that these kind of tokens are only supported for short period of Time.
|- 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
|- align="left"
| DisplayName || {{String}} || In || Name of the File
|- align="left"
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
|- align="left"
| Login || {{String}} || In || The Login Object holds the necessary information for managing logins to UBIKĀ®, each Login name must be unique
|- align="left"
| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
|- align="left"
| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
|- 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
|- align="left"
| Password || {{String}} || In || Configures the options for a username/password style authentication
|- align="left"
| 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"
|}


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

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

==See also==
* [[Workflow Designer]]
* [[Activity:CreatePushScope (Activity)]]
415
edits