Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management Grant Login API

6 actions 6 updates phrasing extends openapi/conga-grant-login-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/user-management/v1/grantlogin'].get

$.paths['/api/user-management/v1/grantlogin'].post

$.paths['/api/user-management/v1/grantlogin/durations'].get

$.paths['/api/user-management/v1/grantlogin/{grantLoginId}'].get

$.paths['/api/user-management/v1/grantlogin/{grantLoginId}'].put

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 User Management Grant Login API
  version: 1.0.0
extends: openapi/conga-grant-login-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['/api/user-management/v1/grantlogin'].get
  update:
    x-apievangelist-phrasing:
      intent: List grant login requests
      effect: read
      questions:
      - Which grant login requests are open?
      - Can I filter grant login requests by criteria?
      instructions:
      - text: List all grant login requests.
      - text: Show grant login requests matching {criteria}.
        slots:
          criteria: query.criteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/grantlogin'].post
  update:
    x-apievangelist-phrasing:
      intent: Request login access for support
      effect: write
      questions:
      - How do I grant support access to log in as a user?
      - Can I tie a login grant to a support case?
      instructions:
      - text: Grant login access to user {user} for {duration}.
        slots:
          user: requestBody.UserId
          duration: requestBody.AccessDuration
      - text: Create a login grant for {user} on case {case}.
        slots:
          user: requestBody.UserId
          case: requestBody.CaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/grantlogin/durations'].get
  update:
    x-apievangelist-phrasing:
      intent: List login access durations
      effect: read
      questions:
      - How long can a login grant last?
      - What access durations are available?
      instructions:
      - text: List the allowed access durations.
      - text: Show the grant login duration options.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/grantlogin/{grantLoginId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a grant login request
      effect: read
      questions:
      - Where can I see the details of one login grant?
      - When does a specific grant login expire?
      instructions:
      - text: Get grant login request {id}.
        slots:
          id: path.grantLoginId
      - text: Show the details of login grant {id}.
        slots:
          id: path.grantLoginId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/grantlogin/{grantLoginId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a grant login request
      effect: destructive
      questions:
      - Can I revoke a login grant before it expires?
      - How do I cancel support login access?
      instructions:
      - text: Cancel grant login request {id}.
        slots:
          id: path.grantLoginId
      - text: Revoke login grant {id} now.
        slots:
          id: path.grantLoginId
      method: generated
      generated: '2026-10-01'