Polished API

Auth API

When using R, the best way to access the Auth API is via the wrapper functions available in polished as of the polished 0.4.0 CRAN release. See the API wrappers vignetteand polished package documentation of each individual wrapper function for details.

If you need to access the JSON HTTP API outside of R, the base API url is:

https://auth-api.polished.tech/v1

All GET and DELETE requests require query parameters arguments, and all POST and PUT request arguments go in the body. All requests must include your polished API secret in the authentication header e.g. curl https://auth-api.polished.tech/v1/apps -u <your Polished API secret>:

The following endpoints are available (click on the endpoints to view the detailed documentation):

• GET /apps
• POST /apps
• PUT /apps
• DELETE /apps

• GET /users
• POST /users
• PUT /users
• DELETE /users

• GET /app-users
• POST /app-users
• PUT /app-users
• DELETE /app-users

• GET /roles
• POST /roles
• DELETE /roles

• GET /user-roles
• POST /user-roles
• DELETE /user-roles

The R wrapper function for each of the above endpoints returns either a data frame or list in R. We represent R data frames and lists as an object of arrays in JSON.

e.g. of a data frame:

{
  "col_1": ["value_1", "value_2"],
  "col_2": ["value_1", "value_2"]
}

e.g. of a list:

{
  "element_1": ["value_1"],
  "element_2": ["value_1", "value_2"]
}

The only difference between polished API lists and data frames in JSON format is that lists can have arrays with differing lengths while the arrays for a data frame will all always be the same length. Click the endpoints above to view the documentation for details on the allowed arguments.