Update README.md Project: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/repo Commit: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/commit/b9b0dc71 Tree: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/tree/b9b0dc71 Diff: http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/diff/b9b0dc71
Branch: refs/heads/master Commit: b9b0dc7157dcbe5c231258ab37bf1781ecb1972e Parents: 9af775e Author: Robert Walsh <[email protected]> Authored: Wed Nov 9 19:37:54 2016 -0600 Committer: GitHub <[email protected]> Committed: Wed Nov 9 19:37:54 2016 -0600 ---------------------------------------------------------------------- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/usergrid-nodejs/blob/b9b0dc71/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index a21f724..dac9b75 100644 --- a/README.md +++ b/README.md @@ -276,7 +276,7 @@ entity.remove(function(error, usergridResponse) { }) ``` -## Authentication, current user, and auth-mode +## Authentication, current user, and authMode ### appAuth and authenticateApp() @@ -315,7 +315,13 @@ Usergrid.authenticateUser({ ### authMode -Auth-mode defines what the client should do when a user token is not present. By default, `Usergrid.authMode` is set to `UsergridAuth.AUTH_MODE_NONE`, whereby when a token is *not* present, an API call will be performed unauthenticated. If instead `Usergrid.authMode` is set to `UsergridAuth.AUTH_MODE_APP`, the API call will instead be performed using client credentials, _if_ they're available (i.e. `authenticateApp()` was performed at some point). +Auth-mode is used to determine what the `UsergridClient` will use for authorization. + +By default, `Usergrid.authMode` is set to `UsergridAuth.AUTH_MODE_USER`, whereby if a non-expired `UsergridUserAuth` exists in `UsergridClient.currentUser`, this token is used to authenticate all API calls. + +If instead `Usergrid.authMode` is set to `UsergridAuth.AUTH_MODE_NONE`, all API calls will be performed unauthenticated. + +If instead `Usergrid.authMode` is set to `UsergridAuth.AUTH_MODE_APP`, all API calls will be performed using the client credentials token, _if_ they're available (i.e. `authenticateApp()` was performed at some point). ### usingAuth()
