yodlee.UserApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_access_tokens	GET /user/accessTokens	Get Access Tokens
get_user	GET /user	Get User Details
register_user	POST /user/register	Register User
saml_login	POST /user/samlLogin	Saml Login
unregister	DELETE /user/unregister	Delete User
update_user	PUT /user	Update User Details
user_logout	POST /user/logout	User Logout

get_access_tokens

UserAccessTokensResponse get_access_tokens(app_ids)

Get Access Tokens

The Get Access Tokens service is used to retrieve the access tokens for the application id(s) provided.
URL in the response can be used to launch the application for which token is requested.

Note:

This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.UserApi(api_client)
    app_ids = 'app_ids_example' # str | appIds

    try:
        # Get Access Tokens
        api_response = api_instance.get_access_tokens(app_ids)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UserApi->get_access_tokens: %s\n" % e)

Parameters

Name	Type	Description	Notes
app_ids	str	appIds

Return type

UserAccessTokensResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user

UserDetailResponse get_user()

Get User Details

The get user details service is used to get the user profile information and the application preferences set at the time of user registration.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.UserApi(api_client)
    
    try:
        # Get User Details
        api_response = api_instance.get_user()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UserApi->get_user: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserDetailResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

register_user

UserResponse register_user(user_request)

Register User

The register user service is used to register a user in Yodlee.
The loginName cannot include spaces and must be between 3 and 150 characters.
locale passed must be one of the supported locales for the customer.
Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.
userParam is accepted as a body parameter.

Note:

The content type has to be passed as application/json for the body parameter.

Note: We recommend you to not use special characters in loginName other than "@", "#", "_" & "-".

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.UserApi(api_client)
    user_request = yodlee.UserRequest() # UserRequest | userRequest

    try:
        # Register User
        api_response = api_instance.register_user(user_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UserApi->register_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_request	UserRequest	userRequest

Return type

UserResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Login Successful	-
400	Y800 : Invalid value for loginName<br>Y800 : Invalid value for email<br>Y801 : Invalid length for loginName<br>Y800 : Invalid value for phoneNumber<br>	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

saml_login

UserResponse saml_login(issuer, saml_response, source=source)

Saml Login

The SAML login service is used to authenticate system users with a SAML response.
A new user will be created with the input provided if that user isn't already in the system.
For existing users, the system will make updates based on changes or new information.
When authentication is successful, a user session token is returned.

Note:

The content type has to be passed as application/x-www-form-urlencoded.

issuer, source and samlResponse should be passed as body parameters.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.UserApi(api_client)
    issuer = 'issuer_example' # str | issuer
saml_response = 'saml_response_example' # str | samlResponse
source = 'source_example' # str | source (optional)

    try:
        # Saml Login
        api_response = api_instance.saml_login(issuer, saml_response, source=source)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UserApi->saml_login: %s\n" % e)

Parameters

Name	Type	Description	Notes
issuer	str	issuer
saml_response	str	samlResponse
source	str	source	[optional]

Return type

UserResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y013 : Invalid value for samlResponse<br>Y013 : Invalid value for issuer	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unregister

unregister()

Delete User

The delete user service is used to delete or unregister a user from Yodlee.
Once deleted, the information related to the users cannot be retrieved.
The HTTP response code is 204 (Success without content)

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.UserApi(api_client)
    
    try:
        # Delete User
        api_instance.unregister()
    except ApiException as e:
        print("Exception when calling UserApi->unregister: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
204	No Content	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user

update_user(user_request)

Update User Details

The update user details service is used to update user details like name, address, currency preference, etc.
Currency provided in the input will be respected in the <a href="https://developer.yodlee.com/api-reference#tag/Derived\">derived services and the amount fields in the response will be provided in the preferred currency.
The HTTP response code is 204 (Success without content).

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.UserApi(api_client)
    user_request = yodlee.UpdateUserRequest() # UpdateUserRequest | userRequest

    try:
        # Update User Details
        api_instance.update_user(user_request)
    except ApiException as e:
        print("Exception when calling UserApi->update_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_request	UpdateUserRequest	userRequest

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
204	No Content	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_logout

user_logout()

User Logout

Deprecated: This endpoint is deprecated for API Key-based authentication. The user logout service allows the user to log out of the application.
The service does not return a response body. The HTTP response code is 204 (Success with no content).

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.UserApi(api_client)
    
    try:
        # User Logout
        api_instance.user_logout()
    except ApiException as e:
        print("Exception when calling UserApi->user_logout: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
204	Logout successful	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

yodlee.UserApi

get_access_tokens

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

register_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

saml_login

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unregister

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_logout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details