Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace Account Management Group Management API

6 actions 6 updates phrasing extends openapi/dynatrace-group-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 6

$.info

$.paths['/iam/v1/accounts/{account-uuid}/groups'].get

$.paths['/iam/v1/accounts/{account-uuid}/groups'].post

$.paths['/iam/v1/accounts/{account-uuid}/groups/{group-uuid}/users'].get

$.paths['/iam/v1/accounts/{account-uuid}/groups/{group-uuid}'].put

$.paths['/iam/v1/accounts/{account-uuid}/groups/{group-uuid}'].delete

OpenAPI Overlay

# 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 Group Management API
  version: 1.0.0
extends: openapi/dynatrace-group-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: 5
- target: $.paths['/iam/v1/accounts/{account-uuid}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's user groups
      effect: read
      questions:
      - What user groups are defined in my Dynatrace account?
      - Can I get every group in the account in one response?
      instructions:
      - text: List all user groups on account {account}.
        slots:
          account: path.account-uuid
      - text: Show the groups configured for {account}.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create several user groups at once
      effect: write
      questions:
      - Can I create multiple user groups in a single request?
      - What's the bulk way to set up new groups for teams?
      instructions:
      - text: Create a batch of new user groups in account {account}.
        slots:
          account: path.account-uuid
      - text: Bulk-add several groups to {account}.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/groups/{group-uuid}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of a group
      effect: read
      questions:
      - Who belongs to a particular user group?
      - Can I see the member list for one group?
      instructions:
      - text: List the members of group {group} in account {account}.
        slots:
          group: path.group-uuid
          account: path.account-uuid
      - text: Show who is in group {group} on {account}.
        slots:
          group: path.group-uuid
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/groups/{group-uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a group's name, description or SAML values
      effect: write
      questions:
      - Can I change the federated attribute values that map SSO users to a group?
      - How do I rename a user group and update its description?
      instructions:
      - text: Rename group {group} in account {account} to {name}.
        slots:
          group: path.group-uuid
          account: path.account-uuid
          name: requestBody.name
      - text: Set federated attribute values {values} on group {group} in {account}, keeping name {name}.
        slots:
          values: requestBody.federatedAttributeValues
          group: path.group-uuid
          account: path.account-uuid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{account-uuid}/groups/{group-uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user group
      effect: destructive
      questions:
      - What happens to members when I delete a user group?
      - Can a group be removed from the account entirely?
      instructions:
      - text: Delete group {group} from account {account}.
        slots:
          group: path.group-uuid
          account: path.account-uuid
      - text: Remove the unused user group {group} on {account}.
        slots:
          group: path.group-uuid
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'