Unqork Authentication API

openapi: 3.2.0
info:
  version: 1.0.0
  x-logo:
    url: https://developers.unqork.io/unqork-logo.png
    backgroundColor: '#FFFFFF'
  title: Unqork Customer Authentication API
  description: "\nUnqork's customer REST API, based on open standards, allows you to set and retrieve module submission data, as well as control other aspects of your Unqork environment. You can use any web development language to access the API, as communication is over secured HTTP.\n## URI Structure and Methods\nAll API communication will occur over SSL (HTTPS). All API responses are in JSON format.\nAll Unqork requests begin with the prefix:\n\n```\n  https://{yourSubdomain}.unqork.io/api/1.0\n```\n\nFor example, if your subdomain is **xyzfinancial**, you would use the prefix `https://xyzfinancial.unqork.io/api/1.0`.\n\nThe next segment of the URI path will vary based on the endpoint of the request.\n\nA given endpoint (resource) has a series of actions (methods) associated with it. The Unqork API supports these standard HTTP methods:\n\n- **GET** - retrieves data\n\n- **PUT** - updates existing data\n\n- **POST** - creates new data\n\n- **DELETE** - deletes existing data\n\nFor example, you can use the POST action on the module submission resource to create a new module submission.\n## Paging\nPaged endpoints use the [Link header](https://www.w3.org/wiki/LinkHeader). If the link header \"next\" is present, then there are more items to retrieve, and the \"next\" should be followed.\n## Cloud Storage Delivery\nUnqork exposes generated PDFs, uploaded attachments, and other file-like pieces of submission data via Cloud Storage Delivery URLs. These are signed, expiring links that allow the user to securely retrieve files stored in Unqork. Links can appear inside raw submission data, or they can be returned from PDF transform submission endpoints.\n\nThese links cannot be shared with other parties; only the user who generates the unique link (by either submitting the file or accessing the submission where the file has been saved) will be able to use that specifically generated link. This means that the user must be authenticated (either in the browser, or by passing a valid OAuth Bearer token) in order to retrieve the file.\n\nCloud Storage Delivery URLs will look like this:\n\n`https://xyzfinancial.unqork.io/fbu/files/{filePath}?signature={signature}`\n\nThe file can be retrieved by accessing the link in the browser, or like this:\n\n```\n  $ curl -H \"Authorization: Bearer {access_token}\" https://xyzfinancial.unqork.io/fbu/files/{filePath}?signature={signature}\n```\n## Nomenclature\nPreviously, \"Modules\" were called \"Forms\". This nomenclature change affects all endpoints documented here in paths, request parameters, and response bodies (e.g. `forms -> modules`, `formId -> moduleId`; however, the behaviors of the endpoints are the same. The previous endpoints will continue to be supported, but they will be deprecated in the future.\n## API Access Notes\n#### Express Module and Workflow Access <a name=\"express-module-workflow-access\"></a>\nExpress Module and Workflow Access is determined by a User's Role and the Module's permissions. An Express User's Role is specified at the environment level, but can be overwritten at the Application level using Application Roles. If Module Permissions are used, the permission settings will specify what access (Read, Write, Obfuscate, or None) a User will have to the Module. Anonymous Users may also be able to access a Module if the permission settings allow it.\n#### Submission Access <a name=\"submission-access\"></a>\nSubmission Access is determined by a User's Role, Groups, and if they are the owner of the Submission. A Submission owner is the user that created or updated the Submission. If a user is a Submission owner, Designer Administrator, or an Express Super User, the user has access to the Submission. If the User does not have access to the Module or Workflow that the Submission is associated with, then the User will not have access to the Submission. See Express Module and Workflow Access ([Express Module and Workflow Access](#express-module-workflow-access)). A User's Role Groups can also provide a User Access to a Submission. A User needs to have Intersecting Groups with the Submission Owner. Intersecting Groups means a User has a Role with a Group (Groups assigned directly to the User do not count) that is in the Submission owner's groups (the Submission owners Role Groups or the Submission owners User Groups). If a User has Intersecting Groups:\n- And the Group type is ignore role, a User that has Intersecting Groups can access the Submission.\n- And the Group type is Role descendents, a User that has Intersecting Groups and the Submission owner's Role is a descendant of the User's Role then the User can access the Submission.\n- And the Group type is own Role and descendents, a User that has Intersecting Groups and the Submission owner's Role is a descendent of the User's Role or the User's Role is the same as the Submission owner's Role then the User can access the Submission.\n"
servers:
- url: https://{host}/api/1.0
  variables:
    host:
      default: env.unqork.io
      description: Environment host
security:
- OAuth2: []
tags:
- name: Authentication
paths:
  /referstring:
    post:
      x-unqork-service: true
      tags:
      - Authentication
      summary: Generates an encrypted referstring for authentication
      operationId: generateReferString
      description: "This endpoint will generate encrypted refer strings that can be used to authenticate users into an Unqork environment\n\n Environment Variables - The following Environment Variables are required\n - key : key for encryption\n - cipher : method of encryption. The default and recommended cipher is aes-256-gcm.\n\n Include this refer string in the link to an Unqork resource as follows\n   ```\n   <hostname>?refer=<referString>/#/display/<resource_id>\n   ```\n   - hostname - host name of Unqork server\n   - referString - referString returned from API\n   - resource_id - Id of the Unqork resource to viewFor example, https://client.unqork.io?refer=<referString>/#/display/abcd123\n\n Examples\n\n   Example 1: Generate Refer String for 1 day (default role)\n\n   Request\n\n   ```\n    {\n      \"userId\": \"user123\",\n      \"expireOffset\": 1,\n      \"expireMeasure\": \"days\"\n    }\n   ```\n\n   Response\n\n   ```\n    {\n      \"referString\": \"<encrypted refer string>\"\n    }\n   ```\n   Example 2: Generate Refer String for single use (recommended)\n\n   Request\n\n   ```\n    {\n      \"userId\": \"user123\",\n      \"expireOffset\": 1,\n      \"expireMeasure\": \"days\",\n      \"oneTimeUse\": true\n    }\n   ```\n\n   Response\n\n   ```\n    {\n      \"referString\": \"<encrypted refer string>\"\n    }\n   ```\n\n   Example 3: Generate Refer String for custom role\n\n   Request\n  ```\n    {\n      \"userId\": \"user123\",\n      \"expireOffset\": 1,\n      \"expireMeasure\": \"days\",\n      \"additionalParams\": {\n        \"role\": \"customRole\"\n      }\n    }\n  ```\n\n   Response\n  ```\n    {\n      \"referString\": \"<encrypted refer string>\"\n    }\n  ```\n\n   Example 4: Generate Refer String with custom user parameters\n\n   Request\n  ```\n    {\n      \"userId\": \"user123\",\n      \"expireOffset\": 1,\n      \"expireMeasure\": \"days\",\n      \"additionalParams\": {\n        \"custom1\": \"custom value 1\",\n        \"custom1\": \"custom value 2\",\n        \"custom1\": \"custom value 3\"\n      }\n    }\n  ```\n\n   Response\n  ```\n    {\n      \"referString\": \"<encrypted refer string>\"\n    }\n  ```\n### Authorization Required:\n  - Designer Administrator\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferStringRequest'
      responses:
        '200':
          description: Successful Generation
          content:
            application/json:
              schema:
                type: object
                required:
                - referString
                properties:
                  referString:
                    description: The encrypted refer string containing user information
                    type: string
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ReferStringRequest:
      type: object
      required:
      - userId
      properties:
        userId:
          type: string
          description: Unique ID of the user, as a string
        expireOffset:
          type: integer
          description: Provides an amount of time until expiry, used in conjunction with the units from expireMeasure. Maximum offset 30 days or equivalent. Default offset 1 (default unit is hours).
        expireMeasure:
          type: string
          description: String with the units for the expireOffset parameter (e.g. hours, days). Maximum offset 30 days or equivalent. Default measure hours (Default offset is 1)
        oneTimeUse:
          type: boolean
          description: Whether to limit the refer string to one use. For best security, it is recommended to set `oneTimeUse` to `true`.
        additionalParams:
          type: object
          description: An object with anything else to be added to referstring
    Error:
      type: object
      description: Error
      required:
      - code
      - message
      properties:
        code:
          description: HTTP status code
          type: integer
          format: int32
          enum:
          - 400
          - 401
          - 403
          - 404
          - 412
          - 500
        message:
          description: Error message
          type: string
  securitySchemes:
    OAuth2:
      description: "The Unqork API implements the [OAuth 2.0 Client Credentials Grant](https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.4) and the [OAuth 2.0 Password Grant](https://tools.ietf.org/html/rfc6749#section-1.3.3). Access via OAuth2 Client Credentials Grant can be utilized by creating Client Credentials through the API Access Management Administration page. Access via OAuth2 Password Grant can be enabled for all users in Environment Administration. Once OAuth2 Password Grant is enabled, all Unqork users can use their Unqork username/password to retrieve an access token.\n\nIn order to utilize any of the API resources, you must first retrieve an access token by POSTing your credentials to the access token URL, e.g. using `curl`:\n```\n  $ curl -u '{clientId}:{clientSecret}' -X POST --basic https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token -d \"grant_type=client_credentials\"\n```\nOr:\n```\n  $ curl -X POST https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token -d \"grant_type=password&username={username}&password={password}\"\n```\nThis returns an \"access_token\", which you would then retain and use in any subsequent resource requests. **Access tokens expire after one hour, at which point you must retrieve a new one.** The access token should be included in a request header:\n```\n  $ curl -H \"Authorization: Bearer {access_token}\" https://xyzfinancial.unqork.io/api/1.0/{endpoint}\n```\n"
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
          scopes:
            none: N/A
        password:
          tokenUrl: https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
          scopes:
            none: N/A