Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal - Admin Management Admin Role Assignee API

4 actions 4 updates phrasing extends openapi/strivacity-admin-role-assignee-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/admin/identityStore/roles/{roleId}/assignees'].get
$.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/assignees'].post
$.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/assignees/{accountId}'].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 Admin Portal - Admin Management Admin Role Assignee API
  version: 1.0.0
extends: openapi/strivacity-admin-role-assignee-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/admin/identityStore/roles/{roleId}/assignees'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin accounts holding a role
      effect: read
      questions:
      - Which administrators have been given a particular role?
      - Can I see role holders who have never logged in?
      instructions:
      - text: List the admin accounts assigned to role {roleId}.
        slots:
          roleId: path.roleId
      - text: Show enabled assignees of role {roleId} that have never logged in.
        slots:
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/assignees'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an admin account to a role
      effect: write
      questions:
      - How do I add an administrator to a specific role?
      - What scopes do I need to assign admins to roles?
      instructions:
      - text: Assign admin account {id} to role {roleId}.
        slots:
          id: requestBody.id
          roleId: path.roleId
      - text: Add admin {id} as a member of role {roleId}.
        slots:
          id: requestBody.id
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/roles/{roleId}/assignees/{accountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an admin account from a role
      effect: destructive
      questions:
      - How do I take a role away from an administrator?
      - Can I unassign the Admin role from the last admin account?
      instructions:
      - text: Remove admin account {accountId} from role {roleId}.
        slots:
          accountId: path.accountId
          roleId: path.roleId
      - text: Unassign role {roleId} from admin {accountId}.
        slots:
          roleId: path.roleId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'