evictionsapi-com Api Keys API

openapi: 3.2.0
info:
  title: Evictionsapi Com Api Keys API
  version: 0.0.0
  contact:
    email: hello@evictionsapi.com
  description: 'Operations tagged Api Keys across 3 of this provider''s published API definitions: api.evictionsapi.com.json, evictionsapi-com-api-evictions-openapi.json, evictionsapi-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.evictionsapi.com
tags:
- name: API Keys
paths:
  /v1/api-keys:
    get:
      summary: List the organization's API keys in the credential's mode, newest first…
      security:
      - ApiKey: []
      - SessionToken: []
      responses:
        '200':
          description: The keys, each with the last four characters of its secret (null for a key created before they were recorded) and when it was revoked, if it was.
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      required:
                      - id
                      - mode
                      - name
                      - createdAt
                      - lastFour
                      - revokedAt
                      properties:
                        id:
                          type: string
                        mode:
                          enum:
                          - test
                          - live
                        name:
                          type:
                          - string
                          - 'null'
                          description: What the key is for, as named when it was created; null without a name.
                        createdAt:
                          type: string
                          format: date-time
                        lastFour:
                          type:
                          - string
                          - 'null'
                        revokedAt:
                          type:
                          - string
                          - 'null'
                          format: date-time
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - API Keys
      operationId: getV1ApiKeys
      x-operation-id-source: derived
    post:
      summary: Create an API key in the credential's mode, optionally with a name.
      security:
      - ApiKey: []
      - SessionToken: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 300
                replaceSameName:
                  type: boolean
              additionalProperties: false
      responses:
        '201':
          description: 'The new key. The secret appears in this response only. An `Idempotency-Key` header is ignored: every request creates a key, and no response is stored or replayed.'
          content:
            application/json:
              schema:
                type: object
                required:
                - id
                - mode
                - name
                - secret
                - replaced
                properties:
                  id:
                    type: string
                  mode:
                    enum:
                    - test
                    - live
                  name:
                    type:
                    - string
                    - 'null'
                  secret:
                    type: string
                    description: The API key (`eak_test_...` or `eak_live_...`), shown here only.
                  replaced:
                    type: array
                    items:
                      type: string
                    description: The ids of the keys revoked by `replaceSameName`; empty otherwise.
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - API Keys
      operationId: postV1ApiKeys
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/api-keys/{id}:
    delete:
      summary: Revoke an API key of the organization and the credential's mode.
      security:
      - ApiKey: []
      - SessionToken: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The key is revoked and no longer authenticates. Revoking a revoked key is also 204.
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - API Keys
      operationId: deleteV1ApiKeysById
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - details
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: An organization API key (`eak_test_...` or `eak_live_...`).
    SessionToken:
      type: http
      scheme: bearer
      description: 'A session token (`ess_...`) from `POST /v1/auth/signup` or `/v1/auth/login`, valid for 30 days. On the case, webhook, API key and organization routes it acts for the organization the session is in (`POST /v1/me/organization` switches it) in the mode named by the `X-Evictions-Mode` header: `test` (the default) or `live`.'
    AttorneyToken:
      type: http
      scheme: bearer
      description: A user token (`eut_...`) of a verified attorney.
externalDocs:
  url: https://evictionsapi.com/docs
x-refined-from:
- api.evictionsapi.com.json
- evictionsapi-com-api-evictions-openapi.json
- evictionsapi-com-openapi.json