xMatters People API

openapi: 3.1.0
info:
  title: xMatters REST Devices People API
  version: '1.0'
  description: 'The xMatters REST API provides programmatic access to people, groups, on-call

    schedules, events, scenarios, and integrations on the xMatters service

    reliability platform. Endpoints derived from the public xMatters REST API

    documentation at help.xmatters.com/xmapi/.

    '
  contact:
    name: xMatters Documentation
    url: https://help.xmatters.com/xmapi/
servers:
- url: https://{company}.{deployment}.xmatters.com/api/xm/1
  description: xMatters tenant deployment
  variables:
    company:
      default: acme
      description: The customer's xMatters subdomain
    deployment:
      default: hosted
      description: Deployment cluster identifier
security:
- BasicAuth: []
- OAuth2: []
tags:
- name: People
paths:
  /people:
    get:
      tags:
      - People
      summary: List people
      operationId: listPeople
      responses:
        '200':
          description: A list of people
    post:
      tags:
      - People
      summary: Create a person
      operationId: createPerson
      responses:
        '201':
          description: Person created
  /people/{personId}:
    get:
      tags:
      - People
      summary: Get a specific person
      operationId: getPerson
      parameters:
      - name: personId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A person
    put:
      tags:
      - People
      summary: Modify a person
      operationId: updatePerson
      parameters:
      - name: personId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated person
    delete:
      tags:
      - People
      summary: Delete a person
      operationId: deletePerson
      parameters:
      - name: personId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
  /people/{personId}/devices:
    get:
      tags:
      - People
      summary: List a person's devices
      operationId: listPersonDevices
      parameters:
      - name: personId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Devices
  /people/{personId}/groups:
    get:
      tags:
      - People
      summary: List a person's group memberships
      operationId: listPersonGroups
      parameters:
      - name: personId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Groups
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using a username and password or API key.
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: https://{company}.{deployment}.xmatters.com/api/xm/1/oauth2/token
          scopes: {}