Skip to Content

Changes for page ClientID OAuth - Check

Last modified by Erik Bakker on 2024/06/03 12:37
From version 9.1
edited by Erik Bakker
on 2022/05/02 09:34
Change comment: There is no comment for this version
To version 21.1
edited by Erik Bakker
on 2024/06/03 12:36
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -eMagiz Data Sink
1 +ClientID OAuth - Check
Content
... ... @@ -2,31 +2,27 @@
2 2  {{container layoutStyle="columns"}}
3 3  (((
4 4  == About ==
5 -With the help of this functionality, you can sink your messages into the eMagiz data sink bucket. Once the message is stored in the eMagiz data sink bucket, you will have the option to view this message in the Manage phase.
5 +With the help of this store component, you can validate if the clientID provided by one single entity conformed to what you would have expected. In case that is not true, eMagiz will return a 403 Forbidden to the client. In case this is true, a header with the name "client" is added to the flow which can be used further downstream to determine what to do with the message.
6 6  
7 7  == Documentation ==
8 8  
9 9  ==== 1. How to use====
10 -Once stored, eMagiz can retrieve all messages with the same ID attached during the sink action via the Manage phase. In this case, it is assumed that your eMagiz data sink is such that you can review them on the fly. Other eMagiz data sink variants are offered that required specific on-demand queries.
10 +With the help of this store component, you can validate if the clientID provided by one single entity conformed to what you would have expected. In case that is not true, eMagiz will return a 403 Forbidden to the client. In case this is true, a header with the name "client" is added to the flow which can be used further downstream to determine what to do with the message.
11 11  
12 12  ==== 2. Keynotes & restrictions====
13 13  
14 -* Note that you should think about when you want to archive your data to the eMagiz data sink. That choice determines what the impact on the functional flow is.
15 -* Don't use a wiretap to invoke this part of the flow, as that causes the sink's behavior to happen before the actual processing. If the sink fails, the message will not be delivered via the functional part of the flow.
16 -* Note that we define (among others) how the message is stored in the data sink bucket in this component. The file structure expression should not be altered, as changing this would break the functionality.
17 -* Note that the 'standard' eMagiz headers to define the source system (i.e. relevant systems) and the messageType need to be available upon sinking to make this functionality work.
14 +* Note that this functionality relies on the proper configuration of the client list and the clientID list. If they are not updated properly, the client calling the API can experience weird behavior.
15 +* This item is specifically designed for a very particular use case-determining which API client can execute which action further downstream. It's not a general-purpose tool and should not be used as an alternative to other methods (i.e., identifier in the body, identifier in a separate header).
18 18  
19 19  ==== 3. License Information====
20 -To use this store item you need to secure an additional license on the eMagiz platform. If you are interested in such a license please contact us at productmanagement@emagiz.com.
18 +Part of the standard license agreement as agreed upon when using the store for the first time.
21 21  
22 -Would you please consult the privacy policy of eMagiz at the following link: [[https:~~/~~/www.emagiz.com/privacy-policy/?>>url:https://www.emagiz.com/privacy-policy/?]])))
20 +==== 4. Relevant eMagiz Academy Microlearnings====
23 23  
22 +None
24 24  
24 +//Would you please consult the privacy policy of eMagiz at the following [[link>>https://www.emagiz.com/privacy-policy/||target="blank"]])))
25 25  
26 -((((% border="2" cellpadding="10" cellspacing="10" style="width:292px" %)
27 -|=(% style="width: 45px;" %)#|=(% style="width: 241px;" %)Option
28 -|(% style="width:45px" %) a|(% style="width:241px" %) XML message(s)
29 -|(% style="width:45px" %) b|(% style="width:241px" %) JSON Message(s)
30 -)))
26 +((()))
31 31  {{/container}}
32 32  {{/container}}