platformCredentialAuthenticationMethod resource type

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.

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 platformCredentialAuthenticationMethods platformCredentialAuthenticationMethod collection Get a list of the platformCredentialAuthenticationMethod objects and their properties.
Get platformCredentialAuthenticationMethod platformCredentialAuthenticationMethod Read the properties and relationships of a platformCredentialAuthenticationMethod object.
Delete platformCredentialAuthenticationMethod 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
keyStrength authenticationMethodKeyStrength Key strength of this Platform Credential key. Possible values are: normal, weak, unknown.
platform authenticationMethodPlatform Platform on which this Platform Credential key is present. 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",
  "keyStrength": {"@odata.type": "microsoft.graph.authenticationMethodKeyStrength"},
  "platform": {"@odata.type": "microsoft.graph.authenticationMethodPlatform"}
}