Edit

Share via

Get platformCredentialAuthenticationMethod

  • Article

Namespace: microsoft.graph

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, UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All
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 UserAuthenticationMethod.ReadWrite, UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application UserAuthenticationMethod.Read.All UserAuthenticationMethod.ReadWrite.All

Important

In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they 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

To read details of your own Platform Credential authentication method:

GET /me/authentication/platformCredentialMethods/{platformCredentialAuthenticationMethodId}

Note

Calling the /me endpoint requires a signed-in user and therefore a delegated permission. Application permissions aren't supported when using the /me endpoint.

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

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

Request

The following example shows a request.

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

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": 
    {
      "@odata.type": "#microsoft.graph.platformCredentialAuthenticationMethod",
      "id": "R18B3t8Ogh9XIOGmPt81d6p_KXJs1YTxfGgGqeVFJSM1",
      "displayName": "My Macbook Pro",
      "creationDateTime": "2023-09-02T04:16:49Z",
      "keyStrength": "normal",
      "platform": "macOS"
    }
}