Authz1 Entitlements API OpenAPI Spec (YAML)

openapi: 3.0.1
info:
  title: Authz1 Entitlements API
  description: Authz1 Entitlements API
  termsOfService: http://authz1.com/terms/
  contact:
    name: Authz1 Support
    url: http://www.authz1.com/contact
    email: support@authz1.com
  license:
    name: Authz1 Intellectual Property
    url: https://www.authz1.com
  version: 2.0.1
servers:
  - url: https://sandbox.authz1.com/v1
    description: Sandbox server
paths:
  /entitlements:
    get:
      description: >-
        Returns the entitlements for the subject with the ID passed in the
        request
      operationId: getEntitlementsBySubjectId
      parameters:
        - name: subjectId
          in: query
          description: The ID of the subject
          required: true
          schema:
            type: string
        - name: actionId
          in: query
          description: The ID of the action
          required: false
          schema:
            type: string
        - name: resourceId
          in: query
          description: The ID of the resource
          required: false
          schema:
            type: string
      responses:
        '200':
          description: List of entitlements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entitlementsResponse'
        '400':
          description: Bad Request
          content:
            application/json: {}
        '404':
          description: Not Found
          content:
            application/json: {}
        '500':
          description: Internal Server Error
          content:
            application/json: {}
components:
  schemas:
    entitlementsResponse:
      type: object
      properties:
        subjectId:
          type: string
        policies:
          type: array
          items:
            $ref: '#/components/schemas/policyComplexType'
    policyComplexType:
      type: object
      properties:
        access:
          type: string
        scope:
          type: string
        policy:
          $ref: '#/components/schemas/policy'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/action'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/resource'
    policy:
      type: object
      properties:
        policyId:
          type: string
        createdDate:
          type: string
        createdBy:
          type: string
        modifiedDate:
          type: string
        modifiedBy:
          type: string
        active:
          type: boolean
    action:
      type: object
      properties:
        actionId:
          type: string
        name:
          type: string
        description:
          type: string
        createdDate:
          type: string
        createdBy:
          type: string
        modifiedDate:
          type: string
        modifiedBy:
          type: string
        active:
          type: boolean
        enabled:
          type: boolean
    resource:
      type: object
      properties:
        resourceId:
          type: string
        createdDate:
          type: string
        createdBy:
          type: string
        modifiedDate:
          type: string
        modifiedBy:
          type: string
        active:
          type: boolean
        enabled:
          type: boolean