ClaimsSchema
Feljegyzés
Az Azure Active Directory B2C-ben az egyéni szabályzatok elsősorban összetett helyzetek kezelésére szolgálnak. A legtöbb forgatókönyv esetében javasoljuk, hogy beépített felhasználói folyamatokat használjon. Ha még nem tette meg, ismerkedjen meg az egyéni szabályzatok kezdőcsomagjával az Egyéni szabályzatok használatának első lépései az Active Directory B2C-ben.
A jogcímséma elem határozza meg azokat a jogcímtípusokat, amelyekre hivatkozni lehet a szabályzat részeként. A jogcímsémánál deklarálhatja a jogcímeket. A jogcím lehet vezetéknév, vezetéknév, megjelenítendő név, telefonszám stb. A ClaimsSchema elem a ClaimType-elemek listáját tartalmazza. A ClaimType elem tartalmazza az Id attribútumot, amely a jogcím neve.
<BuildingBlocks>
<ClaimsSchema>
<ClaimType Id="Id">
<DisplayName>Surname</DisplayName>
<DataType>string</DataType>
<DefaultPartnerClaimTypes>
<Protocol Name="OAuth2" PartnerClaimType="family_name" />
<Protocol Name="OpenIdConnect" PartnerClaimType="family_name" />
<Protocol Name="SAML2" PartnerClaimType="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname" />
</DefaultPartnerClaimTypes>
<UserHelpText>Your surname (also known as family name or last name).</UserHelpText>
<UserInputType>TextBox</UserInputType>
Jogcímtípus
A ClaimType elem a következő attribútumot tartalmazza:
Attribútum | Kötelező | Leírás |
---|---|---|
Azonosító | Igen | A jogcímtípushoz használt azonosító. Más elemek is használhatják ezt az azonosítót a szabályzatban. |
A ClaimType elem a következő elemeket tartalmazza:
Elem | Események | Leírás |
---|---|---|
Megjelenített név | 1:1 | A különböző képernyőkön a felhasználók számára megjelenített cím. Az érték honosítható. |
Adattípus | 1:1 | A jogcím típusa. |
DefaultPartnerClaimTypes | 0:1 | A partner alapértelmezett jogcímtípusai, amelyek egy adott protokollhoz használhatók. Az érték felülírható az InputClaim vagy OutputClaim elemekben megadott PartnerClaimTypefájlban. Ezzel az elemet használva adja meg a protokoll alapértelmezett nevét. |
Maszk | 0:1 | A jogcím megjelenítésekor alkalmazható maszkoló karakterek opcionális sztringje. A 324-232-4343 telefonszám például XXX-XXX-4343 néven maszkolható. |
UserHelpText | 0:1 | A jogcímtípus leírása, amely hasznos lehet a felhasználók számára a cél megértésében. Az érték honosítható. |
UserInputType | 0:1 | Az a beviteli vezérlő típusa, amely a felhasználó számára a jogcímtípus jogcímadatainak manuális megadásakor lesz elérhető. Tekintse meg a lap későbbi részében definiált felhasználói beviteli típusokat. |
AdminHelpText | 0:1 | A jogcímtípus leírása, amely hasznos lehet a rendszergazdák számára a cél megértésében. |
Korlátozás | 0:1 | A jogcím értékkorlátozásai, például a reguláris kifejezés (Regex) vagy az elfogadható értékek listája. Az érték honosítható. |
PredicateValidationReference | 0:1 | Egy PredicateValidationsInput elemre mutató hivatkozás. A PredicateValidationReference elemek lehetővé teszik egy érvényesítési folyamat végrehajtását, hogy csak a megfelelően formázott adatok legyenek beírva. További információ: Predikátumok. |
Adattípus
A DataType elem a következő értékeket támogatja:
Típus | Leírás |
---|---|
Logikai | Logikai (true vagy false ) értéket jelöl. |
dátum: | Egy pillanatnyi időt jelöl, amely általában egy nap dátumaként van kifejezve. A dátum értéke az ISO 8601 szabványt követi. |
dateTime | Egy azonnali időpontot jelöl, amely általában a nap és a nap dátumaként van kifejezve. A dátum értéke az ISO 8601 szabványnak megfelelő futásidejű, unix-os időszámításúvá alakul, amikor jogcímként a jogkivonatba kerül. |
időtartam | Időintervallumot jelöl évek, hónapok, napok, órák, percek és másodpercek alatt. A formátum az PnYnMnDTnHnMnS , ahol P pozitív vagy N negatív értéket jelez.
nY az évek száma, amelyet egy literál Y követ.
nMo a hónapok száma, amelyet egy literál Mo követ.
nD a napok száma, amelyet egy literál D követ. Példák: P21Y 21 évet jelöl.
P1Y2Mo egy évet és két hónapot jelöl.
P1Y2Mo5D egy évet, két hónapot és öt napot jelöl.
P1Y2M5DT8H5M20S egy évet, két hónapot, öt napot, nyolc órát, öt percet és húsz másodpercet jelöl. |
phoneNumber | Telefonszámot jelöl. |
egész | -2 147 483 648 és 2 147 483 647 közötti számot jelöl |
hosszú | -9 223 372 036 854 775 808 és 9 223 372 036 854 775 807 közötti számot jelöl |
húr | A szöveget UTF-16 kódegységek sorozataként jelöli. |
stringCollection | A gyűjteményét string jelöli. |
userIdentity | Egy felhasználói identitást jelöl. |
userIdentityCollection | A gyűjteményét userIdentity jelöli. |
DefaultPartnerClaimTypes
A DefaultPartnerClaimTypes a következő elemet tartalmazhatja:
Elem | Események | Leírás |
---|---|---|
Protokoll | 1:n | Az alapértelmezett partner jogcímtípus-névvel rendelkező protokollok listája. |
A Protokoll elem a következő attribútumokat tartalmazza:
Attribútum | Kötelező | Leírás |
---|---|---|
Név | Igen | Az Azure AD B2C által támogatott érvényes protokoll neve. Lehetséges értékek: OAuth1, OAuth2, SAML2, OpenIdConnect. |
PartnerClaimType | Igen | A használni kívánt jogcímtípus neve. |
Az alábbi példában, amikor az Identity Experience Framework egy SAML2 identitásszolgáltatóval vagy függő entitásalkalmazással kommunikál, a vezetéknév jogcím az OpenIdConnect és az OAuth2 használatával lesz leképezvehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname
family_name
.
<ClaimType Id="surname">
<DisplayName>Surname</DisplayName>
<DataType>string</DataType>
<DefaultPartnerClaimTypes>
<Protocol Name="OAuth2" PartnerClaimType="family_name" />
<Protocol Name="OpenIdConnect" PartnerClaimType="family_name" />
<Protocol Name="SAML2" PartnerClaimType="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname" />
</DefaultPartnerClaimTypes>
</ClaimType>
Ennek eredményeképpen az Azure AD B2C által kibocsátott JWT-jogkivonat a family_name
ClaimType név vezetékneve helyett ad ki.
{
"sub": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
"auth_time": 1535013501,
"given_name": "David",
"family_name": "Williams",
"name": "David Williams",
}
Maszk
A Maszk elem a következő attribútumokat tartalmazza:
Attribútum | Kötelező | Leírás |
---|---|---|
Type |
Igen | A jogcímmaszk típusa. Lehetséges értékek: Simple vagy Regex . Az Simple érték azt jelzi, hogy egy egyszerű szöveges maszkot alkalmaz a rendszer egy sztring jogcím kezdő részére. Az Regex érték azt jelzi, hogy a sztring jogcímére a rendszer egy reguláris kifejezést alkalmaz. Ha az Regex érték meg van adva, egy opcionális attribútumot is meg kell határozni a használni kívánt reguláris kifejezéssel. |
Regex |
Nem | Ha Type be van állítva Regex , adja meg a használni kívánt reguláris kifejezést. |
Az alábbi példa egy PhoneNumber-jogcímet konfigurál a Simple
maszkkal. További mintákért tekintse meg az Egyszerű maszk igénylése élő bemutatót.
<ClaimType Id="PhoneNumber">
<DisplayName>Phone Number</DisplayName>
<DataType>string</DataType>
<Mask Type="Simple">XXX-XXX-</Mask>
<UserHelpText>Your telephone number.</UserHelpText>
</ClaimType>
Az Identity Experience Framework megjeleníti a telefonszámot, miközben elrejti az első hat számjegyet:
Az alábbi példa egy AlternateEmail jogcímet konfigurál a Regex
maszkkal. További mintákért tekintse meg a Regex maszk élő bemutatóját.
<ClaimType Id="AlternateEmail">
<DisplayName>Please verify the secondary email linked to your account</DisplayName>
<DataType>string</DataType>
<Mask Type="Regex" Regex="(?<=.).(?=.*@)">*</Mask>
<UserInputType>Readonly</UserInputType>
</ClaimType>
Az Identity Experience Framework csak az e-mail-cím és az e-mail-tartománynév első betűje jelenik meg:
Korlátozás
A Korlátozás elem a következő attribútumot tartalmazhatja:
Attribútum | Kötelező | Leírás |
---|---|---|
MergeBehavior | Nem | Az enumerálási értékeknek a fölérendelt házirendben lévő Jogcímtípussal való egyesítése ugyanazzal az azonosítóval. Ezt az attribútumot akkor használja, ha felülír egy, az alapszabályzatban megadott jogcímet. Lehetséges értékek: Append , Prepend vagy ReplaceAll . Az Append érték olyan adatgyűjtemény, amelyet hozzá kell fűzni a szülőszabályzatban megadott gyűjtemény végéhez. Az Prepend érték olyan adatgyűjtemény, amelyet a szülőszabályzatban megadott gyűjtemény előtt kell hozzáadni. Az ReplaceAll érték a szülőszabályzatban megadott adatok gyűjteménye, amelyet figyelmen kívül kell hagyni. |
A Korlátozás elem a következő elemeket tartalmazza:
Elem | Események | Leírás |
---|---|---|
Enumerálás | 1:n | A felhasználói felületen elérhető lehetőségek, hogy a felhasználó kiválaszthassa a jogcímet, például egy legördülő menüben szereplő értéket. |
Minta | 1:1 | A használandó reguláris kifejezés. |
Enumerálás
Az Enumerálás elem meghatározza, hogy a felhasználó a felhasználói felületen kiválasztható-e jogcímet, például egy , CheckboxMultiSelect
DropdownSingleSelect
vagy RadioSingleSelect
. Az elérhető beállításokat a LocalizedCollections elem használatával is definiálhatja és honosíthatja. Ha egy jogcím enumerálási gyűjteményéből szeretne elemet keresni, használja a GetMappedValueFromLocalizedCollection jogcímátalakítást.
Az Enumerálás elem a következő attribútumokat tartalmazza:
Attribútum | Kötelező | Leírás |
---|---|---|
Szöveges | Igen | A felhasználó számára a beállítás felhasználói felületén megjelenő megjelenítési sztring. |
Érték | Igen | A beállítás kiválasztásához társított jogcímérték. |
SelectByDefault | Nem | Azt jelzi, hogy ezt a beállítást alapértelmezés szerint ki kell-e jelölni a felhasználói felületen. Lehetséges értékek: Igaz vagy Hamis. |
Az alábbi példa egy városi legördülő lista jogcímét konfigurálja az alapértelmezett érték beállításával New York
. További mintákért tekintse meg a Jogcímkorlátozások számbavétele élő bemutatót.
<ClaimType Id="city">
<DisplayName>city where you work</DisplayName>
<DataType>string</DataType>
<UserInputType>DropdownSingleSelect</UserInputType>
<Restriction>
<Enumeration Text="Bellevue" Value="bellevue" SelectByDefault="false" />
<Enumeration Text="Redmond" Value="redmond" SelectByDefault="false" />
<Enumeration Text="New York" Value="new-york" SelectByDefault="true" />
</Restriction>
</ClaimType>
Legördülő lista new yorki alapértelmezett értékkel:
Minta
A Minta elem a következő attribútumokat tartalmazhatja:
Attribútum | Kötelező | Leírás |
---|---|---|
RegularExpression | Igen | Az ilyen típusú jogcímek normál kifejezésének egyeznie kell az érvényességhez. |
Súgószöveg | Nem | Hibaüzenet a felhasználók számára, ha a reguláris kifejezés ellenőrzése sikertelen. |
Az alábbi példa egy e-mail-jogcímet konfigurál normál kifejezésbeviteli ellenőrzéssel és súgószöveggel:
<ClaimType Id="email">
<DisplayName>Email Address</DisplayName>
<DataType>string</DataType>
<DefaultPartnerClaimTypes>
<Protocol Name="OpenIdConnect" PartnerClaimType="email" />
</DefaultPartnerClaimTypes>
<UserHelpText>Email address that can be used to contact you.</UserHelpText>
<UserInputType>TextBox</UserInputType>
<Restriction>
<Pattern RegularExpression="^[a-zA-Z0-9.+!#$%&'+^_`{}~-]+(?:\.[a-zA-Z0-9!#$%&'+^_`{}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" HelpText="Please enter a valid email address." />
</Restriction>
</ClaimType>
Az Identity Experience Framework az e-mail-cím jogcímét az e-mail-formátum beviteli ellenőrzésével jeleníti meg:
UserInputType
Az Azure AD B2C számos felhasználói beviteli típust támogat, például egy szövegdobozt, jelszót és legördülő listát, amelyek a jogcímtípus jogcímadatainak manuális megadásakor használhatók. Meg kell adnia a UserInputType értéket, amikor önaláírt technikai profil és megjelenítési vezérlők használatával adatokat gyűjt a felhasználótól.
Tekintse meg a felhasználói beviteli típus élő bemutatóját .
A UserInputType elem elérhető felhasználói beviteli típusai:
UserInputType | Támogatott Jogcímtípus | Leírás |
---|---|---|
CheckboxMultiSelect | string |
Multi select drop-down box. A jogcímérték a kijelölt értékek vesszőelválasztó sztringjében jelenik meg. |
DateTimeDropdown |
date , dateTime |
Legördülő menük egy nap, hónap és év kiválasztásához. |
DropdownSingleSelect | string |
Egyetlen választó legördülő lista. A jogcím értéke a kijelölt érték. |
E-mail-cím | string |
E-mail beviteli mező. |
Bekezdés |
boolean , date , dateTime , duration int , long string |
Olyan mező, amely csak bekezdéscímkében jeleníti meg a szöveget. |
Jelszó | string |
Jelszó szövegmezője. |
RadioSingleSelect | string |
Választógombok gyűjteménye. A jogcím értéke a kijelölt érték. |
Írásvédett |
boolean , date , dateTime , duration int , long string |
Írásvédett szövegdoboz. |
TextBox |
boolean , int , phoneNumber string |
Egysoros szövegmező. |
TextBox
A TextBox felhasználói beviteli típusa egysoros szövegdoboz megadására szolgál.
<ClaimType Id="displayName">
<DisplayName>Display Name</DisplayName>
<DataType>string</DataType>
<UserHelpText>Your display name.</UserHelpText>
<UserInputType>TextBox</UserInputType>
</ClaimType>
E-mail-cím
Az E-mailbox felhasználói beviteli típusa egy alapszintű e-mail beviteli mező megadására szolgál.
<ClaimType Id="email">
<DisplayName>Email Address</DisplayName>
<DataType>string</DataType>
<UserHelpText>Email address that can be used to contact you.</UserHelpText>
<UserInputType>EmailBox</UserInputType>
<Restriction>
<Pattern RegularExpression="^[a-zA-Z0-9.+!#$%&'+^_`{}~-]+(?:\.[a-zA-Z0-9!#$%&'+^_`{}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" HelpText="Please enter a valid email address." />
</Restriction>
</ClaimType>
Jelszó
A jelszó felhasználói beviteli típusa a felhasználó által megadott jelszó rögzítésére szolgál.
<ClaimType Id="password">
<DisplayName>Password</DisplayName>
<DataType>string</DataType>
<UserHelpText>Enter password</UserHelpText>
<UserInputType>Password</UserInputType>
</ClaimType>
DateTimeDropdown
A DateTimeDropdown felhasználói beviteli típussal legördülő listákat adhat meg egy nap, hónap és év kiválasztásához. A predikátumok és a PredicateValidations elemek használatával szabályozhatja a minimális és maximális dátumértékeket. További információ: Predikátumok és predikátumértékek dátumtartományánakkonfigurálása szakasz.
<ClaimType Id="dateOfBirth">
<DisplayName>Date Of Birth</DisplayName>
<DataType>date</DataType>
<UserHelpText>The date on which you were born.</UserHelpText>
<UserInputType>DateTimeDropdown</UserInputType>
</ClaimType>
RadioSingleSelect
A RadioSingleSelect felhasználói beviteli típus olyan választógombok gyűjteményének biztosítására szolgál, amelyek lehetővé teszik a felhasználó számára, hogy válasszon egy lehetőséget.
<ClaimType Id="color">
<DisplayName>Preferred color</DisplayName>
<DataType>string</DataType>
<UserInputType>RadioSingleSelect</UserInputType>
<Restriction>
<Enumeration Text="Blue" Value="Blue" SelectByDefault="false" />
<Enumeration Text="Green " Value="Green" SelectByDefault="false" />
<Enumeration Text="Orange" Value="Orange" SelectByDefault="true" />
</Restriction>
</ClaimType>
DropdownSingleSelect
A DropdownSingleSelect felhasználói beviteli típusa egy legördülő lista megadására szolgál, amely lehetővé teszi a felhasználó számára, hogy válasszon egy lehetőséget.
<ClaimType Id="city">
<DisplayName>City where you work</DisplayName>
<DataType>string</DataType>
<UserInputType>DropdownSingleSelect</UserInputType>
<Restriction>
<Enumeration Text="Bellevue" Value="bellevue" SelectByDefault="false" />
<Enumeration Text="Redmond" Value="redmond" SelectByDefault="false" />
<Enumeration Text="New York" Value="new-york" SelectByDefault="true" />
</Restriction>
</ClaimType>
CheckboxMultiSelect
A CheckboxMultiSelect felhasználói beviteli típus olyan jelölőnégyzetek gyűjteményének megadására szolgál, amelyek lehetővé teszik a felhasználó számára, hogy több beállítást válasszon.
<ClaimType Id="languages">
<DisplayName>Languages you speak</DisplayName>
<DataType>string</DataType>
<UserInputType>CheckboxMultiSelect</UserInputType>
<Restriction>
<Enumeration Text="English" Value="English" SelectByDefault="true" />
<Enumeration Text="France " Value="France" SelectByDefault="false" />
<Enumeration Text="Spanish" Value="Spanish" SelectByDefault="false" />
</Restriction>
</ClaimType>
Írásvédett
Az Olvasható felhasználói beviteli típus egy olvasható mező megadására szolgál a jogcím és az érték megjelenítéséhez.
<ClaimType Id="membershipNumber">
<DisplayName>Membership number</DisplayName>
<DataType>string</DataType>
<UserHelpText>Your membership number (read only)</UserHelpText>
<UserInputType>Readonly</UserInputType>
</ClaimType>
Bekezdés
A Bekezdés felhasználói beviteli típus olyan mező megadására szolgál, amely csak egy bekezdéscímkében jeleníti meg a szöveget. Például p <>szöveg</p>. Az önaláírt műszaki profil egy bekezdésfelhasználói bemeneti típusának OutputClaim
be kell állítania az Required
attribútumot false
(alapértelmezett). Ez a felhasználói beviteli típus csak önaláírt lapelrendezésekben támogatott. Előfordulhat, hogy az egyesített bejelentkezési és regisztrációs oldalak (unifiedssp) nem megfelelően jelenítik meg ezt.
<ClaimType Id="responseMsg">
<DisplayName>Error message: </DisplayName>
<DataType>string</DataType>
<AdminHelpText>A claim responsible for holding response messages to send to the relying party</AdminHelpText>
<UserHelpText>A claim responsible for holding response messages to send to the relying party</UserHelpText>
<UserInputType>Paragraph</UserInputType>
</ClaimType>