phoneAuthenticationMethod-Ressourcentyp
Namespace: microsoft.graph
Wichtig
APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .
Eine Darstellung eines für einen Benutzer registrierten Telefons. Diese Ressource enthält die Telefonnummer, den Telefontyp und ob das Telefon so konfiguriert ist, dass sich der Benutzer per SMS anmeldet.
Ein Telefon hat einen von drei Typen: Mobil, alternatives Mobiltelefon oder Büro. Ein Benutzer kann für jeden Typ eine Nummer registrieren und muss über ein Mobiltelefon verfügen, bevor ein alternatives Mobiltelefon hinzugefügt wird. Wenn Sie ein Telefon für die mehrstufige Authentifizierung (MFA) oder die Self-Service-Kennwortzurücksetzung (Self-Service Password Reset, SSPR) verwenden, ist das Mobiltelefon die Standardeinstellung, und das alternative Mobiltelefon ist die Sicherung.
Mobiltelefone können je nach Mandanteneinstellungen sowohl für SMS als auch für Sprachanrufe verwendet werden.
Ein Office-Telefon kann nur Sprachanrufe empfangen, keine SMS-Nachrichten.
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| List | phoneAuthenticationMethod | Diese Methode liest die Eigenschaften und Beziehungen aller phoneAuthenticationMethod-Objekte dieses Benutzers. |
| Abrufen | phoneAuthenticationMethod | Lesen von Eigenschaften und Beziehungen des phoneAuthenticationMethod-Objekts. |
| Update | phoneAuthenticationMethod | Dient zum Aktualisieren des phoneAuthenticationMethod-Objekts. |
| Delete | Keine | Löschen sie das phoneAuthenticationMethod-Objekt. |
| Deaktivieren der SMS-Anmeldung | Keine | Deaktivieren Sie die SMS-Anmeldung für einen Benutzer. |
| Aktivieren der SMS-Anmeldung | Keine | Aktivieren Sie die SMS-Anmeldung für einen Benutzer. |
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| id | Zeichenfolge | Der Bezeichner dieses für diesen Benutzer registrierten Telefons. Schreibgeschützt. Der Wert der ID ist einer der folgenden:
|
| PhoneNumber | String | Die Telefonnummer, die für text- oder Authentifizierungsanrufe verwendet werden soll. Telefon Zahlen das Format "+ <country code> <number> x <extension> ", mit optionaler Erweiterung. Beispielsweise sind +1 5555551234 oder +1 5555551234x123 gültig. Zahlen werden beim Erstellen/Aktualisieren abgelehnt, wenn sie nicht mit dem erforderlichen Format übereinstimmen. |
| phoneType | authenticationPhoneType | Der Typ dieses Telefons. Mögliche Werte: mobile, alternateMobile oder office. |
| smsSignInState | authenticationMethodSignInState | Gibt an, ob ein Telefon für die SMS-Anmeldung bereit ist oder nicht. Mögliche Werte sind: notSupported , , , , oder notAllowedByPolicy notEnabled phoneNumberNotUnique ready notConfigured . unknownFutureValue |
smsSignInState-Werte
Die Eigenschaft "SMS-Anmeldestatus" gibt Auskunft darüber, ob eine Telefonnummer für die Anmeldung per SMS bereit ist. Nachfolgend sind die möglichen Werte aufgeführt.
| Wert | Beschreibung |
|---|---|
| Notsupported | Primäre Anmeldung wird bei dieser Authentifizierungsmethode nicht unterstützt. Die Anmeldung kann beispielsweise nur für die primäre Mobiltelefonnummer eines Benutzers und nicht für die alternative Nummer aktiviert werden. |
| notAllowedByPolicy | Dieser Benutzer ist von der Richtlinie nicht für die Verwendung dieser Methode als primäre Anmeldung aktiviert. |
| notConfigured | Dieser Benutzer ist durch die Richtlinie aktiviert, um diese Methode als primäre Anmeldung zu verwenden, muss jedoch zusätzliche Maßnahmen ergreifen, um sie zu konfigurieren. |
| phoneNumberNotUnique | Dieser Benutzer hat versucht, eine Telefonnummer als primäre Anmeldung einzurichten, aber die Nummer war nicht eindeutig und kann nicht als Anmeldename verwendet werden. |
| Bereit | Diese Authentifizierungsmethode kann bei der primären Anmeldung verwendet werden. |
| notEnabled | Diese Anmeldemethode ist nicht aktiviert. |
Beziehungen
Keine.
JSON-Darstellung
Es folgt eine JSON-Darstellung der Ressource.
{
"id": "String (identifier)",
"phoneNumber": "String",
"phoneType": "string",
"smsSignInState": "string"
}
Feedback
Feedback senden und anzeigen für