Skip to content

temporaryaccesspassauthenticationmethod.md

Latest commit

 

History

History
72 lines (61 loc) · 4.49 KB

temporaryaccesspassauthenticationmethod.md

File metadata and controls

72 lines (61 loc) · 4.49 KB
title temporaryAccessPassAuthenticationMethod resource type
description Represents a Temporary Access Pass registered to a user.
author tilarso
ms.reviewer intelligentaccesspm
ms.localizationpriority medium
ms.subservice entra-monitoring-health
doc_type resourcePageType
toc.keywords
TAP
toc.title Temporary Access Pass
ms.date 07/22/2024

temporaryAccessPassAuthenticationMethod resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents a Temporary Access Pass registered to a user. A Temporary Access Pass is a time-limited passcode that serves as a strong credential and allows onboarding of passwordless credentials. The availability and settings that can be configured for the temporaryAccessPassAuthenticationMethod depends on the Temporary Access Pass methods policy.

This is a derived type that inherits from the authenticationMethod resource type.

Methods

Method Return type Description
List temporaryAccessPassAuthenticationMethod collection Retrieve a list of a user's temporaryAccessPassAuthenticationMethod objects and their properties. Users can only have one Temporary Access Pass authentication method.
Create temporaryAccessPassAuthenticationMethod Create a user's temporaryAccessPassAuthenticationMethod object.
Get temporaryAccessPassAuthenticationMethod Retrieve the properties of the user's temporaryAccessPassAuthenticationMethod object.
Delete None Delete a user's temporaryAccessPassAuthenticationMethod object.

Properties

Property Type Description
createdDateTime DateTimeOffset The date and time when the Temporary Access Pass was created.
id String The identifier of the Temporary Access Pass registered to this user. Inherited from entity.
isUsableOnce Boolean Determines whether the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within the Temporary Access Pass lifetime.
isUsable Boolean The state of the authentication method that indicates whether it's currently usable by the user.
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.
lifetimeInMinutes Int32 The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
methodUsabilityReason String Details about the usability state (isUsable). Reasons can include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed.
startDateTime DateTimeOffset The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
temporaryAccessPass String The Temporary Access Pass used to authenticate. Returned only on creation of a new temporaryAccessPassAuthenticationMethod object; Hidden in subsequent read operations and returned as null with GET.

Relationships

None.

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.temporaryAccessPassAuthenticationMethod",
  "id": "String (identifier)",
  "temporaryAccessPass": "String",
  "createdDateTime": "String (timestamp)",
  "lastUsedDateTime": "String (timestamp)",
  "startDateTime": "String (timestamp)",
  "lifetimeInMinutes": "Integer",
  "isUsableOnce": "Boolean",
  "isUsable": "Boolean",
  "methodUsabilityReason": "String"
}