Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity.SignIns Policies.activity Based Timeout Policy API

10 actions 10 updates phrasing extends openapi/azure-ad-policies-activitybasedtimeoutpolicy-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/policies/activityBasedTimeoutPolicies'].get
$.paths['/policies/activityBasedTimeoutPolicies'].post
$.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}'].get
$.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}'].delete
$.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}'].patch
$.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo'].get
$.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo/{directoryObject-id}'].get
$.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo/$count'].get
$.paths['/policies/activityBasedTimeoutPolicies/$count'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.SignIns Policies.activity Based Timeout Policy API
  version: 1.0.0
extends: openapi/azure-ad-policies-activitybasedtimeoutpolicy-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/policies/activityBasedTimeoutPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List activity-based timeout policies
      effect: read
      questions:
      - Which idle session timeout policies are defined in my tenant?
      - Can I filter activity-based timeout policies by a property?
      instructions:
      - text: List all activity-based timeout policies.
      - text: Show idle timeout policies matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an activity-based timeout policy
      effect: write
      questions:
      - How do I set up automatic sign-out after inactivity for web apps?
      - Can I create a new idle session timeout policy?
      instructions:
      - text: Create a new activity-based timeout policy.
      - text: Add an idle session sign-out policy to the tenant.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activity-based timeout policy
      effect: read
      questions:
      - What are the settings of one idle session timeout policy?
      - Where can I read the properties of a specific activity-based timeout policy?
      instructions:
      - text: Get activity-based timeout policy {policy}.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      - text: Show the properties of idle timeout policy {policy}.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activity-based timeout policy
      effect: destructive
      questions:
      - How do I remove an idle session timeout policy?
      - Can I delete an activity-based timeout policy I no longer use?
      instructions:
      - text: Delete activity-based timeout policy {policy}.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      - text: Remove idle sign-out policy {policy}.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an activity-based timeout policy
      effect: write
      questions:
      - How do I change an existing idle session timeout policy?
      - Can I edit the properties of an activity-based timeout policy after creating it?
      instructions:
      - text: Update activity-based timeout policy {policy}.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      - text: Edit the settings of idle timeout policy {policy}.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo'].get
  update:
    x-apievangelist-phrasing:
      intent: List objects a timeout policy applies to
      effect: read
      questions:
      - Which directory objects is an idle timeout policy applied to?
      - What does an activity-based timeout policy apply to?
      instructions:
      - text: List the objects timeout policy {policy} applies to.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      - text: Show the top {top} targets of idle timeout policy {policy}.
        slots:
          top: query.$top
          policy: path.activityBasedTimeoutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo/{directoryObject-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object a timeout policy applies to
      effect: read
      questions:
      - Is a specific directory object covered by an idle timeout policy?
      - What are the details of one target of an activity-based timeout policy?
      instructions:
      - text: Get target object {object} of timeout policy {policy}.
        slots:
          object: path.directoryObject-id
          policy: path.activityBasedTimeoutPolicy-id
      - text: Show directory object {object} under idle timeout policy {policy}.
        slots:
          object: path.directoryObject-id
          policy: path.activityBasedTimeoutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count objects a timeout policy applies to
      effect: read
      questions:
      - How many objects is an idle timeout policy applied to?
      - What is the number of targets for one activity-based timeout policy?
      instructions:
      - text: Count the objects timeout policy {policy} applies to.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
      - text: Give me the number of targets on idle timeout policy {policy} matching {filter}.
        slots:
          policy: path.activityBasedTimeoutPolicy-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/activityBasedTimeoutPolicies/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count activity-based timeout policies
      effect: read
      questions:
      - How many idle session timeout policies exist in my tenant?
      - What is the total number of activity-based timeout policies?
      instructions:
      - text: Count the activity-based timeout policies.
      - text: Give me the number of idle timeout policies matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'