swagger-2.3.1.json

{
  "swagger": "2.0",
  "info": {
    "title": "Authorization Rules Service API",
    "version": "1.2"
  },
  "basePath": "/rules/v1",
  "paths": {
    "/getAuthorizations": {
      "post": {
        "tags": [
          "Authorization Rules Service"
        ],
        "summary": "Get authorizations based on the passed in values and the rules.",
        "operationId": "getAuthorizations",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "body",
            "required": true,
            "in": "body",
            "schema": {
              "$ref": "#/definitions/RulesUser"
            }
          }],
        "responses": {
          "200": {
            "description": "Authorization details created from rules",
            "schema": {
              "$ref": "#/definitions/RulesUser"
            }
          },
          "404": {
            "description": "not found"
          }
        }
      }
    },
    "/getLoadedRules": {
      "get": {
        "tags": [
          "Authorization Rules Service"
        ],
        "summary": "Get the rules currently loaded in the rules ingine.",
        "operationId": "getLoadedRules",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Authorization details created from rules",
             "schema": {
                 "type": "array",
                 "items": {
                   "type": "string"
                 }
             }
          },
          "404": {
            "description": "not found"
          }
        }
      }
    }
  },
  "definitions": {
    "Error": {
      "type": "object",
      "required": [
        "id",
        "message"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The error id",
          "example": "7edd38ae-d9b3-4ef9-bf58-598e1784d407"
        },
        "message": {
          "type": "string",
          "description": "The error message"
        }
      }
    },
    "RulesUser": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "idType": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "firstName": {
          "type": "string"
        },
        "middleName": {
          "type": "string"
        },
        "levelOfAssurance": {
          "type": "integer",
          "description": "Level of Assurance (Identity Proofing Level)"
        },
        "authenticationAuthority": {
          "type": "string"
        },
        "authenticationMethod": {
          "type": "string"
        },
        "source": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "accessCode": {
          "type": "string"
        },
        "staffUserDisclaimerAccepted": {
          "type": "boolean",
          "default": true
        },
        "authorizedRoles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedGetResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedPostResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedPutResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedAllResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedDeleteResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedPatchResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedOptionsResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorizedHeadResources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "attributes": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "additionalAttributes": {
          "type": "object",
          "additionalProperties" : {
            "type": "string"
          }
        },
        "patient": {
          "$ref": "#/definitions/Patient"
        },
        "authenticated": {
          "type": "boolean"
        },
        "rightOfAccessAccepted": {
          "type": "boolean",
          "default": true
        },
        "contextHeaders": {
          "$ref": "#/definitions/ContextHeaders"
        },
        "supportsSsoe": {
          "type": "boolean",
          "default": false
        },
        "securityAndPrincipalExist": {
          "type": "boolean"
        }
      }
    },
    "Patient": {
      "type": "object",
      "properties": {
        "lastName": {
          "type": "string"
        },
        "firstName": {
          "type": "string"
        },
        "middleName": {
          "type": "string"
        },
        "edipid": {
          "type": "string"
        },
        "icn": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "dob": {
          "type": "string"
        },
        "ssn": {
          "type": "string"
        }
      }
    },
    "ContextHeaders" : {
      "type" : "object",
      "additionalProperties" : {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  }
}