Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata HRIS User Identities API

5 actions 5 updates phrasing extends openapi/drata-hris-user-identities-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Drata's API. It is a proposal applied on top of the contract, not a document Drata publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/custom-connections/{connectionId}/hris-user-identities'].get
$.paths['/custom-connections/{connectionId}/hris-user-identities'].post
$.paths['/custom-connections/{connectionId}/hris-user-identities/{userIdentityId}'].get
$.paths['/custom-connections/{connectionId}/hris-user-identities/{userIdentityId}'].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 Drata HRIS User Identities API
  version: 1.0.0
extends: openapi/drata-hris-user-identities-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: 4
- target: $.paths['/custom-connections/{connectionId}/hris-user-identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List HRIS user identities
      effect: read
      questions:
      - Which HR user identities are active on my custom HRIS connection?
      - Can I page through every employee identity a custom HRIS connection holds?
      instructions:
      - text: List HRIS user identities for connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Show {size} HR identities per page from custom HRIS connection {connectionId}.
        slots:
          connectionId: path.connectionId
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/hris-user-identities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update HRIS user identities
      effect: write
      questions:
      - How do I push employee records into a custom HRIS connection?
      - Does sending an identity with an existing identityId update it instead of duplicating?
      instructions:
      - text: Upsert HR user identities into custom HRIS connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Sync our latest employee identities to HRIS connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/hris-user-identities/{userIdentityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an HRIS user identity
      effect: read
      questions:
      - Can I look up one HR identity using our own employee identityId?
      - What does a single HRIS user identity record contain?
      instructions:
      - text: Get HR identity {userIdentityId} from connection {connectionId}.
        slots:
          connectionId: path.connectionId
          userIdentityId: path.userIdentityId
      - text: Show the HRIS user identity {userIdentityId} on custom connection {connectionId}.
        slots:
          connectionId: path.connectionId
          userIdentityId: path.userIdentityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/hris-user-identities/{userIdentityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an HRIS user identity
      effect: destructive
      questions:
      - How do I remove an employee identity from a custom HRIS connection?
      - Is deleting an HRIS user identity a soft delete?
      instructions:
      - text: Delete HR identity {userIdentityId} from connection {connectionId}.
        slots:
          connectionId: path.connectionId
          userIdentityId: path.userIdentityId
      - text: Remove HRIS user identity {userIdentityId} on custom connection {connectionId}.
        slots:
          connectionId: path.connectionId
          userIdentityId: path.userIdentityId
      method: generated
      generated: '2026-09-26'