Create hardwareOathTokenAuthenticationMethodDevice

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet hardwareOathTokenAuthenticationMethodDevice . Cette API prend en charge deux scénarios :

  • Créez le nouveau jeton matériel sans l’attribuer à un utilisateur. Vous pouvez ensuite attribuer à un utilisateur.
  • Créez et attribuez un jeton matériel à un utilisateur dans la même demande.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Délégué (compte professionnel ou scolaire) Policy.ReadWrite.AuthenticationMethod Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Policy.ReadWrite.AuthenticationMethod Non disponible.

Importante

Lorsque vous utilisez des autorisations déléguées avec des comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra approprié ou d’un rôle personnalisé disposant des autorisations nécessaires. Le rôle intégré le moins privilégié requis pour cette opération est Administrateur de stratégie d’authentification.

Pour créer et attribuer un jeton OATH matériel à un utilisateur en une seule requête, l’utilisateur connecté doit également avoir :

  • Autorisation déléguée UserAuthenticationMethod.ReadWrite.All .
  • Soit Administrateur d’authentification (rôle le moins privilégié pour l’attribution de jetons matériels aux utilisateurs non administrateurs), soit Administrateur d’authentification privilégié (rôle le moins privilégié pour l’attribution de jetons matériels aux utilisateurs administrateurs).

Requête HTTP

POST /directory/authenticationMethodDevices/hardwareOathDevices

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet hardwareOathTokenAuthenticationMethodDevice .

Vous pouvez spécifier les propriétés suivantes lors de la création d’un hardwareOathTokenAuthenticationMethodDevice.

Propriété Type Description
serialNumber String Numéro de série du jeton matériel spécifique, souvent situé à l’arrière de l’appareil. Obligatoire.
Fabricant String Nom du fabricant du jeton matériel. Obligatoire.
model String Nom de modèle du jeton matériel. Obligatoire.
Clé secrète String Clé secrète du jeton matériel spécifique, fournie par le fournisseur. Obligatoire.
timeIntervalInSeconds Int32 Intervalle d’actualisation du code de vérification à six chiffres, en secondes. Les valeurs possibles sont : 30 ou 60. Obligatoire.
hashFunction hardwareOathTokenHashFunction Fonction de hachage du jeton matériel. Les valeurs possibles sont hmacsha1ouhmacsha256. La valeur par défaut est : hmacsha1. Facultatif.
assignTo identity ID utilisateur si vous souhaitez attribuer directement le jeton à un utilisateur. Facultatif.
displayName String Nom qui peut être fourni au jeton OATH matériel. Facultatif.

Réponse

En cas de réussite, cette méthode renvoie un 201 Created code de réponse et un objet hardwareOathTokenAuthenticationMethodDevice dans le corps de la réponse.

Exemples

Exemple 1 : créer un jeton sans attribution d’utilisateur

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/directory/authenticationMethodDevices/hardwareOathDevices
Content-Type: application/json

{
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
  "timeIntervalInSeconds": 30,
  "hashFunction": "hmacsha1"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.hardwareOathTokenAuthenticationMethodDevice",
  "id": "9b037532-f999-1ed9-13fd-849ffb995e11",
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": null,
  "timeIntervalInSeconds": 30,
  "status": "available",
  "lastUsedDateTime": null,
  "assignedTo": null,
  "hashFunction": "hmacsha1"
}

Exemple 2 : créer un jeton et l’affecter à un utilisateur

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/directory/authenticationMethodDevices/hardwareOathDevices
Content-Type: application/json

{
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
  "timeIntervalInSeconds": 30,
  "hashFunction": "hmacsha1",
  "assignTo": {
    "id": "0cadbf92-####-####-####-############"
    }
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.hardwareOathTokenAuthenticationMethodDevice",
  "id": "9b037532-f999-1ed9-13fd-849ffb995e11",
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": null,
  "timeIntervalInSeconds": 30,
  "status": "assigned",
  "lastUsedDateTime": null,
  "assignedTo": null,
  "hashFunction": "hmacsha1",
  "assignedTo": {
    "id": "0cadbf92-####-####-####-############",
    "displayName": "Amy Masters"
    }
}