# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kinde Management Users API
  version: 1.0.0
extends: openapi/kinde-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/api/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users
      effect: read
      questions:
      - Which users exist in my business?
      - Can I filter the user list to people active since a certain date?
      - Is there a way to list only users who don't belong to any organization?
      instructions:
      - text: List all users.
      - text: Show users with email {email}.
        slots:
          email: query.email
      - text: List users active since {active_since}.
        slots:
          active_since: query.active_since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/refresh_claims'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a user's token claims
      effect: write
      questions:
      - How do I make a user's new roles show up in their tokens right away?
      - Can I invalidate the cached claims for a user?
      instructions:
      - text: Refresh the claims for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Invalidate cached token claims for {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - Can I look up a single user's record by ID?
      - What profile details are stored for a user?
      instructions:
      - text: Show user {id}.
        slots:
          id: query.id
      - text: Get the record for user {id}, expanding {expand}.
        slots:
          id: query.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user
      effect: write
      questions:
      - How do I create a user with an email identity?
      - Can I add a new user directly into an organization?
      instructions:
      - text: Create a user in organization {organization_code}.
        slots:
          organization_code: requestBody.organization_code
      - text: Create a user with profile {profile} and identities {identities}.
        slots:
          profile: requestBody.profile
          identities: requestBody.identities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I delete a user account?
      - Can I also delete the user's profile data when removing them?
      instructions:
      - text: Delete user {id}.
        slots:
          id: query.id
      - text: Delete user {id} and their profile.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user
      effect: write
      questions:
      - Can I suspend a user or force them to reset their password?
      - How do I change a user's first and last name?
      instructions:
      - text: Rename user {id} to {given_name} {family_name}.
        slots:
          id: query.id
          given_name: requestBody.given_name
          family_name: requestBody.family_name
      - text: Suspend user {id}.
        slots:
          id: query.id
      - text: Require user {id} to reset their password.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/feature_flags/{feature_flag_key}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Override a feature flag for a user
      effect: write
      questions:
      - How do I turn a feature on for one specific user?
      - Can I override a flag's value per user?
      instructions:
      - text: Set flag {feature_flag_key} to {value} for user {user_id}.
        slots:
          feature_flag_key: path.feature_flag_key
          value: query.value
          user_id: path.user_id
      - text: Override feature {feature_flag_key} with {value} for {user_id}.
        slots:
          feature_flag_key: path.feature_flag_key
          value: query.value
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/properties/{property_key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set one user property
      effect: write
      questions:
      - How do I set a single custom property value on a user?
      - Can I update one user property by its key?
      instructions:
      - text: Set property {property_key} on user {user_id} to {value}.
        slots:
          property_key: path.property_key
          user_id: path.user_id
          value: query.value
      - text: Update {user_id}'s {property_key} property to {value}.
        slots:
          user_id: path.user_id
          property_key: path.property_key
          value: query.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's property values
      effect: read
      questions:
      - What custom property values are stored on a user?
      - Can an admin read all properties for a given user?
      instructions:
      - text: Show property values for user {user_id}.
        slots:
          user_id: path.user_id
      - text: List custom properties set on {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/properties'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set several user properties
      effect: write
      questions:
      - Can I update multiple custom properties on a user at once?
      - How do I bulk-set a user's property values?
      instructions:
      - text: Update properties {properties} on user {user_id}.
        slots:
          properties: requestBody.properties
          user_id: path.user_id
      - text: Set several property values on {user_id} in one go.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/password'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a user's password
      effect: write
      questions:
      - How do I import a user's existing hashed password?
      - Can I set a temporary password that must be changed?
      instructions:
      - text: Set user {user_id}'s password to hash {hashed_password} using {hashing_method}.
        slots:
          user_id: path.user_id
          hashed_password: requestBody.hashed_password
          hashing_method: requestBody.hashing_method
      - text: Give {user_id} the temporary hashed password {hashed_password}.
        slots:
          user_id: path.user_id
          hashed_password: requestBody.hashed_password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's identities
      effect: read
      questions:
      - Which sign-in identities are linked to a user?
      - Can I see all emails and phone numbers a user signs in with?
      instructions:
      - text: List identities for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show the sign-in identities linked to {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/identities'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an identity to a user
      effect: write
      questions:
      - How do I add another email or phone identity to an existing user?
      - Can I link an identity to a user through a specific connection?
      instructions:
      - text: Add a {type} identity {value} to user {user_id}.
        slots:
          type: requestBody.type
          value: requestBody.value
          user_id: path.user_id
      - text: Link identity {value} to {user_id} via connection {connection_id}.
        slots:
          value: requestBody.value
          user_id: path.user_id
          connection_id: requestBody.connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's active sessions
      effect: read
      questions:
      - Where is a user currently signed in?
      - Can I see a user's active sessions?
      instructions:
      - text: List active sessions for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show where {user_id} is currently logged in.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/sessions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Sign a user out of all sessions
      effect: destructive
      questions:
      - How do I force a user to sign out everywhere?
      - Can I invalidate all of a user's sessions after a compromise?
      instructions:
      - text: Sign user {user_id} out of all sessions.
        slots:
          user_id: path.user_id
      - text: Invalidate every session for {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/mfa'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's environment MFA setup
      effect: read
      questions:
      - Which MFA factors has a user enrolled at the environment level?
      - Can I check a user's multi-factor configuration outside any organization?
      instructions:
      - text: Show the MFA configuration for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Get {user_id}'s enrolled environment MFA factors.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/mfa'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset all of a user's environment MFA
      effect: destructive
      questions:
      - How do I reset every environment MFA factor for a user who lost their phone?
      - Can I clear all of a user's environment-level MFA enrollments?
      instructions:
      - text: Reset all environment MFA for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Clear every environment MFA factor on {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/users/{user_id}/mfa/{factor_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset one of a user's environment MFA factors
      effect: destructive
      questions:
      - Can I reset just one environment MFA factor for a user?
      - How do I remove a single authenticator from a user's environment MFA?
      instructions:
      - text: Reset environment MFA factor {factor_id} for user {user_id}.
        slots:
          factor_id: path.factor_id
          user_id: path.user_id
      - text: Remove factor {factor_id} from {user_id}'s environment MFA.
        slots:
          factor_id: path.factor_id
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'