Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Group Member API

4 actions 4 updates phrasing extends openapi/strivacity-group-member-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 4

$.info

$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members'].get

$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members'].post

$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members/{accountId}'].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 Admin Portal Group Member API
  version: 1.0.0
extends: openapi/strivacity-group-member-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: 3
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a group
      effect: read
      questions:
      - Who are the members of a particular group?
      - Can I filter group members by role or last login date?
      instructions:
      - text: List members of group {group} in identity store {store}.
        slots:
          group: path.groupId
          store: path.identityStoreName
      - text: Show members of group {group} in {store} who never logged in.
        slots:
          group: path.groupId
          store: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an account to a group
      effect: write
      questions:
      - How do I add a user to a group?
      - What scopes are needed to add a group member?
      instructions:
      - text: Add account {member} to group {group} in {store}.
        slots:
          member: requestBody.id
          group: path.groupId
          store: path.identityStoreName
      - text: Put user {member} into group {group} of identity store {store}.
        slots:
          member: requestBody.id
          group: path.groupId
          store: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members/{accountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an account from a group
      effect: destructive
      questions:
      - How do I take a user out of a group?
      - Can I remove one member from a group?
      instructions:
      - text: Remove account {account} from group {group} in {store}.
        slots:
          account: path.accountId
          group: path.groupId
          store: path.identityStoreName
      - text: Take user {account} out of group {group} in identity store {store}.
        slots:
          account: path.accountId
          group: path.groupId
          store: path.identityStoreName
      method: generated
      generated: '2026-10-01'