Skip to content

platformcredentialauthenticationmethod.md

Latest commit

 

History

History
64 lines (55 loc) · 3.91 KB

platformcredentialauthenticationmethod.md

File metadata and controls

64 lines (55 loc) · 3.91 KB
title platformCredentialAuthenticationMethod resource type
description A representation of a Platform Credential instance registered to a user on macOS. Platform Credential is a sign-in authentication method.
author Veena11
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type resourcePageType
toc.title Platform Credential
ms.date 07/22/2024

platformCredentialAuthenticationMethod resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents a platform credential instance registered to a user on Mac OS. Platform Credential is a sign-in authentication method for Mac OS devices.

This derived type inherits from the authenticationMethod resource type.

Methods

Method Return type Description
List platformCredentialAuthenticationMethod collection Get a list of the platformCredentialAuthenticationMethod objects and their properties.
Get platformCredentialAuthenticationMethod Read the properties and relationships of a platformCredentialAuthenticationMethod object.
Delete None Delete a platformCredentialAuthenticationMethod object.

Properties

Property Type Description
createdDateTime DateTimeOffset The date and time that this Platform Credential Key was registered.
displayName String The name of the device on which Platform Credential is registered.
id String A unique identifier for this authentication method. Inherited from authenticationMethod
lastUsedDateTime DateTimeOffset The date and time the authentication method was last used by the user. Read-only. Optional. This optional value is null if the authentication method doesn't populate it. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from authenticationMethod.
keyStrength authenticationMethodKeyStrength Key strength of this Platform Credential key. The possible values are: normal, weak, unknown.
platform authenticationMethodPlatform Platform on which this Platform Credential key is present. The possible values are: unknown, windows, macOS,iOS, android, linux.

Relationships

Relationship Type Description
device device The registered device on which this Platform Credential resides. Supports $expand.

When you get a user's Platform Credential registration information, this property is returned only on a single GET and when you specify ?$expand. For example, GET /users/admin@contoso.com/authentication/platformCredentialAuthenticationMethod/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.platformCredentialAuthenticationMethod",
  "id": "String (Identifier)",
  "displayName": "String",
  "createdDateTime": "String (timestamp)",
  "lastUsedDateTime": "String (timestamp)",
  "keyStrength": {"@odata.type": "microsoft.graph.authenticationMethodKeyStrength"},
  "platform": {"@odata.type": "microsoft.graph.authenticationMethodPlatform"}
}