apiserver-swagger.json

{
  "x-generator": "NSwag v13.14.8.0 (NJsonSchema v10.5.2.0 (Newtonsoft.Json v13.0.0.0))",
  "openapi": "3.0.0",
  "info": {
    "title": "Laserfiche Repository API",
    "description": "Welcome to the Laserfiche API Swagger Playground. You can try out any of our API calls against your live Laserfiche Cloud account. Visit the developer center for more details: <a href=\"https://developer.laserfiche.com\">https://developer.laserfiche.com</a><p>Visit the changelog for the list of changes: <a href=\"/LFRepositoryAPI/v1/changelog\">/LFRepositoryAPI/v1/changelog</a></p><p><strong>Build# : </strong>1.0.0.21</p>",
    "version": "1"
  },
  "paths": {
    "/v1/Repositories/{repoId}/Token": {
      "post": {
        "tags": [
          "Token"
        ],
        "summary": "Request for an access token.\n- Creates an access token for use with the Laserfiche API.\n- Provides credentials and uses the access token returned with subsequent API calls as a means of authorization.\n- For authentication with password, username and password are required and grant_type must be 'password'.\n- Only available in Laserfiche Self-hosted.",
        "description": "- Creates an access token for use with the Laserfiche API.\n- Provides credentials and uses the access token returned with subsequent API calls as a means of authorization.\n- For authentication with password, username and password are required and grant_type must be 'password'.\n- Only available in Laserfiche Self-hosted.",
        "operationId": "CreateAccessToken",
        "parameters": [
          {
            "name": "repoId",
            "in": "path",
            "required": true,
            "description": "The requested repository ID.",
            "schema": {
              "type": "string"
            },
            "x-position": 1
          }
        ],
        "requestBody": {
          "x-name": "body",
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "title": "CreateConnectionRequest",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "grant_type"
                ],
                "properties": {
                  "grant_type": {
                    "type": "string",
                    "description": "The value MUST be \"password\".",
                    "minLength": 1
                  },
                  "username": {
                    "type": [
                      "null",
                      "string"
                    ],
                    "description": "The username used with \"password\" grant type."
                  },
                  "password": {
                    "type": [
                      "null",
                      "string"
                    ],
                    "description": "The password used with \"password\" grant type."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Create an access token successfuly.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionKeyInfo"
                }
              }
            }
          },
          "400": {
            "description": "Invalid or bad request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Access token is invalid or expired.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Access denied for the operation.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Rate limit is reached.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProblemDetails": {
        "type": "object",
        "additionalProperties": {
          "nullable": true
        },
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          },
          "extensions": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "SessionKeyInfo": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "access_token": {
            "type": "string",
            "description": "The access token that can be used to authenticate with the repository apis.",
            "nullable": true
          },
          "token_type": {
            "type": "string",
            "description": "The token type that provides how to utilize the access token.",
            "nullable": true
          },
          "expire_in": {
            "type": "integer",
            "description": "The lifetime in seconds of the access token.",
            "format": "int32"
          }
        }
      }
    },
    "securitySchemes": {
      "Authorization": {
        "type": "http",
        "description": "Type your token into the textbox.",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ]
}