Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Account Lifecycle Rule API

6 actions 6 updates phrasing extends openapi/strivacity-account-lifecycle-rule-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules'].post
$.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules/{lifecycleRuleId}'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules/{lifecycleRuleId}'].put
$.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules/{lifecycleRuleId}'].delete

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 Admin Portal Account Lifecycle Rule API
  version: 1.0.0
extends: openapi/strivacity-account-lifecycle-rule-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: 5
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List account lifecycle rules
      effect: read
      questions:
      - Which automatic account lifecycle rules run on an identity store?
      - How can I see the rules that disable or delete inactive accounts?
      instructions:
      - text: List the lifecycle rules for identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Show all account lifecycle rules in {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account lifecycle rule
      effect: write
      questions:
      - How do I automatically act on accounts that match a filter?
      - Can I create a lifecycle rule that starts out disabled?
      instructions:
      - text: Create lifecycle rule {name} in {identityStoreName} with filter {filter} and actions {actions}.
        slots:
          name: requestBody.name
          identityStoreName: path.identityStoreName
          filter: requestBody.filter
          actions: requestBody.actions
      - text: Add a disabled lifecycle rule {name} to identity store {identityStoreName}.
        slots:
          name: requestBody.name
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules/{lifecycleRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account lifecycle rule
      effect: read
      questions:
      - What filter and actions does a particular lifecycle rule use?
      - How do I inspect one account lifecycle rule?
      instructions:
      - text: Show lifecycle rule {lifecycleRuleId} in identity store {identityStoreName}.
        slots:
          lifecycleRuleId: path.lifecycleRuleId
          identityStoreName: path.identityStoreName
      - text: Get the filter and actions of rule {lifecycleRuleId} in {identityStoreName}.
        slots:
          lifecycleRuleId: path.lifecycleRuleId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules/{lifecycleRuleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account lifecycle rule
      effect: write
      questions:
      - How do I change the filter on an existing lifecycle rule?
      - Can I pause a lifecycle rule by turning it off?
      instructions:
      - text: Update lifecycle rule {lifecycleRuleId} in {identityStoreName} to use filter {filter}.
        slots:
          lifecycleRuleId: path.lifecycleRuleId
          identityStoreName: path.identityStoreName
          filter: requestBody.filter
      - text: Set enabled to {enabled} on lifecycle rule {lifecycleRuleId} in identity store {identityStoreName}.
        slots:
          enabled: requestBody.enabled
          lifecycleRuleId: path.lifecycleRuleId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules/{lifecycleRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account lifecycle rule
      effect: destructive
      questions:
      - How do I remove an account lifecycle rule I no longer want?
      - Can I delete a lifecycle rule from an identity store?
      instructions:
      - text: Delete lifecycle rule {lifecycleRuleId} from identity store {identityStoreName}.
        slots:
          lifecycleRuleId: path.lifecycleRuleId
          identityStoreName: path.identityStoreName
      - text: Remove rule {lifecycleRuleId} in {identityStoreName}.
        slots:
          lifecycleRuleId: path.lifecycleRuleId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'