authentication_platform_credential_methods

Creates, updates, deletes, gets or lists an authentication_platform_credential_methods resource.

Overview

Name	authentication_platform_credential_methods
Type	Resource
Id	entra_id.users.authentication_platform_credential_methods

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	Represents the date and time when an entity was created. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
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.
displayName	string	The name of the device on which Platform Credential is registered.
keyStrength		Key strength of this Platform Credential key. The possible values are: normal, weak, unknown.
platform		Platform on which this Platform Credential key is present. The possible values are: unknown, windows, macOS,iOS, android, linux.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	Represents the date and time when an entity was created. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
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.
displayName	string	The name of the device on which Platform Credential is registered.
keyStrength		Key strength of this Platform Credential key. The possible values are: normal, weak, unknown.
platform		Platform on which this Platform Credential key is present. The possible values are: unknown, windows, macOS,iOS, android, linux.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, platform_credential_authentication_method_id		Represents a platform credential instance registered to a user on Mac OS.
list	select	user_id		Represents a platform credential instance registered to a user on Mac OS.
delete	delete	user_id, platform_credential_authentication_method_id	If-Match	Delete a platformCredentialAuthenticationMethod object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
platform_credential_authentication_method_id	string	The unique identifier of platformCredentialAuthenticationMethod
user_id	string	The unique identifier of user
If-Match	string	ETag

SELECT examples

get

Represents a platform credential instance registered to a user on Mac OS.

SELECT
id,
createdDateTime,
device,
displayName,
keyStrength,
platform
FROM entra_id.users.authentication_platform_credential_methods
WHERE user_id = '{{ user_id }}' -- required
AND platform_credential_authentication_method_id = '{{ platform_credential_authentication_method_id }}' -- required
;

list

Represents a platform credential instance registered to a user on Mac OS.

SELECT
id,
createdDateTime,
device,
displayName,
keyStrength,
platform
FROM entra_id.users.authentication_platform_credential_methods
WHERE user_id = '{{ user_id }}' -- required
;

DELETE examples

delete

Delete a platformCredentialAuthenticationMethod object.

DELETE FROM entra_id.users.authentication_platform_credential_methods
WHERE user_id = '{{ user_id }}' --required
AND platform_credential_authentication_method_id = '{{ platform_credential_authentication_method_id }}' --required
AND If-Match = '{{ If-Match }}'
;