phoneAuthenticationMethod Ressourcentyp

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Eine Darstellung eines Telefons, das für einen Benutzer registriert ist. Diese Ressource enthält die Telefonnummer, den Telefontyp und ob das Telefon so konfiguriert ist, dass sich der Benutzer per SMS anmeldet.

Ein Telefon verfügt über einen von drei Typen: mobil, alternatives Mobiltelefon oder Büro. Ein Benutzer kann eine Nummer für jeden Typ registrieren lassen 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 die Sicherung.

Primäre Mobiltelefone können je nach Mandanteneinstellungen sowohl für SMS als auch für Sprachanrufe verwendet werden.

Eine Bürotelefonnummer kann nur Sprachanrufe empfangen, keine SMS-Nachrichten.

Dies ist ein abgeleiteter Typ, der vom Ressourcentyp authenticationMethod erbt.

Methoden

Methode Rückgabetyp Beschreibung
List phoneAuthenticationMethod Lesen Sie Eigenschaften und Beziehungen aller phoneAuthenticationMethod-Objekte dieses Benutzers.
Get phoneAuthenticationMethod Lesen Sie Eigenschaften und Beziehungen des phoneAuthenticationMethod-Objekts.
Add phoneAuthenticationMethod Erstellen Sie das phoneAuthenticationMethod-Objekt eines Benutzers.
Update phoneAuthenticationMethod Aktualisieren Sie das phoneAuthenticationMethod-Objekt.
Löschen Keine PhoneAuthenticationMethod-Objekt löschen.
SMS-Anmeldung deaktivieren 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
createdDateTime DateTimeOffset Das Datum und die Uhrzeit, zu der die Authentifizierungsmethode für den Benutzer registriert wurde. Schreibgeschützt. Optional. Der Zeitstempeltyp stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und wird immer in UTC angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z.
lastUsedDateTime DateTimeOffset Das Datum und die Uhrzeit, zu der die Authentifizierungsmethode zuletzt vom Benutzer verwendet wurde. Schreibgeschützt. Optional. Dieser optionale Wert wird null angezeigt, wenn er nicht von der Authentifizierungsmethode ausgefüllt wird. Der Zeitstempeltyp stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und wird immer in UTC angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z. Geerbt von authenticationMethod.
id Zeichenfolge Die Kennung dieses Telefons, das für diesen Benutzer registriert ist. Schreibgeschützt.

Der Wert von ID ist einer der folgenden:
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - where phoneType is alternateMobile.
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - where phoneType is office.
  • 3179e48a-750b-4051-897c-87b9720928f7 - where phoneType is mobile.
PhoneNumber Zeichenfolge Die Telefonnummer, mit der die Authentifizierung per SMS gesendet oder angerufen werden soll. Telefonnummern verwenden das Format "+<Ländercodenummer>><x<Durchwahl",> wobei die Erweiterung optional ist. Beispielsweise sind +1 5555551234 oder +1 5555551234x123 gültig. Nummern werden beim Erstellen/Aktualisieren abgelehnt, wenn sie nicht dem erforderlichen Format entsprechen.
phoneType authenticationPhoneType Der Typ dieses Telefons. Die möglichen Werte sind: mobile, alternateMobile, oder office.
smsSignInState authenticationMethodSignInState Ob ein Telefon für die SMS-Anmeldung bereit ist oder nicht. Die möglichen Werte sind: notSupported, notAllowedByPolicy, notEnabled, phoneNumberNotUnique, readyoder notConfigured, unknownFutureValue.

AuthenticationPhoneType-Werte

Es gibt drei Arten von Telefonen: Im Folgenden sind die möglichen Werte aufgeführt.

Wert Beschreibung
Mobil Ein primäres Mobiltelefon, das für SMS und Sprachanrufe verwendet werden kann.
alternateMobile Ein alternatives oder Ersatzmobiltelefon, das nur für Sprachanrufe verwendet werden kann.
Büro Eine Bürotelefonnummer oder ein Festnetztelefon, das nur für Sprachanrufe verwendet werden kann.

AuthenticationMethodSignInState-Werte

Die SMS-Anmeldestatuseigenschaft gibt Auskunft darüber, ob eine Telefonnummer für die Anmeldung per SMS bereit ist oder nicht. Folgende Werte sind möglich.

Wert Beschreibung
notSupported Die primäre Anmeldung wird bei dieser Authentifizierungsmethode nicht unterstützt – beispielsweise kann die Anmeldung nur mit der primären Mobiltelefonnummer eines Benutzers aktiviert werden, nicht mit der alternativen.
notAllowedByPolicy Dieser Benutzer ist nicht durch eine Richtlinie berechtigt, diese Methode als primäre Anmeldung zu verwenden.
nicht konfiguriert Dieser Benutzer ist durch die Richtlinie berechtigt, diese Methode als primäre Anmeldung zu verwenden, muss jedoch weitere Aktionen ausführen, um sie zu konfigurieren.
phoneNumberNotUnique Dieser Benutzer hat versucht, eine Telefonnummer als primäre Anmeldung einzurichten, die Nummer war jedoch 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

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "@odata.type": "#microsoft.graph.phoneAuthenticationMethod",
  "createdDateTime": "String (timestamp)",
  "lastUsedDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "phoneNumber": "String",
  "phoneType": "string",
  "smsSignInState": "string"
}