temporaryAccessPassAuthenticationMethodConfiguration 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 authentication methods policy that defines the configuration settings and users or groups who are enabled to use the Temporary Access Pass authentication method.

Inherits from authenticationMethodConfiguration.

Methods

Method	Return type	Description
Get	temporaryaccesspassauthenticationmethodconfiguration	Read the properties and relationships of a temporaryAccessPassAuthenticationMethodConfiguration object.
Update	None	Update the properties of a temporaryAccessPassAuthenticationMethodConfiguration object.
Delete	None	Reverts the temporaryAccessPassAuthenticationMethodConfiguration object to its default configuration.

Properties

Property	Type	Description
defaultLength	Int	Default length in characters of a Temporary Access Pass object. Must be between 8 and 48 characters.
defaultLifetimeInMinutes	Int	Default lifetime in minutes for a Temporary Access Pass. Value can be any integer between the minimumLifetimeInMinutes and maximumLifetimeInMinutes.
excludeTargets	excludeTarget collection	Groups of users that are excluded from the policy.
id	String	The identifier of the authentication method policy. Inherited from entity.
isUsableOnce	Boolean	If true, all the passes in the tenant will be restricted to one-time use. If false, passes in the tenant can be created to be either one-time use or reusable.
minimumLifetimeInMinutes	Int	Minimum lifetime in minutes for any Temporary Access Pass created in the tenant. Value can be between 10 and 43200 minutes (equivalent to 30 days).
maximumLifetimeInMinutes	Int	Maximum lifetime in minutes for any Temporary Access Pass created in the tenant. Value can be between 10 and 43200 minutes (equivalent to 30 days).
state	authenticationMethodState	Whether the Temporary Access Pass method is enabled in the tenant. Possible values are: enabled, disabled. Inherited from authenticationMethodConfiguration.

Relationships

Relationship	Type	Description
includeTargets	authenticationMethodTarget collection	A collection of groups that are enabled to use the authentication method.

The following JSON representation shows the resource type. The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration",
  "id": "String (identifier)",
  "state": "String",
  "excludeTargets": [
    {
      "@odata.type": "microsoft.graph.excludeTarget"
    }
  ],
  "defaultLifetimeInMinutes": "Integer",
  "defaultLength": "Integer",
  "minimumLifetimeInMinutes": "Integer",
  "maximumLifetimeInMinutes": "Integer",
  "isUsableOnce": "Boolean",
  "includeTargets": [ { "@odata.type": "microsoft.graph.authenticationMethodTarget" } ]
}