temporaryAccessPassAuthenticationMethod 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 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.

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
id String The identifier of the Temporary Access Pass registered to this user.
temporaryAccessPass String The temporaryAccessPass used to authenticate. Returned only on creation of a new temporaryAccessPass; returned as NULL with GET.
createdDateTime DateTimeOffset The date and time when the temporaryAccessPass was created.
startDateTime DateTimeOffset The date and time when the temporaryAccessPass becomes available to use.
lifetimeInMinutes Int32 The lifetime of the temporaryAccessPass in minutes starting at startDateTime. Minimum 10, Maximum 43200 (equivalent to 30 days).
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 temporaryAccessPass lifetime.
isUsable Boolean The state of the authentication method that indicates whether it's currently usable by the user.
methodUsabilityReason String Details about usability state (isUsable). Reasons can include: enabledByPolicy, disabledByPolicy, expired, notYetValid, oneTimeUsed.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

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