hardwareOathTokenAuthenticationMethodDevice resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Exposes hardware OATH devices in the directory. For more information, see [Hardware OATH tokens](/entra/identity/authentication/concept-authentication-oath-tokens#oath-hardware-tokens-preview].
Inherits from authenticationMethodDevice.
Methods
| Method | Return type | Description |
|---|---|---|
| List | hardwareOathTokenAuthenticationMethodDevice collection | List all hardware OATH tokens in the inventory. |
| Create | hardwareOathTokenAuthenticationMethodDevice | Create a new hardwareOathTokenAuthenticationMethodDevice object. |
| Create one or more objects | authenticationMethodDevice | Create one or more authenticationMethodDevice objects. |
| Get | hardwareOathTokenAuthenticationMethodDevice | Read the properties and relationships of a hardwareOathTokenAuthenticationMethodDevice object. |
| Update | hardwareOathTokenAuthenticationMethodDevice | Update the properties of a hardwareOathTokenAuthenticationMethodDevice object. |
| Delete | None | Delete an authenticationMethodDevice object. Token needs to be unassigned first. |
| Assign user | user | Add assignTo by posting to the assignTo collection. |
Properties
| Property | Type | Description |
|---|---|---|
| assignedTo | identity | User the token is assigned to. Nullable. Supports $filter (eq). |
| displayName | String | Name that can be provided to the hardware OATH token. Inherited from authenticationMethodDevice. |
| hashFunction | hardwareOathTokenHashFunction | Hash function of the hardrware token. The possible values are: hmacsha1 or hmacsha256. Default value is: hmacsha1. Supports $filter (eq). |
| id | String | Unique identifier of the hardware OATH token. Inherited from entity. |
| manufacturer | String | Manufacturer name of the hardware token. Supports $filter (eq). |
| model | String | Model name of the hardware token. Supports $filter (eq). |
| secretKey | String | Secret key of the specific hardware token, provided by the vendor. |
| serialNumber | String | Serial number of the specific hardware token, often found on the back of the device. Supports $select and $filter (eq). |
| status | hardwareOathTokenStatus | Status of the hardware OATH token.The possible values are: available, assigned, activated, failedActivation. Supports $filter(eq). |
| timeIntervalInSeconds | Int32 | Refresh interval of the 6-digit verification code, in seconds. The possible values are: 30 or 60. Supports $filter (eq). |
Relationships
| Relationship | Type | Description |
|---|---|---|
| assignTo | user | Assign the hardware OATH token to a user. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.hardwareOathTokenAuthenticationMethodDevice",
"id": "String (identifier)",
"displayName": "String",
"serialNumber": "String",
"manufacturer": "String",
"model": "String",
"secretKey": "String",
"timeIntervalInSeconds": "Integer",
"status": "String",
"assignedTo": {
"@odata.type": "microsoft.graph.identity"
},
"hashFunction": "String"
}