Auth user

>>>

GET prosper/v1/where_provider_id
Retrieve JSON object of an AuthUser

Read-only method for retrieving an AuthUser object for use by third-party applications to authenticate via an external service (e.g. Google OAuth2) and use those as credentials with this application.

Errors

Code Description
401 Unauthorized
404 Not Found

Params

Param name Description
auth_token
required

UUID Associated with an individual User

Validations:

  • Must be a String
provider
required

Provider value from Omniauth OAuth Gem

Validations:

  • Must be a String
uid
required

UID value from Omniauth OAuth Gem

Validations:

  • Must be a String
>>>

POST prosper/v1/auth_user
Saves and updated attributed on an existing AuthUser object

Required payload is a JSON object with keys of [provider, uid, name, oauth_expires_at, email]. These are obtained from the Omniauth gem.

Errors

Code Description
401 Unauthorized
404 Not Found

Params

Param name Description
auth_token
required

UUID Associated with an individual User

Validations:

  • Must be a String
>>>

GET prosper/v1/register_prosper_state_token
Register and obtain a unique state token for interacting with Prosper OAuth

Registers (saves) and returns an unique string token

Errors

Code Description
401 Unauthorized
404 Not Found

Params

Param name Description
auth_token
required

UUID Associated with an individual User

Validations:

  • Must be a String
auth_hash
optional

AuthUser hash used to pair up the correct User

Validations:

  • Must be a String
>>>

GET prosper/v1/prosper_state_token
Retrieve unique state token for interacting with Prosper OAuth

Returns an existing unique string token

Errors

Code Description
401 Unauthorized
404 Not Found

Params

Param name Description
auth_token
required

UUID Associated with an individual User

Validations:

  • Must be a String
auth_hash
optional

AuthUser hash used to pair up the correct User

Validations:

  • Must be a String