Skip to content

security-json.md

Latest commit

 

History

History
45 lines (35 loc) · 1.27 KB

security-json.md

File metadata and controls

45 lines (35 loc) · 1.27 KB

security.json

security.json is the file the deployer uses to push API credentials along with the serverless function.

Has two fields:

  • apiCredentials: Keeps the values of the security scheme parameters and the necessary fields to identify them
  • id: A UUID defined by the platform for this specific deployment (matches the corresponding id from config.json)

apiCredentials

An example:

{
  "myOisTitle": [
    {
      "securitySchemeName": "mySecurityScheme",
      "value": "mysupersecretkey"
    }
  ]
}

The user flow

Here is an example security.json file that is generated by a third party (e.g., an integration platform):

{
  "apiCredentials": {
    "myOisTitle": [
      {
        "securitySchemeName": "mySecurityScheme",
        "value": "<TO_BE_FILLED>"
      }
    ]
  },
  "id": "9a52131e-babd-11ea-b3de-0242ac130004"
}

The first option here is for the user to open security.json and replace <TO_BE_FILLED> with their API key. Alternatively, the user may directly attempt to deploy with security.json and the corresponding config.json (which has the same id), where the deployment script parses security.json and asks for the user to provide the values of each of the security credentials.

Home