authentication_fido2_methods
Creates, updates, deletes, gets or lists an authentication_fido2_methods resource.
Overview
| Name | authentication_fido2_methods |
| Type | Resource |
| Id | entra_id.users.authentication_fido2_methods |
Fields
The following fields are returned by SELECT queries:
- get
- list
Retrieved navigation property
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
aaGuid | string | Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator. |
attestationCertificates | array | The attestation certificate or certificates attached to this passkey. |
attestationLevel | | The attestation level of this passkey (FIDO2). The possible values are: attested, notAttested, unknownFutureValue. |
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])$) |
displayName | string | The display name of the key as given by the user. |
model | string | The manufacturer-assigned model of the FIDO2 passkey. |
passkeyType | | The type of passkey. The possible values are: deviceBound, synced, unknownFutureValue. |
publicKeyCredential | |
Retrieved collection
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
aaGuid | string | Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator. |
attestationCertificates | array | The attestation certificate or certificates attached to this passkey. |
attestationLevel | | The attestation level of this passkey (FIDO2). The possible values are: attested, notAttested, unknownFutureValue. |
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])$) |
displayName | string | The display name of the key as given by the user. |
model | string | The manufacturer-assigned model of the FIDO2 passkey. |
passkeyType | | The type of passkey. The possible values are: deviceBound, synced, unknownFutureValue. |
publicKeyCredential | |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | user_id, fido2_authentication_method_id | Represents the FIDO2 security keys registered to a user for authentication. | |
list | select | user_id | Represents the FIDO2 security keys registered to a user for authentication. | |
delete | delete | user_id, fido2_authentication_method_id | If-Match | Deletes a user's FIDO2 security key authentication method 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 |
|---|---|---|
fido2_authentication_method_id | string | The unique identifier of fido2AuthenticationMethod |
user_id | string | The unique identifier of user |
If-Match | string | ETag |
SELECT examples
- get
- list
Represents the FIDO2 security keys registered to a user for authentication.
SELECT
id,
aaGuid,
attestationCertificates,
attestationLevel,
createdDateTime,
displayName,
model,
passkeyType,
publicKeyCredential
FROM entra_id.users.authentication_fido2_methods
WHERE user_id = '{{ user_id }}' -- required
AND fido2_authentication_method_id = '{{ fido2_authentication_method_id }}' -- required
;
Represents the FIDO2 security keys registered to a user for authentication.
SELECT
id,
aaGuid,
attestationCertificates,
attestationLevel,
createdDateTime,
displayName,
model,
passkeyType,
publicKeyCredential
FROM entra_id.users.authentication_fido2_methods
WHERE user_id = '{{ user_id }}' -- required
;
DELETE examples
- delete
Deletes a user's FIDO2 security key authentication method object.
DELETE FROM entra_id.users.authentication_fido2_methods
WHERE user_id = '{{ user_id }}' --required
AND fido2_authentication_method_id = '{{ fido2_authentication_method_id }}' --required
AND If-Match = '{{ If-Match }}'
;