Get softwareOathAuthenticationMethod
이 문서의 내용
Namespace: microsoft.graph
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
For delegated scenarios, the administrator needs at least one of the following Microsoft Entra roles .
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 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/v1.0/me/authentication/softwareOathMethods/b172893e-893e-b172-3e89-72b13e8972b1
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Authentication.SoftwareOathMethods["{softwareOathAuthenticationMethod-id}"].GetAsync();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users authentication software-oath-methods get --user-id {user-id} --software-oath-authentication-method-id {softwareOathAuthenticationMethod-id}
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
softwareOathMethods, err := graphClient.Me().Authentication().SoftwareOathMethods().BySoftwareOathAuthenticationMethodId("softwareOathAuthenticationMethod-id").Get(context.Background(), nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
SoftwareOathAuthenticationMethod result = graphClient.me().authentication().softwareOathMethods().bySoftwareOathAuthenticationMethodId("{softwareOathAuthenticationMethod-id}").get();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
const options = {
authProvider,
};
const client = Client.init(options);
let softwareOathAuthenticationMethod = await client.api('/me/authentication/softwareOathMethods/b172893e-893e-b172-3e89-72b13e8972b1')
.get();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->authentication()->softwareOathMethods()->bySoftwareOathAuthenticationMethodId('softwareOathAuthenticationMethod-id')->get()->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
Import-Module Microsoft.Graph.Identity.SignIns
# A UPN can also be used as -UserId.
Get-MgUserAuthenticationSoftwareOathMethod -UserId $userId -SoftwareOathAuthenticationMethodId $softwareOathAuthenticationMethodId
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
from msgraph import GraphServiceClient
graph_client = GraphServiceClient(credentials, scopes)
result = await graph_client.me.authentication.software_oath_methods.by_software_oath_authentication_method_id('softwareOathAuthenticationMethod-id').get()
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
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": null
}
}