What would you like to know more about?

Show Page Sections

API Procedures

  • Call and test API Procedures using the MinistryPlatform REST API. Security Roles control which procedures can be accessed by which users.
  • The Administrator's Security Role has all API Procedures included. We recommend that you do not edit or remove API Procedures from the Administrator's Security Role.

Add API Procedures to a Security Role

  1. Go to Administration > Security Role.
  2. Open an existing Security Role, or create a new security role, name it, and save it.
  3. Click the API Procedures sub-page to assign the appropriate security rights.
  4. Click Add.
    A pop-up window displays containing all API Procedures.
  5. Select any appropriate boxes to allow the Security Role to access these tools.
  6. Click Save.

Remove API Procedures from a Security Role

  1. Go to Administration > Security Role.
  2. Open the Security Role.
  3. Make sure you have no selections.
  4. On the API Procedures sub-page, select the procedures you want to remove.
  5. Change the selection to Current or Unsaved Selection.
  6. Click Delete, and confirm deletion.