Skip to content

Latest commit

 

History

History
329 lines (237 loc) · 14.2 KB

AuthApi.md

File metadata and controls

329 lines (237 loc) · 14.2 KB
Raw

yodlee.AuthApi

All URIs are relative to http://localhost

Method HTTP request Description
delete_api_key DELETE /auth/apiKey/{key} Delete API Key
delete_token DELETE /auth/token Delete Token
generate_access_token POST /auth/token Generate Access Token
generate_api_key POST /auth/apiKey Generate API Key
get_api_keys GET /auth/apiKey Get API Keys

delete_api_key

delete_api_key(key)

Delete API Key

This endpoint allows an existing API key to be deleted.
You can use one of the following authorization methods to access this API:

  1. cobsession
  2. JWT token
Notes:
  • This service is not available in developer sandbox environment and will be made availablefor testing in your dedicated environment.

    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.AuthApi(api_client)
    key = 'key_example' # str | key

    try:
        # Delete API Key
        api_instance.delete_api_key(key)
    except ApiException as e:
        print("Exception when calling AuthApi->delete_api_key: %s\n" % e)

    Parameters

    Name Type Description Notes
    key str key

    Return type

    void (empty response body)

    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
    201 OK -
    400 Y807 : Resource not found<br>Y806 : Invalid input -
    401 Unauthorized -
    204 No Content -
    404 Not Found -

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

    delete_token

    delete_token()

    Delete Token

    This endpoint revokes the token passed in the Authorization header. This service is applicable for JWT-based (and all API key-based) authentication and also client credential (clientId and secret) based authentication. This service does not return a response body. The HTTP response code is 204 (success with no content).
    Tokens generally have limited lifetime of up to 30 minutes. You will call this service when you finish working with one user, and you want to delete the valid token rather than simply letting it expire.

    Note:

  • Revoking an access token (either type, admin or a user token) can take up to 2 minutes, as the tokens are stored on a distributed system.

    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.AuthApi(api_client)
    
    try:
        # Delete Token
        api_instance.delete_token()
    except ApiException as e:
        print("Exception when calling AuthApi->delete_token: %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: application/json;charset=UTF-8

    HTTP response details

    Status code Description Response headers
    401 Y020 : Invalid token in authorization header<br>Y023 : Token has expired<br>Y016 : Api-Version header missing<br>Y015 : Unauthorized User<br>Y027 : Unsupported authentication type<br>Y007 : Authorization header missing<br>Y020 : Invalid token in authorization header -
    204 No Content -
    404 Not Found -

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

    generate_access_token

    ClientCredentialTokenResponse generate_access_token(client_id=client_id, secret=secret)

    Generate Access Token

    Generate Access Token using client credential authentication.
    This service returns access tokens required to access Yodlee 1.1 APIs. These tokens are the simplest and easiest of several alternatives for authenticating with Yodlee servers.
    The most commonly used services obtain data specific to an end user (your customer). For these services, you need a user access token. These are simply tokens created with the user name parameter (loginName) set to the id of your end user.

    Note: You determine this id and you must ensure it's unique among all your customers.

    Each token issued has an associated user. The token passed in the http headers explicitly names the user referenced in that API call.

    Some of the APIs do administrative work, and don't reference an end user.
    One example of administrative work is key management. Another example is registering a new user explicitly, with POST /user/register call or subscribe to webhook, with POST /config/notifications/events/{eventName}.
    To invoke these, you need an admin access token. Create this by passing in your admin user login name in place of a regular user name.

    This service also allows for simplified registration of new users. Any time you pass in a user name not already in use, the system will automatically implicitly create a new user for you.
    This user will naturally have very few associated details. You can later provide additional user information by calling the PUT user/register service.

    Notes:

    • The header Authorization does not apply to this service.
    • The content type has to be passed as application/x-www-form-urlencoded.
    • Upgrading to client credential authentication requires infrastructure reconfiguration.
    • Customers wishing to switch from another authentication scheme to client credential authentication, please contact Yodlee Client Services.
    • Default expiry time of user access token and admin access token is 30 minutes.

    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.AuthApi(api_client)
    client_id = 'client_id_example' # str | clientId issued by Yodlee is used to generate the OAuth token for authentication. (optional)
secret = 'secret_example' # str | secret issued by Yodlee is used to generate the OAuth token for authentication. (optional)

    try:
        # Generate Access Token
        api_response = api_instance.generate_access_token(client_id=client_id, secret=secret)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->generate_access_token: %s\n" % e)

    Parameters

    Name Type Description Notes
    client_id str clientId issued by Yodlee is used to generate the OAuth token for authentication. [optional]
    secret str secret issued by Yodlee is used to generate the OAuth token for authentication. [optional]

    Return type

    ClientCredentialTokenResponse

    Authorization

    No authorization required

    HTTP request headers

    • Content-Type: application/x-www-form-urlencoded
    • Accept: application/json;charset=UTF-8

    HTTP response details

    Status code Description Response headers
    201 OK -
    400 Y800 : Invalid value for loginName<br>Y806 : Invalid input<br>Y801 : Invalid length for loginName<br>Y303 : clientId or secret is missing<br>Y301 : Invalid clientId or secret<br>Y305 : Access token can be issued only for pre-registered users<br>Y004 : Inactive user<br>Y901 : Service not supported<br> -
    401 Y016 : loginName header missing<br>Y015 : Unauthorized User<br>Y016 : Api-Version header missing<br>Y020 : Invalid token in authorization header<br>Y027 : Unsupported authentication type -
    404 Not Found -

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

    generate_api_key

    ApiKeyResponse generate_api_key(api_key_request)

    Generate API Key

    This endpoint is used to generate an API key. The RSA public key you provide should be in 2048 bit PKCS#8 encoded format.
    A public key is a mandatory input for generating the API key.
    The public key should be a unique key. The apiKeyId you get in the response is what you should use to generate the JWT token.
    You can use one of the following authorization methods to access
    this API:

    1. cobsession
    2. JWT token
    Alternatively, you can use base 64 encoded cobrandLogin and cobrandPassword in the Authorization header (Format: Authorization: Basic )

    Note:
  • This service is not available in developer sandbox environment and will be made available for testing in your dedicated environment. The content type has to be passed as application/json for the body parameter.

    • 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.AuthApi(api_client)
    api_key_request = yodlee.ApiKeyRequest() # ApiKeyRequest | apiKeyRequest

    try:
        # Generate API Key
        api_response = api_instance.generate_api_key(api_key_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->generate_api_key: %s\n" % e)

    Parameters

    Name Type Description Notes
    api_key_request ApiKeyRequest apiKeyRequest

    Return type

    ApiKeyResponse

    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
    201 OK -
    400 Y800 : Invalid value for RS512 publicKey<br>Y806 : Invalid input<br>Y824 : The maximum number of apiKey permitted is 5<br>Y811 : publicKey value already exists -
    401 Unauthorized -
    404 Not Found -

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

    get_api_keys

    ApiKeyResponse get_api_keys()

    Get API Keys

    This endpoint provides the list of API keys that exist for a customer.
    You can use one of the following authorization methods to access this API:

    1. cobsession
    2. JWT token
    Notes:
  • This service is not available in developer sandbox environment and will be made available for testing in your dedicated environment.

    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.AuthApi(api_client)
    
    try:
        # Get API Keys
        api_response = api_instance.get_api_keys()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->get_api_keys: %s\n" % e)

    Parameters

    This endpoint does not need any parameter.

    Return type

    ApiKeyResponse

    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]

    •