Selecting OAuth 2.0 authentication

Using the OAuth 2.0 method utilizes one of the four grant types available through our Wizard. The steps described here take place after completing the first page of the Vault Entry Wizard.

  1. Select your grant type and provide information required for the request.
    Options include:
    • Authorization Code
    • Implicit
    • Password Credentials
    • Client Credentials
    Note: The application being authorized determines which grant type can be accepted. Reference applicable documentation for guidelines.
  2. Enter the required authorization values for the selected grant type.
    Note: Clarify requires certain parameters in order to proceed with authorization, which are displayed in bold. The external application however may require additional parameters not bolded in the Wizard. Always reference applicable documentation for guidelines.
  3. Select how Client Authentication is sent. Drop-down options include:
    • Send as Basic Auth Header
    • Send credentials in body
  4. Complete grant flow for authenticating communications. Once the request has completed, click Next to proceed.
  5. If selecting Authorization or Implicit grant flow types, you will be prompted to sign in to the actual application (which appears as a browser within the Wizard).
    Note: A Switch mode button provides an alternate way to authorize the account. Selecting this option takes you to another screen which lets you paste the redirect URL from the external browser into the wizard. Clarify then validates. This is in response to issues related to older Web browsers, or when using a Studio running on Linux.

  6. Select the Auth Info. Options include Bearer Token, Custom Header, Query Parameter, and Basic authorization.
    • Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, usually generated by the server in response to a login request
    • Custom Headers are very similar to a Bearer token. But rather than putting a header that looks like:
    Authorization: Bearer {Token}
    in the request that web service client makes, it puts a header that looks like this:
    {Header Key}: {Token}
    where {Token} is the actual access token and {Header Key} is something specific to the API itself, such as "X-QuickBooks-Access-Token" or "x-weebly-access-token",etc.

    • Query parameters are a defined set of parameters attached to the end of a URL, and are used to help define specific content or actions based on the data being passed; sometimes authorization information is passed as a query parameter. This type is currently not supported in SOAP Web Services.
    • The Basic Type uses Username and Password for authentication.
  7. Click Finish. The vault entry now appears in the Auth Vault view.