| title | hardwareOathAuthenticationMethod resource type |
|---|---|
| description | Exposes the hardware OATH method on the user object. |
| author | luc-msft |
| ms.localizationpriority | medium |
| ms.subservice | entra-sign-in |
| doc_type | resourcePageType |
| ms.date | 12/09/2024 |
| toc.title | Hardware OATH method |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Exposes the hardware OATH method on the user object. The method must first be defined by the hardwareOathTokenAuthenticationMethodDevice policy for it to be managed on the user object.
Inherits from authenticationMethod.
| Method | Return type | Description |
|---|---|---|
| List | hardwareOathAuthenticationMethod collection | Get a list of the hardwareOathAuthenticationMethod objects and their properties. |
| Create | hardwareOathAuthenticationMethod | Create a new hardwareOathAuthenticationMethod object. |
| Get | hardwareOathAuthenticationMethod | Read the properties and relationships of a hardwareOathAuthenticationMethod object. |
| Delete | None | Delete a hardwareOathAuthenticationMethod object. |
| Activate | None | Activate a hardware OATH token that is already assigned to a user. |
| Deactivate | None | Deactive a hardware OATH token. It remains assigned to the user. |
| Assign | user | Assign a user a hardware token without activating it. |
| Assign and activate | None | Assign and activate a hardware token at the same time. |
| Assign and activate by serial number | None | Assign and activate a hardware token at the same time by hardware token serial number. |
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time the authentication method was registered to the user. Read-only. Optional. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| lastUsedDateTime | DateTimeOffset | The date and time the authentication method was last used by the user. Read-only. Optional. This optional value is null if the authentication method doesn't populate it. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from authenticationMethod. |
| id | String | Unique identifier for the device. Inherited from entity. |
| Relationship | Type | Description |
|---|---|---|
| device | hardwareOathTokenAuthenticationMethodDevice | Exposes the hardware OATH method in the directory. |
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethod",
"createdDateTime": "String (timestamp)",
"lastUsedDateTime": "String (timestamp)",
"id": "String (identifier)",
}