Share private methods to registered users

Share private methods to registered users

Summary

When you have defined your methods with Private visibility, you shouldshare with registered developers who must haveaccess to the method.




Share access

Methods can be protected by Keys API or the OAuth2.0 protocol.

Methods protected by Keys API

To share access to a method, you should click on the lock icon shown when selecting a method from the API list:

A window would open, where the username or email of the developer to whom access the method would be granted. Type the developer user name, learn enter, and then click Save.

You can also share the methods per role. For example, you can share the methods for all Editors in your account.

If you want to revoke access to the method, you should open the window again and click Delete, and then click Save.


Methods protected by OAuth2.0


If the method is protected by OAuth2.0, it should select what application of each of the registered users and with whom you want to share access.



    • Related Articles

    • Manage users

      Summary Vor-Tex uses the assignment of user roles so that the account administrators have the ability to control what Users can and cannot do. For more information read the article User roles. To manage users of your account you must go to Settings > ...
    • Configure APIs and Methods Privacy

      Summary You can define the privacy of your APIs and methods to grant access only to users you want, or revoke accesses when you require it. Privacy rules You can set up the visibility of APIs and methods, i.e. whether they would be public or private. ...
    • Create APIs methods

      Summary In the article Create and manage APIs versions The first necessary steps to create APIs were shown. Methods define the action to be taken on a particular esource. As a first step you should select the option of Add Methodin the API. Add ...
    • Method defining routes to methods: good practices

      Summary Definition of routes orpathsmust be consistent with the resources or entities to which the method refers. Certain good practices for considering in defining routes. A review Before proceeding, let's look at what parts of an endpoint or url. ...
    • Method define response formats for methods

      Summary Output formats allow you to define one or more response formats in your API methods. Output formats can be multiple in JSON format, although it can also expose the data in CSV and XML. Configure formats When creating a method you should ...