Wiki-Quellcode von OAuth 2


Zeige letzte Bearbeiter
1 {{content/}}
2
3 Auf der Oberfläche zur Konfiguration eines dem //OAuth 2//-Standard folgenden Identity Providers werden die folgenden Parameter abgefragt:
4
5 == Grundeinstellungen ==
6
7 {{figure image="oauth_base_settings_en.png" clear="h1"}}
8 Grundeinstellungen für die Konfiguration eines neuen OAuth 2 Identity Providers.
9 {{/figure}}
10
11 === Name ===
12
13 Bezeichnung des Identity Providers in {{formcycle/}}.
14
15 === Abweichender Name auf dem Login-Button des Formulars ===
16
17 Wenn ein Formular so konfiguriert wurde, dass mehrere Authenthentifizierungsmöglichkeiten zur Auswahl stehen, wird beim Öffnen des Formulars ein Dialog angezeigt in dem man eine Authentifizierungsart wählen muss. Hier kann festgelegt werden, welcher Textinhalt auf dem Button für diesen Identity Provider stehen soll.
18
19 Wird an dieser Stelle nichts eingetragen, wird die unter //Name// eingetragene Bezeichung verwendet.
20
21 === Alias für Callback-URL (UUID) ===
22
23 Eindeutiger Identifikator, welcher der Identity Provider beim Rücksprung zu {{formcycle/}} verwendet. Dieser Wert wird automatisch generiert, kann bei Bedarf jedoch geändert werden.
24
25 === Callback-URL ===
26
27 Die beim Rücksprung vom Identity Provider zu FORMYCYLE verwendete URL wird hier angezeigt und kann über das Kopieren-Symbol rechts neben der URL in die Zwischenablage kopiert werden. Falls Frontend-Server vorhanden sind, wird auch für diese die entsprechende URL angezeigt.
28
29
30 == Initial sichtbare Schaltflächen ==
31
32 Unter den Grundeinstellungen befinden sich zunächst 3 Schaltflächen, deren Funktionen bei der Konfiguration des Identity Providers helfen sollen.
33
34 === E-Mail an Provider senden ===
35
36 Öffnet das im System eingerichtete E-Mail-Programm mit einer vorformulierten Anfrage bezüglich der für die Konfiguration des Identity Providers im {{formcycle/}} benötigten Informationen.
37
38 === Hilfe ===
39
40 Öffnet diese Hilfeseite im Browser.
41
42 === Konfiguration hinzufügen ===
43
44 Nachdem die benötigten Informationen vom Identitiy Provider bereitgestellt wurden, kann durch einen Klick auf diesen Button der Bereich für die Konfiguration des Identity Providers geöffnet werden. Es öffnet sich der im folgenden beschriebene Bereich //Konfiguration//.
45
46 == Configuration ==
47
48 {{figure image="oauth_configuration_en.png" clear="h1"}}
49 Configuration options for an OAuth 2 identity provider.
50 {{/figure}}
51
52 === Key ===
53
54 Eindeutige Kennung der Konfiguration die Sie von Ihrem Identity Provider erhalten.
55
56 === Secret ===
57
58 Geheimer Schlüssel, welcher zur Authentifizierung Ihres Clients benutzt wird.
59
60 === Scope ===
61
62 Gibt den Zugriffsbereich an, welche FORMCYCLE beim Abfragen von Profil-Informationen beim Identity Provider benutzt.
63
64 === URL für Autorisierungsanfrage ===
65
66 Definiert den URL, welcher für eine Autorisierungsanfrage beim Identitiy Provider benutzt wird.
67
68 === URL für Zugriffstoken Anforderung ===
69
70 Definiert den URL, welcher für die Anforderung des Zugriffstoken vom Identitiy Provider benutzt wird.
71
72 === URL zur Ermittlung der Profil-Daten ===
73
74 Definiert den URL, welcher für die Anforderung der (Nutzer-) Profildaten vom Identitiy Provider benutzt wird.
75
76 === Request Methode zum Ermittlung der Profil-Daten ===
77
78 Definiert die Request-Methode (GET oder POST) welche für die Anfrage zum Erhalt der Profil-Daten von Identity Provider genutzt wird.
79
80 === Attributname für eindeutigen Identifier in Profil-Daten ===
81
82 Übersteuert den Attributnamen für den Identifier in den zurückgelieferten Profil-Daten. Standardwert ist "id".
83
84 == Mapping of the profile attributes to FORMCYCLE user profile ==
85
86 {{figure image="oauth_extended_settings_en.png" clear="h1"}}
87 Advanced settings for configuring an OAuth 2 identity provider.
88 {{/figure}}
89
90 === Given name ===
91
92 Specifies which profile attribute should be used for the user's first name.
93
94 === Last name ===
95
96 Specifies which profile attribute should be used for the user's last name.
97
98 === Display name ===
99
100 Specifies which profile attribute should be used for the user's display name.
101
102 === Username ===
103
104 Specifies which profile attribute should be used for the user name of the user.
105
106 === Email ===
107
108 Specifies which profile attribute should be used for the user's email address.
109
110 === Language ===
111
112 Specifies which profile attribute should be used for the user's language. (Value must correspond to a code from ISO standards 3166 or 639.)
113
114 === Location ===
115
116 Specifies which profile attribute should be used for the user's location. (Value must correspond to a code from ISO standards 3166 or 639.)
117
118 === Picture URL ===
119
120 Specifies which profile attribute should be used for the user's picture URL. (Value must be convertible to a valid URI.)
121
122 === Profile URL ===
123
124 Specifies which profile attribute should be used for the user's profile URL. (Value must be convertible to a valid URI.)
125
126 === Extended attribute mapping ===
127
128 In addition to the ones listed above, other attributes can be defined in this table. A property and a corresponding value must be entered in each line.