authentication_temporary_access_pass_methods

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

Overview

Name	authentication_temporary_access_pass_methods
Type	Resource
Id	entra_id.users.authentication_temporary_access_pass_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])$)
isUsable	boolean	The state of the authentication method that indicates whether it's currently usable by the user.
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.
lifetimeInMinutes	number (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	string (date-time)	The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced. (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])$)
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.

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])$)
isUsable	boolean	The state of the authentication method that indicates whether it's currently usable by the user.
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.
lifetimeInMinutes	number (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	string (date-time)	The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced. (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])$)
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, temporary_access_pass_authentication_method_id		Retrieve a user's single temporaryAccessPassAuthenticationMethod object.
list	select	user_id		Retrieve a list of a user's temporaryAccessPassAuthenticationMethod objects and their properties. This API will only return a single object in the collection as a user can have only one Temporary Access Pass method.
insert	insert	user_id		Create a new temporaryAccessPassAuthenticationMethod object on a user. A user can only have one Temporary Access Pass that's usable within its specified lifetime. If the user requires a new Temporary Access Pass while the current Temporary Access Pass is valid, the admin can create a new Temporary Access Pass for the user, the previous Temporary Access Pass will be deleted, and a new Temporary Access Pass will be created.
delete	delete	user_id, temporary_access_pass_authentication_method_id	If-Match	Delete a users's temporaryAccessPassAuthenticationMethod 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
temporary_access_pass_authentication_method_id	string	The unique identifier of temporaryAccessPassAuthenticationMethod
user_id	string	The unique identifier of user
If-Match	string	ETag

SELECT examples

get

Retrieve a user's single temporaryAccessPassAuthenticationMethod object.

SELECT
id,
createdDateTime,
isUsable,
isUsableOnce,
lifetimeInMinutes,
methodUsabilityReason,
startDateTime,
temporaryAccessPass
FROM entra_id.users.authentication_temporary_access_pass_methods
WHERE user_id = '{{ user_id }}' -- required
AND temporary_access_pass_authentication_method_id = '{{ temporary_access_pass_authentication_method_id }}' -- required
;

list

Retrieve a list of a user's temporaryAccessPassAuthenticationMethod objects and their properties. This API will only return a single object in the collection as a user can have only one Temporary Access Pass method.

SELECT
id,
createdDateTime,
isUsable,
isUsableOnce,
lifetimeInMinutes,
methodUsabilityReason,
startDateTime,
temporaryAccessPass
FROM entra_id.users.authentication_temporary_access_pass_methods
WHERE user_id = '{{ user_id }}' -- required
;

INSERT examples

insert

Create a new temporaryAccessPassAuthenticationMethod object on a user. A user can only have one Temporary Access Pass that's usable within its specified lifetime. If the user requires a new Temporary Access Pass while the current Temporary Access Pass is valid, the admin can create a new Temporary Access Pass for the user, the previous Temporary Access Pass will be deleted, and a new Temporary Access Pass will be created.

INSERT INTO entra_id.users.authentication_temporary_access_pass_methods (
id,
createdDateTime,
isUsable,
isUsableOnce,
lifetimeInMinutes,
methodUsabilityReason,
startDateTime,
temporaryAccessPass,
user_id
)
SELECT 
'{{ id }}',
'{{ createdDateTime }}',
{{ isUsable }},
{{ isUsableOnce }},
{{ lifetimeInMinutes }},
'{{ methodUsabilityReason }}',
'{{ startDateTime }}',
'{{ temporaryAccessPass }}',
'{{ user_id }}'
RETURNING
id,
createdDateTime,
isUsable,
isUsableOnce,
lifetimeInMinutes,
methodUsabilityReason,
startDateTime,
temporaryAccessPass
;

Manifest

# Description fields are for documentation purposes
- name: authentication_temporary_access_pass_methods
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the authentication_temporary_access_pass_methods resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      Represents the date and time when an entity was created. Read-only.
  - name: isUsable
    value: {{ isUsable }}
    description: |
      The state of the authentication method that indicates whether it's currently usable by the user.
  - name: isUsableOnce
    value: {{ isUsableOnce }}
    description: |
      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.
  - name: lifetimeInMinutes
    value: {{ lifetimeInMinutes }}
    description: |
      The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
  - name: methodUsabilityReason
    value: "{{ methodUsabilityReason }}"
    description: |
      Details about the usability state (isUsable). Reasons can include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed.
  - name: startDateTime
    value: "{{ startDateTime }}"
    description: |
      The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
  - name: temporaryAccessPass
    value: "{{ temporaryAccessPass }}"
    description: |
      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.

DELETE examples

delete

Delete a users's temporaryAccessPassAuthenticationMethod object.

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