Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace Account Management User Management API

8 actions 8 updates phrasing extends openapi/dynatrace-user-management-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Dynatrace's API. It is a proposal applied on top of the contract, not a document Dynatrace publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/iam/v1/accounts/{account-uuid}/users'].get
$.paths['/iam/v1/accounts/{account-uuid}/users'].post
$.paths['/iam/v1/accounts/{account-uuid}/users/{email}'].get
$.paths['/iam/v1/accounts/{account-uuid}/users/{email}'].post
$.paths['/iam/v1/accounts/{account-uuid}/users/{email}'].delete
$.paths['/iam/v1/accounts/{account-uuid}/users/{email}/groups'].put
$.paths['/iam/v1/accounts/{account-uuid}/users/{email}/groups'].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 Dynatrace Account Management User Management API
  version: 1.0.0
extends: openapi/dynatrace-user-management-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: 7
- target: $.paths['/iam/v1/accounts/{account-uuid}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users of an account
      effect: read
      questions:
      - Who has access to my Dynatrace account?
      - Can I include service users in the account user list?
      instructions:
      - text: List all users on account {account}.
        slots:
          account: path.account-uuid
      - text: 'List users on {account} with service users included: {serviceUsers}.'
        slots:
          account: path.account-uuid
          serviceUsers: query.service-users
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to an account by email
      effect: write
      questions:
      - How do I add a colleague to the account using just their email?
      - Can I create a user without assigning groups yet?
      instructions:
      - text: Add user {email} to account {account}.
        slots:
          email: requestBody.email
          account: path.account-uuid
      - text: Create an account user for {email} in {account}.
        slots:
          email: requestBody.email
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/users/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the groups a user belongs to
      effect: read
      questions:
      - Which groups is a given person a member of?
      - Can I check someone's group memberships by email?
      instructions:
      - text: List the groups of user {email} in account {account}.
        slots:
          email: path.email
          account: path.account-uuid
      - text: Show which groups {email} belongs to on {account}.
        slots:
          email: path.email
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/users/{email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to more groups
      effect: write
      questions:
      - Can I add someone to extra groups without dropping their current ones?
      - What's the way to give a user an additional group membership?
      instructions:
      - text: Add user {email} in account {account} to these groups, keeping existing memberships.
        slots:
          email: path.email
          account: path.account-uuid
      - text: Put {email} on {account} into the additional groups I list.
        slots:
          email: path.email
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/users/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from an account
      effect: destructive
      questions:
      - How do I offboard someone from the account entirely?
      - Can I revoke all of a person's account access by email?
      instructions:
      - text: Remove user {email} from account {account}.
        slots:
          email: path.email
          account: path.account-uuid
      - text: Offboard {email} from {account}.
        slots:
          email: path.email
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/users/{email}/groups'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a user's group membership exactly
      effect: write
      questions:
      - Can I overwrite a user's groups so they belong only to the ones I specify?
      - Does setting group membership drop the groups a user already had?
      instructions:
      - text: Set the groups of {email} in account {account} to exactly this list.
        slots:
          email: path.email
          account: path.account-uuid
      - text: Replace every group membership of {email} on {account}.
        slots:
          email: path.email
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/users/{email}/groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from specific groups
      effect: destructive
      questions:
      - How do I take someone out of one group but keep them in the account?
      - Can I remove a user from several groups at once?
      instructions:
      - text: Remove {email} from group {group} in account {account}.
        slots:
          email: path.email
          group: query.group-uuid
          account: path.account-uuid
      - text: Take user {email} on {account} out of groups {group}.
        slots:
          email: path.email
          account: path.account-uuid
          group: query.group-uuid
      method: generated
      generated: '2026-09-26'