Get platformCredentialAuthenticationMethod

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.

Read the properties and relationships of a platformCredentialAuthenticationMethod object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow best practices to request least privileged permissions. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permissions acting on self

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	UserAuthenticationMethod.Read	UserAuthenticationMethod.ReadWrite
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

Permissions acting on other users

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	UserAuthenticationMethod.Read.All	UserAuthenticationMethod.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	UserAuthenticationMethod.Read.All	UserAuthenticationMethod.ReadWrite.All

For delegated scenarios where an admin is acting on another user, the administrator needs at least one of the following Microsoft Entra roles.

• Global Reader
• Authentication Administrator
• Privileged Authentication Administrator

HTTP request

To read details of your own Platform Credential authentication method:

GET /me/authentication/platformCredentialMethods/{platformCredentialAuthenticationMethodId}

To read details of your own or another user's Platform Credential authentication method:

GET /users/{id | userPrincipalName}/authentication/platformCredentialMethods/{platformCredentialAuthenticationMethodId}

Optional query parameters

This method supports the $expand query parameter to customize the response. For general information, see OData query parameters.

To read the device navigation property for another user, specify it in an $expand query as follows: /users/{id}/authentication/platformCredentialMethods/{id}?$expand=device.

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 platformCredentialAuthenticationMethod object in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/me/authentication/platformCredentialMethods/R18B3t8Ogh9XIOGmPt81d6p_KXJs1YTxfGgGqeVFJSM1

C#

// 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.PlatformCredentialMethods["{platformCredentialAuthenticationMethod-id}"].GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users authentication platform-credential-methods get --user-id {user-id} --platform-credential-authentication-method-id {platformCredentialAuthenticationMethod-id}

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



platformCredentialMethods, err := graphClient.Me().Authentication().PlatformCredentialMethods().ByPlatformCredentialAuthenticationMethodId("platformCredentialAuthenticationMethod-id").Get(context.Background(), nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

PlatformCredentialAuthenticationMethod result = graphClient.me().authentication().platformCredentialMethods().byPlatformCredentialAuthenticationMethodId("{platformCredentialAuthenticationMethod-id}").get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let platformCredentialAuthenticationMethod = await client.api('/me/authentication/platformCredentialMethods/R18B3t8Ogh9XIOGmPt81d6p_KXJs1YTxfGgGqeVFJSM1')
	.version('beta')
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->authentication()->platformCredentialMethods()->byPlatformCredentialAuthenticationMethodId('platformCredentialAuthenticationMethod-id')->get()->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Beta.Identity.SignIns

# A UPN can also be used as -UserId.
Get-MgBetaUserAuthenticationPlatformCredentialMethod -UserId $userId -PlatformCredentialAuthenticationMethodId $platformCredentialAuthenticationMethodId

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.me.authentication.platform_credential_methods.by_platform_credential_authentication_method_id('platformCredentialAuthenticationMethod-id').get()

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": {
      "id": "R18B3t8Ogh9XIOGmPt81d6p_KXJs1YTxfGgGqeVFJSM1",
      "displayName": "My Macbook Pro",
      "creationDateTime": "2023-09-02T04:16:49Z"
  }
}