Fipto - OpenAPI 3.0
1.2.2

This is a REST API specifications based on OpenAPI 3.0 for Fipto solution.

This is the documentation for version 1.2.2 of the API. Last update on Aug 30, 2023.

Base URL 
https://api.fipto.app

Create an API user

POST /companies/{company_id}/users

Create an API user for a company.

Path parameters

  • company_id string Required

    The Company ID given by Fipto.

    Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

application/json

Body

  • data object Required

    Role associated to a company user

    Hide data attributes Show data attributes

Responses

  • • 201

    User successfully created

    Hide response attributes Show response attributes object
    • meta object Required
      Hide meta attributes Show meta attributes
      • request_id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • query_parameters object

        Information about the parameters in the request. All query string parameters provided (or implicit/with default value) will be returned

    • data object Required

      Role associated to a company user

      Hide data attributes Show data attributes
      • id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • type string Required

        Value is user.

      • attributes object Required
        Hide attributes attributes Show attributes attributes
POST /companies/{company_id}/users 
curl \
 -X POST https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/users \
 -H "Content-Type: application/json" \
 -d '{"data":{"type":"user","attributes":{"status":"active","whitelisted_ips":["string"],"public_key":"-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx5ENo5B+OJn92GpUn4qm\ni0m5c3scBfoowMLZlSa5q1lnaEfp7eiI1rNemcH8djt7d2T/YzWIsYywmwtzhQjw\nCxJtRFGGhTk6oFLgCGClwKi3SRODgZYyLGXgqKYstbODX5LDefY/SIqB4o7T3Asu\nd2aYu2pXmeiJYOsHf8S16e1+J2uDgsuPpLc+E4NGZTJ9KcqgV/PuOkqDlFpMSo5l\nTF/OBqRtcO8om2wILgPk8GvEqb7xjptwuqEkyvTZE+sKXDffPlwBqkhGLGEMe1vR\nnzBptA+DxeSIyxXPRYcAdHEWKKUu8gZeVrUl1QDsv68ubqruVfNrdtujMPrhPqcE\nVQIDAQAB\n-----END PUBLIC KEY-----\n","name":"Johnny Nguyen","roles":["admin"]}}}'
Request example 
{
  "data": {
    "type": "user",
    "attributes": {
      "status": "active",
      "whitelisted_ips": [
        "string"
      ],
      "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx5ENo5B+OJn92GpUn4qm\ni0m5c3scBfoowMLZlSa5q1lnaEfp7eiI1rNemcH8djt7d2T/YzWIsYywmwtzhQjw\nCxJtRFGGhTk6oFLgCGClwKi3SRODgZYyLGXgqKYstbODX5LDefY/SIqB4o7T3Asu\nd2aYu2pXmeiJYOsHf8S16e1+J2uDgsuPpLc+E4NGZTJ9KcqgV/PuOkqDlFpMSo5l\nTF/OBqRtcO8om2wILgPk8GvEqb7xjptwuqEkyvTZE+sKXDffPlwBqkhGLGEMe1vR\nnzBptA+DxeSIyxXPRYcAdHEWKKUu8gZeVrUl1QDsv68ubqruVfNrdtujMPrhPqcE\nVQIDAQAB\n-----END PUBLIC KEY-----\n",
      "name": "Johnny Nguyen",
      "roles": [
        "admin"
      ]
    }
  }
}
Response examples (201) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "id": "string",
    "type": "user",
    "attributes": {
      "status": "active",
      "whitelisted_ips": [
        "string"
      ],
      "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx5ENo5B+OJn92GpUn4qm\ni0m5c3scBfoowMLZlSa5q1lnaEfp7eiI1rNemcH8djt7d2T/YzWIsYywmwtzhQjw\nCxJtRFGGhTk6oFLgCGClwKi3SRODgZYyLGXgqKYstbODX5LDefY/SIqB4o7T3Asu\nd2aYu2pXmeiJYOsHf8S16e1+J2uDgsuPpLc+E4NGZTJ9KcqgV/PuOkqDlFpMSo5l\nTF/OBqRtcO8om2wILgPk8GvEqb7xjptwuqEkyvTZE+sKXDffPlwBqkhGLGEMe1vR\nnzBptA+DxeSIyxXPRYcAdHEWKKUu8gZeVrUl1QDsv68ubqruVfNrdtujMPrhPqcE\nVQIDAQAB\n-----END PUBLIC KEY-----\n",
      "name": "Johnny Nguyen",
      "roles": [
        "admin"
      ]
    }
  }
}