# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST Users API
  version: 1.0.0
extends: openapi/confluence-users-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: 7
- target: $.paths['/wiki/rest/api/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a user by account ID
      effect: read
      questions:
      - How do I get someone's display name and profile picture from their account ID?
      - Will a user's profile visibility settings hide some of their details?
      instructions:
      - text: Get the profile of user {accountId}.
        slots:
          accountId: query.accountId
      - text: Look up account {accountId} and expand {expand}.
        slots:
          accountId: query.accountId
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/anonymous'].get
  update:
    x-apievangelist-phrasing:
      intent: See how anonymous users are shown
      effect: read
      questions:
      - What display name and avatar does Confluence show for anonymous visitors?
      - How are logged-out users represented on the site?
      instructions:
      - text: Show how anonymous users are represented.
      - text: Get the anonymous user's display name and picture.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the logged-in user
      effect: read
      questions:
      - Who am I authenticated as in Confluence?
      - What's my own account ID and userKey?
      instructions:
      - text: Show my own Confluence user profile.
      - text: Get the current user and expand {expand}.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/memberof'].get
  update:
    x-apievangelist-phrasing:
      intent: List the groups a user belongs to
      effect: read
      questions:
      - Which groups is a given user a member of?
      - Can I page through a user's group memberships?
      instructions:
      - text: List the groups user {accountId} belongs to.
        slots:
          accountId: query.accountId
      - text: Get {limit} group memberships for {accountId}.
        slots:
          limit: query.limit
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up several users at once
      effect: read
      questions:
      - Can I fetch details for many account IDs in a single request?
      - What's the maximum number of users a bulk lookup returns?
      instructions:
      - text: Look up the users with account IDs {accountId}.
        slots:
          accountId: query.accountId
      - text: 'Get profile details for all of these accounts: {accountId}.'
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/email'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's email address
      effect: read
      questions:
      - How do I get a user's email even if their profile hides it?
      - Which apps are allowed to read a user's email address?
      instructions:
      - text: Get the email address of user {accountId}.
        slots:
          accountId: query.accountId
      - text: Find the email for account {accountId}, ignoring profile visibility.
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/user/email/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email addresses for several users
      effect: read
      questions:
      - Can I fetch email addresses for a batch of account IDs at once?
      - Is there a bulk way to resolve many users to their emails?
      instructions:
      - text: Get the email addresses for accounts {accountId}.
        slots:
          accountId: query.accountId
      - text: 'Resolve this batch of account IDs to emails: {accountId}.'
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'