Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="ETSI SDG TFS Documentation page">
<meta name="author" content="TeraflowSDN by ETSI">
<link rel="canonical" href="https://tfs.etsi.org/develop/testing/testplan/common_operations/">
<link rel="icon" href="../../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
<title>Common Operations - ETSI SDG TFS Documentation</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.35f28582.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../../stylesheets/extra.css">
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#common-operations" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="ETSI SDG TFS Documentation" class="md-header__button md-logo" aria-label="ETSI SDG TFS Documentation" data-md-component="logo">
<img src="../../../images/logos/TeraFlowSDN_tr.png" alt="logo">
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
ETSI SDG TFS Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Common Operations
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://labs.etsi.org/rep/tfs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81s-5.7.083-8.4 1.11c-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.1 18.1 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3s9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82"/></svg>
</div>
<div class="md-source__repository">
TFS GitLab
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../.." title="ETSI SDG TFS Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG TFS Documentation" data-md-component="logo">
<img src="../../../images/logos/TeraFlowSDN_tr.png" alt="logo">
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
</a>
ETSI SDG TFS Documentation
</label>
<div class="md-nav__source">
<a href="https://labs.etsi.org/rep/tfs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81s-5.7.083-8.4 1.11c-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.1 18.1 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3s9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82"/></svg>
</div>
<div class="md-source__repository">
TFS GitLab
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
1. Deployment Guide
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
1. Deployment Guide
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_1" >
<label class="md-nav__link" for="__nav_1_1" id="__nav_1_1_label" tabindex="0">
<span class="md-ellipsis">
1.1. Configure your Machine
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1_1">
<span class="md-nav__icon md-icon"></span>
1.1. Configure your Machine
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../deployment_guide/configure_your_machine/physical_server/" class="md-nav__link">
<span class="md-ellipsis">
1.1.1. Physical Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/configure_your_machine/oracle_virtual_box/" class="md-nav__link">
<span class="md-ellipsis">
1.1.2. Oracle Virtual Box
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/configure_your_machine/vm_ware_fusion/" class="md-nav__link">
<span class="md-ellipsis">
1.1.3. VMWare Fusion
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/configure_your_machine/openstack/" class="md-nav__link">
<span class="md-ellipsis">
1.1.4. OpenStack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/configure_your_machine/vagrant_box/" class="md-nav__link">
<span class="md-ellipsis">
1.1.5. Vagrant Box
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/install_micro_k8s/install_micro_k8s/" class="md-nav__link">
<span class="md-ellipsis">
1.2. Install MicroK8s
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/deploy_TeraFlowSDN/deploy_TeraFlowSDN/" class="md-nav__link">
<span class="md-ellipsis">
1.3. Deploy TeraFlowSDN
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/webUI_and_grafana_dashboards/webUI_and_grafana_dashboards/" class="md-nav__link">
<span class="md-ellipsis">
1.4. WebUI and Grafana Dashboards
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../deployment_guide/show_deployment_and_logs/show_deployment_and_logs/" class="md-nav__link">
<span class="md-ellipsis">
1.5. Show deployments and Logs
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
2. Development Guide
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
2. Development Guide
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1" >
<label class="md-nav__link" for="__nav_2_1" id="__nav_2_1_label" tabindex="0">
<span class="md-ellipsis">
2.1 Configure Environment
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_1">
<span class="md-nav__icon md-icon"></span>
2.1 Configure Environment
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../development_guide/configure_environment/python/" class="md-nav__link">
<span class="md-ellipsis">
2.1.1. Python
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../development_guide/configure_environment/java_quarkus/" class="md-nav__link">
<span class="md-ellipsis">
2.1.2. Java (Quarkus)
</span>
</a>
</li>
</ul>
</nav>
</li>
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Testing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Testing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Test Plan
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../robotframework/" class="md-nav__link">
<span class="md-ellipsis">
Robot Framework
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../postman/" class="md-nav__link">
<span class="md-ellipsis">
Postman
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../FAQ/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#register-new-user" class="md-nav__link">
<span class="md-ellipsis">
Register new user
</span>
</a>
<nav class="md-nav" aria-label="Register new user">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#admin-create-user" class="md-nav__link">
<span class="md-ellipsis">
Admin create User
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#user-retrieve-access-token-and-other-information" class="md-nav__link">
<span class="md-ellipsis">
User Retrieve access token and other information
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#onboard-an-invoker" class="md-nav__link">
<span class="md-ellipsis">
Onboard an Invoker
</span>
</a>
<nav class="md-nav" aria-label="Onboard an Invoker">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#steps-to-perform-operation" class="md-nav__link">
<span class="md-ellipsis">
Steps to perform operation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#checks-to-ensure-onboarding" class="md-nav__link">
<span class="md-ellipsis">
Checks to ensure onboarding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-flow" class="md-nav__link">
<span class="md-ellipsis">
Example Flow
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#register-a-provider" class="md-nav__link">
<span class="md-ellipsis">
Register a Provider
</span>
</a>
<nav class="md-nav" aria-label="Register a Provider">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#steps-to-perform-operation_1" class="md-nav__link">
<span class="md-ellipsis">
Steps to Perform operation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#checks-to-ensure-provider-registration" class="md-nav__link">
<span class="md-ellipsis">
Checks to ensure provider registration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-flow_1" class="md-nav__link">
<span class="md-ellipsis">
Example Flow
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="common-operations">Common Operations</h1>
<h2 id="register-new-user">Register new user</h2>
<p>In order to use OpenCAPIF we must add a new user. This new user can onboard/register any Invokers or Providers.</p>
<p>That new user <strong>must be created by administrator</strong> of Register Service and with the credentials shared by administrator, the new user can get the <strong>access_token</strong> by requesting it to Register service.</p>
<p>The steps to register a new user at Register Service are:</p>
<h3 id="admin-create-user">Admin create User</h3>
<p>1) <strong>Login as Admin to get access_token:</strong></p>
<ul>
<li>Send <strong>POST</strong> to <strong>https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/login</strong><ul>
<li><strong>Include basic Auth Header with Admin credentials</strong></li>
</ul>
</li>
<li>Get <strong>access_token</strong> and <strong>refresh_token</strong> from response</li>
</ul>
<p><img alt="Flow" src="../../../images/flows/01_Login_Admin.png" /></p>
<p>2) <strong>Create User:</strong></p>
<ul>
<li>Send <strong>POST</strong> to <strong>https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/createUser</strong><ul>
<li>Include Admin <strong>access_token</strong> in <strong>Authorization Bearer Header</strong></li>
<li>Body <a href="user_registration_body.json" title="User Registration Body">user_registration_body</a></li>
</ul>
</li>
</ul>
<p><img alt="Flow" src="../../../images/flows/02_Creation_of_user.png" /></p>
<h3 id="user-retrieve-access-token-and-other-information">User Retrieve access token and other information</h3>
<p>1) <strong>Retrieve access_token by User:</strong></p>
<ul>
<li>Send <strong>GET</strong> to <strong>https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth</strong><ul>
<li>Include <strong>basic Auth Header with User credentials</strong></li>
</ul>
</li>
<li>Retrieve <strong>access_token</strong> and the urls needed for next requests from response body <a href="user_getauth_response_body_example.json" title="User GetAuth response Body Example">user_getauth_response_body_example</a></li>
</ul>
<p><img alt="Flow" src="../../../images/flows/03_Register_of_AEF_GetAuth.png" /></p>
<h2 id="onboard-an-invoker">Onboard an Invoker</h2>
<h3 id="steps-to-perform-operation">Steps to perform operation</h3>
<p><strong><em>Preconditions: The administrator must have previously registered the User.</em></strong></p>
<ol>
<li>Create public and private key at invoker</li>
<li>
<p>Retrieve access_token by User:</p>
<ul>
<li>Send <strong>GET</strong> to <strong>https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth</strong></li>
<li>Include basic Auth Header with Admin user/password</li>
<li>Retrieve <strong>access_token</strong> and the urls needed for next requests from response body <a href="user_getauth_response_body_example.json" title="User GetAuth response Body Example">user_getauth_response_body_example</a></li>
</ul>
</li>
<li>
<p>Onboard Invoker: </p>
<ul>
<li>Send <strong>POST</strong> to <strong>https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers</strong></li>
<li>Reference Request Body: <a href="../api_invoker_management/invoker_details_post_example.json" title="API Invoker Request">invoker onboarding body</a></li>
<li>"onboardingInformation"->"apiInvokerPublicKey": must contain public key generated by Invoker.</li>
<li>Send in Authorization Header the Bearer access_token obtained previously (Authorization:Bearer ${access_token})</li>
</ul>
</li>
</ol>
<h3 id="checks-to-ensure-onboarding">Checks to ensure onboarding</h3>
<ol>
<li>
<p>Response to Get Auth:</p>
<ol>
<li><strong>200 OK</strong></li>
<li><strong><em>access_token</em></strong> returned.</li>
</ol>
</li>
<li>
<p>Response to Onboard request must accomplish:</p>
<ol>
<li><strong>201 Created</strong></li>
<li>Response Body must follow <strong>APIInvokerEnrolmentDetails</strong> data structure with:<ul>
<li>apiInvokerId</li>
<li>onboardingInformation->apiInvokerCertificate must contain the public key signed.</li>
</ul>
</li>
<li>Response Header <strong>Location</strong> must be received with URI to new resource created, following this structure: <strong>{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}</strong></li>
</ol>
</li>
</ol>
<h3 id="example-flow">Example Flow</h3>
<p><img alt="Flow" src="../../../images/flows/07_Invoker_Onboarding.png" /></p>
<h2 id="register-a-provider">Register a Provider</h2>
<h3 id="steps-to-perform-operation_1">Steps to Perform operation</h3>
<ol>
<li>Create public and private key at provider for provider itself and each function (apf, aef and amf)</li>
<li>
<p>Retrieve access_token by User:</p>
<ul>
<li>Send <strong>GET</strong> to <strong>https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth</strong></li>
<li>Include basic Auth Header with Admin user/password</li>
<li>Retrieve <strong>access_token</strong> and the urls needed for next requests from response body <a href="user_getauth_response_body_example.json" title="User GetAuth response Body Example">user_getauth_response_body_example</a></li>
</ul>