Picus Security · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Picus Customer API — Users

9 actions 9 updates update extends openapi/picus-security-users-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-summaryexternalDocscontactx-apievangelist-providerx-apievangelist-harvested-fromx-apievangelist-harvestedx-apievangelist-tagx-apievangelist-artifacts

Targets 9

$.info

$.tags[?(@.name=='Users')]

$.securityDefinitions.Access-Token

$.paths['/v1/users'].get

$.paths['/v1/users/invite'].post

$.paths['/v1/users/roles'].get

$.paths['/v1/users/{userId}'].delete

$.paths['/v1/users/{userId}/role'].put

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Picus Customer API — Users
  version: 1.0.0
extends: openapi/picus-security-users-openapi.yml
x-generated: '2026-08-02'
x-method: generated
x-source: openapi/_original/picus-security-openapi.json
actions:
- target: $.info
  update:
    contact:
      name: Picus Security Support
      url: https://support.picussecurity.com/
      email: info@picussecurity.com
    x-apievangelist-provider: picus-security
    x-apievangelist-harvested-from: https://api.picussecurity.com/swagger.json
    x-apievangelist-harvested: '2026-08-02'
    x-apievangelist-tag: Users
    x-apievangelist-artifacts:
      authentication: authentication/picus-security-authentication.yml
      conventions: conventions/picus-security-conventions.yml
      errors: errors/picus-security-problem-types.yml
      rate_limits: rate-limits/picus-security-rate-limits.yml
      lifecycle: lifecycle/picus-security-lifecycle.yml
      data_model: data-model/picus-security-data-model.yml
      conformance: conformance/picus-security-conformance.yml
- target: $
  update:
    externalDocs:
      description: Picus Customer API documentation
      url: https://apidocs.picussecurity.com/
- target: $.tags[?(@.name=='Users')]
  update:
    externalDocs:
      description: Picus Customer API reference
      url: https://apidocs.picussecurity.com/reference/intro-to-the-picus-customer-api
- target: $.securityDefinitions.Access-Token
  update:
    x-token-endpoint: POST https://api.picussecurity.com/v1/auth/token
    x-token-ttl: 2 hours
    x-refresh-token-ttl: 6 months
    x-refresh-token-source: app.picussecurity.com > Settings > Rest API Token
    x-token-scoped: true
- target: $.paths['/v1/users'].get
  update:
    x-apievangelist-summary: Get Users
  description: Published summary carries a leading markdown "#"; this records the cleaned title without mutating the harvested
    spec.
- target: $.paths['/v1/users/invite'].post
  update:
    x-apievangelist-summary: Invite User
  description: Published summary carries a leading markdown "#"; this records the cleaned title without mutating the harvested
    spec.
- target: $.paths['/v1/users/roles'].get
  update:
    x-apievangelist-summary: Get Roles
  description: Published summary carries a leading markdown "#"; this records the cleaned title without mutating the harvested
    spec.
- target: $.paths['/v1/users/{userId}'].delete
  update:
    x-apievangelist-summary: Delete User
  description: Published summary carries a leading markdown "#"; this records the cleaned title without mutating the harvested
    spec.
- target: $.paths['/v1/users/{userId}/role'].put
  update:
    x-apievangelist-summary: Assign Role
  description: Published summary carries a leading markdown "#"; this records the cleaned title without mutating the harvested
    spec.