Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Group API Security Policy Assignment API

6 actions 6 updates phrasing extends openapi/strivacity-group-api-security-policy-assignment-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 6

$.info
$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments'].post
$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments/{apiAccessPolicyId}'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments/{apiAccessPolicyId}'].put
$.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments/{apiAccessPolicyId}'].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 Group API Security Policy Assignment API
  version: 1.0.0
extends: openapi/strivacity-group-api-security-policy-assignment-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: 5
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's API security policy assignments
      effect: read
      questions:
      - Which API security policies is a group assigned to?
      - Can I see the API scopes granted to members of a group?
      instructions:
      - text: List API security policy assignments for group {groupId} in {identityStoreName}.
        slots:
          groupId: path.groupId
          identityStoreName: path.identityStoreName
      - text: Show which API policies group {groupId} of {identityStoreName} has.
        slots:
          groupId: path.groupId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an API security policy to a group
      effect: write
      questions:
      - How do I give a group access to an API with specific scopes?
      - Can I assign an API security policy to a whole group?
      instructions:
      - text: Assign API policy {apiAccessPolicy} with scopes {scopes} to group {groupId} in {identityStoreName}.
        slots:
          apiAccessPolicy: requestBody.apiAccessPolicy
          scopes: requestBody.scopes
          groupId: path.groupId
          identityStoreName: path.identityStoreName
      - text: Grant group {groupId} of {identityStoreName} policy {apiAccessPolicy} scopes {scopes}.
        slots:
          groupId: path.groupId
          identityStoreName: path.identityStoreName
          apiAccessPolicy: requestBody.apiAccessPolicy
          scopes: requestBody.scopes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments/{apiAccessPolicyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's API security policy assignment
      effect: read
      questions:
      - What scopes does a group have under one specific API security policy?
      - Can I check a single API policy assignment for a group?
      instructions:
      - text: Get policy {apiAccessPolicyId} assignment for group {groupId} in {identityStoreName}.
        slots:
          apiAccessPolicyId: path.apiAccessPolicyId
          groupId: path.groupId
          identityStoreName: path.identityStoreName
      - text: Show group {groupId}'s scopes under API policy {apiAccessPolicyId} in {identityStoreName}.
        slots:
          groupId: path.groupId
          apiAccessPolicyId: path.apiAccessPolicyId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments/{apiAccessPolicyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a group's assigned API scopes
      effect: write
      questions:
      - How do I change the scopes a group has on an API it's already assigned to?
      - Can I add or remove scopes from a group's API policy assignment?
      instructions:
      - text: Set group {groupId} scopes on policy {apiAccessPolicyId} in {identityStoreName} to {scopes}.
        slots:
          groupId: path.groupId
          apiAccessPolicyId: path.apiAccessPolicyId
          identityStoreName: path.identityStoreName
          scopes: requestBody.scopes
      - text: Update assigned scopes {scopes} for policy {apiAccessPolicy} on group {groupId} ({apiAccessPolicyId}) in {identityStoreName}.
        slots:
          scopes: requestBody.scopes
          apiAccessPolicy: requestBody.apiAccessPolicy
          groupId: path.groupId
          apiAccessPolicyId: path.apiAccessPolicyId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments/{apiAccessPolicyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an API security policy from a group
      effect: destructive
      questions:
      - How do I take API access away from a group?
      - Can I unassign an API security policy from a group?
      instructions:
      - text: Remove API policy {apiAccessPolicyId} from group {groupId} in {identityStoreName}.
        slots:
          apiAccessPolicyId: path.apiAccessPolicyId
          groupId: path.groupId
          identityStoreName: path.identityStoreName
      - text: Delete group {groupId}'s assignment to API policy {apiAccessPolicyId} in {identityStoreName}.
        slots:
          groupId: path.groupId
          apiAccessPolicyId: path.apiAccessPolicyId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'