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 gibt an, ob das Telefon so konfiguriert ist, dass sich der Benutzer per SMS anmeldet.
Ein Telefon verfügt über einen von drei Typen: mobil, alternativ mobil oder büro. Ein Benutzer kann eine Nummer für jeden Typ registriert haben und muss über ein Mobiltelefon verfügen, bevor ein alternatives Mobiltelefon hinzugefügt wird. Wenn Sie ein Telefon für die mehrstufige Authentifizierung (Multi-Factor Authentication, 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.
Primäre Mobiltelefone können abhängig von den Mandanteneinstellungen sowohl für SMS- als auch für Sprachanrufe verwendet werden.
Ein Bürotelefon kann nur Sprachanrufe empfangen, keine SMS-Nachrichten.
Dies ist ein abgeleiteter Typ, der vom Ressourcentyp authenticationMethod erbt.
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| List | phoneAuthenticationMethod | Liest die Eigenschaften und Beziehungen aller phoneAuthenticationMethod-Objekte dieses Benutzers. |
| Get | phoneAuthenticationMethod | Liest 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 | Löschen Sie das phoneAuthenticationMethod-Objekt. |
| 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 ist immer in UTC angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z. |
| id | Zeichenfolge | Der Bezeichner dieses Telefons, das für diesen Benutzer registriert ist. Schreibgeschützt. Der Wert von ID ist einer der folgenden:
|
| PhoneNumber | Zeichenfolge | Die Telefonnummer, die per SMS gesendet oder zur Authentifizierung angerufen werden soll. Telefonnummern verwenden das Format "+<Ländervorwahlnummer>><x<Durchwahl>", wobei die Durchwahl optional ist. Beispielsweise sind +1 5555551234 oder +1 555551234x1233 gültig. Nummern 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, notAllowedByPolicy, , phoneNumberNotUniquenotEnabled, readyoder notConfigured. unknownFutureValue |
authenticationPhoneType-Werte
Telefone können von drei Typen sein. Die folgenden Werte sind möglich.
| Wert | Beschreibung |
|---|---|
| Mobil | Ein primäres Mobiltelefon, das für SMS- und Sprachanrufe verwendet werden kann. |
| alternateMobile | Ein alternatives oder backup-Mobiltelefon, das nur für Sprachanrufe verwendet werden kann. |
| Büro | Ein Bürotelefon oder Festnetztelefon, das nur für Sprachanrufe verwendet werden kann. |
authenticationMethodSignInState-Werte
Die Eigenschaft SMS-Anmeldezustand gibt Informationen darüber an, ob eine Telefonnummer bereit ist, sich per SMS anzumelden. Im Folgenden sind die möglichen Werte aufgeführt.
| Wert | Beschreibung |
|---|---|
| notSupported | Die primäre Anmeldung wird bei dieser Authentifizierungsmethode nicht unterstützt. Beispielsweise kann die Anmeldung nur für die primäre Mobiltelefonnummer eines Benutzers und nicht für die alternative Nummer aktiviert werden. |
| notAllowedByPolicy | Dieser Benutzer ist durch die Richtlinie nicht für die Verwendung dieser Methode als primäre Anmeldung aktiviert. |
| notConfigured | Dieser Benutzer wird durch die Richtlinie für die Verwendung dieser Methode als primäre Anmeldung aktiviert, muss aber weitere 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. |
| fertig | 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)",
"id": "String (identifier)",
"phoneNumber": "String",
"phoneType": "string",
"smsSignInState": "string"
}