lib/client/auth/docs/UserApi.md

1.4 KiB

Auth.UserApi

All URIs are relative to http://auth.vernonkeenan.com:8080/v1

Method HTTP request Description
getUsers GET /users Check API Key

getUsers

UserResponse getUsers(opts)

Check API Key

Checks for a valid API key, and returns full user record

Example

import Auth from 'auth';
let defaultClient = Auth.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new Auth.UserApi();
let opts = {
  'apikey': "apikey_example" // String | Service account or developer API key
};
apiInstance.getUsers(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
apikey String Service account or developer API key [optional]

Return type

UserResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json