Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proper detailing of POST /auth/token endpoint #1

Open
someone1 opened this issue Apr 5, 2021 · 1 comment
Open

Proper detailing of POST /auth/token endpoint #1

someone1 opened this issue Apr 5, 2021 · 1 comment

Comments

@someone1
Copy link

someone1 commented Apr 5, 2021

The definition found for this endpoint is missing all parameter data, it could be enhanced to include a parameters definition as shown below:

 /auth/token:
    post:
      summary: "Generate Access Token"
      deprecated: false
      produces:
      - "*/*"
      description: "<b>Generate Access Token using client credential authentication.</b><br/><br><br>This service returns access tokens required to access Yodlee 1.1 APIs. These tokens are the <br/>simplest and easiest of several alternatives for authenticating with Yodlee servers.<br/><br><br>The most commonly used services obtain data specific to an end user (your customer). <br/>For these services, you need a <b>user access token</b>. These are simply tokens created with <br/>the user name parameter (<b>loginName</b>) set to the id of your end user.  Note: you determine <br/>this id and you must ensure it's unique among all your customers.<br/><br><br>Each token issued has an associated user. The token passed in the http headers explicitly <br/>names the user referenced in that API call.<br/><br><br>Some of the APIs do administrative work, and don't reference an end user. <br/>One example of administrative work is key management. Another example is <br/>registering a new user explicitly, with <b>POST /user/register</b> call <br/>or subscribe to webhook, with <b>POST /config/notifications/events/{eventName}</b>. <br/>To invoke these, you need an <b>admin access token</b>. Create this by passing in <br/>your admin user login name in place of a regular user name.<br/><br><br>This service also allows for simplified registration of new users. Any time you pass in a user <br/>name not already in use, the system will automatically implicitly create a new user for you. <br/>This user will have naturally have very few associated details. You can later provide additional <br/>user information by calling the <b>PUT user/register service</b>.<br/><br><br><b>Notes:</b><br/>The content type has to be passed as application/x-www-form-urlencoded.<br/>//Upgrading to client credential authentication requires infrastructure reconfiguration. <br/>Customers wishing to switch from another authentication scheme to client credential authentication, <br/>please contact Yodlee Client Services."
      operationId: "generateAccessToken"
      responses:
        201:
          schema:
            $ref: "#/definitions/ClientCredentialTokenResponse"
          description: "OK"
        400:
          schema:
            $ref: "#/definitions/YodleeError"
          description: "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:
          schema:
            $ref: "#/definitions/YodleeError"
          description: "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:
          description: "Not Found"
      tags:
      - "Auth"
      consumes:
      - "application/x-www-form-urlencoded"
      parameters:
      - in: formData
        name: clientId
        required: true
        type: string
        description: The Client ID.
      - in: formData
        name: secret
        required: true
        type: string
        description: The Client Secret.
      - in: header
        name: loginName
        required: true
        type: string
        description: The id of your end user.

References:

@patrickcorbett1
Copy link

Is this repo still supported?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants