Class: MojioAuthSDK

A method that authorizes access to a user's data. There are two ways to authorize users, depending on whether the application is designed to be used by a consumer, or it is designed as a server that users trust to act on their behalf. Generally, this devides into two camps, client applications for consumers or server applications for enterprise applications. For client applications, the user is redirected to mojio's authorization server which will collect the user's password outside the application so that the user can give permission to or revoke permission from the application to use their data. For enterprise or server side applications, the user's password is known to the application and can be sent directly to the authorization server for verification. In both cases, the authorization server will return a token that will be used to access the user's data.

to the authorization server within a browser and returns a token in a document. app.get('/authCode', (req, res) ->

# step 1 of authorization code workflow.
sdk
.authorize(redirect_uri)
.scope(['full'])
.redirect(res)

)

sdk
  .authorize(redirect_uri)
  .scope(['full'])
  .redirect( { redirect: (url) -> window.location = url } )

A method that un-authorizes access to a user's data, removing grants to data. Parameters to this function oauth page retrieved as a result of the prompt specified.

sdk.unauthorize("http://localhost:3000/callback").login().callback(...)

sdk.unauthorize("http://localhost:3000/callback").login().consent().callback(...)

A method that returns an authorization token after authorization has returned a code. Used in combination with 'parse', 'refresh', and 'password' to implement completion of an authorization workflow. Parse is used in conjunction with code and implicit flows, call authorize first, then after the redirect call token().parse(response). Password with token implements the 'password' authorization flow for server based authorization where the server is also the owner of the resources (the user account that will be accessing the vehicles, mojios, and trips for that user account and no one else). This would be token().password('username', 'password') and is done without a prior 'authorize' call. Refresh is used to refresh already active tokens, giving them an extended expiration timespan, token().refresh().

sdk.token().parse(document.location.hash.match(/access_token=([0-9a-f-]{36})/)) )

sdk.token().parse(response).callback(...)

sdk.token().refresh().callback(...)

sdk.token().refresh(some_token_object).callback(...)

second half of authorization code flow, or parse of the return from the implicit flow

the authorization token returned from the authorization workflow is an object that has several fields, one of which is labeled "refresh_token". All of this is cached in the sdk, but you can pass a valid refresh token in, a in a new token will be returned.

sdk.token().parse(document.location.hash.match(/access_token=([0-9a-f-]{36})/)) )

sdk.token().parse(response).callback(...)

A method that refreshes an authorization token, gives it more active time. Actually, a new token is returned when a refresh call is made.

the authorization token returned from the authorization workflow is an object that has several fields, one of which is labeled "refresh_token". All of this is cached in the sdk, but you can pass a valid refresh token in, a in a new token will be returned.

sdk.token("http://localhost:3000/callback").refresh().callback(...)

A method that specifies that when unauthorize is initiated, the user should be logged out of the application. The application will still have permission to access the user's resources when they log in again with 'authorize'.

sdk.unauthorize("http://localhost:3000/callback").login().callback(...)

A method that specifies that when unauthorize is initiated, the application will no longer have access to the user's resources.

sdk.unauthorize("http://localhost:3000/callback").loginAndConsent().callback(...)

A method that specifies that when unauthorize is initiated, the user should be logged out. The application will also be denied permission to access the user's resources when they log in again with 'authorize' unless permission is given by the user again. sdk.unauthorize("http://localhost:3000/callback").loginAndConsent().callback(...)

A helper method to set the body of the REST uri for login and consent calls. Can be used instead of login, consent, or loginAndConsent calls

sdk.unauthorize("http://localhost:3000/callback").prompt({prompt: 'consent, login'}).callback(...)
sdk.unauthorize("http://localhost:3000/callback").prompt('consent, login').callback(...)
sdk.unauthorize("http://localhost:3000/callback").prompt(['consent', 'login']).callback(...)
sdk.unauthorize("http://localhost:3000/callback").prompt('login').callback(...)

Set the scope of the authorization workflow. The user will be asked for consent of the given 'scope' for the application to have access to their resources.

Set the username for a server side, resource owner 'password' authorization workflow.

Set the email for a server side, resource owner 'password' authorization workflow.

Set the password for a server side, resource owner 'password' authorization workflow.

This call is used to specify both username and password for an authorization workflow. username. In the case of an object, it's both username and password given in the following format: {username: '', password: ''}

Synonym for the credentials() call. username. In the case of an object, it's both username and password given in the following format: {username: '', password: ''}