Get softwareOathAuthenticationMethod
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.
Retrieve a user's single Software OATH token authentication method object and its properties.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ✅ |
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permissions acting on self
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | UserAuthenticationMethod.Read, UserAuthenticationMethod.ReadWrite |
Delegated (personal Microsoft account) | Not supported. |
Application | Not supported. |
Permissions acting on other users
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
- Global Reader
- Authentication Administrator
- Privileged Authentication Administrator
HTTP request
Retrieve details of your own software OATH token authentication method.
GET /me/authentication/softwareOathMethods/{id}
Retrieve details of your own or another user's software OATH token authentication method.
GET /users/{id | userPrincipalName}/authentication/softwareOathMethods/{id}
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a softwareOathAuthenticationMethod object in the response body.
Examples
Request
GET https://graph.microsoft.com/beta/me/authentication/softwareOathMethods/b172893e-893e-b172-3e89-72b13e8972b1
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"@odata.type": "#microsoft.graph.softwareOathAuthenticationMethod",
"id": "b172893e-893e-b172-3e89-72b13e8972b1",
"secretKey": "String"
}
}