find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/keboola:keboola-authorize-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Keboola OAuth Service Authorize API
  version: 1.0.0
  contact:
    email: devel@keboola.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
tags:
- name: Authorize
paths:
  /authorize/{componentId}:
    post:
      summary: Authorization init
      operationId: authorizeInit
      tags:
      - Authorize
      description: 'Call the endpoint to initiate the authorization process. It starts the authorization sessions and redirects

        client to the OAuth provider.'
      parameters:
      - in: path
        name: componentId
        schema:
          type: string
        required: true
        description: Component ID
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - id
              - authorizedFor
              - token
              - returnUrl
              properties:
                id:
                  type: string
                  description: Authorization ID
                authorizedFor:
                  type: string
                  description: Authorization description
                token:
                  type: string
                  description: Storage token of the requester
                returnUrl:
                  type: string
                  description: URL where to redirect the client after authorization
                appKey:
                  type:
                  - string
                  - 'null'
                  description: Custom application key
                appSecret:
                  type:
                  - string
                  - 'null'
                  description: Custom application secret
                authUrl:
                  type:
                  - string
                  - 'null'
                  description: Custom authorization URL
                tokenUrl:
                  type:
                  - string
                  - 'null'
                  description: Custom token URL
                branchId:
                  type:
                  - string
                  - 'null'
                  description: 'ID of the branch where the credentials should live. If not specified, the credentials will be

                    considered as project-wide.


                    The property is not required for now, to keep compatibility with existing clients. But it will be

                    required in the future (but still nullable), to ensure the client has considered if they want to

                    create project-wide or branch-specific credentials.

                    '
      responses:
        '302':
          description: Redirect to OAuth provider
          headers:
            Location:
              description: URL to follow to authorize the component
              schema:
                type: string
                format: url
        '400':
          $ref: '#/components/responses/400_BadRequest'
        '422':
          $ref: '#/components/responses/422_UnprocessableEntity'
  /authorize/{componentId}/callback:
    get:
      summary: Authorization callback
      operationId: authorizeCallback
      tags:
      - Authorize
      description: 'The endpoint is called by OAuth provider after the authorization process is finished. It uses parameters passed

        in query to retrieve the access token and stores the authorization. Finally it redirects the client back to the

        return URL.'
      parameters:
      - in: path
        name: componentId
        schema:
          type: string
        required: true
        description: Component ID
      responses:
        '302':
          description: Redirect client back to Keboola
          headers:
            Location:
              schema:
                type: string
                format: url
        '400':
          $ref: '#/components/responses/400_BadRequest'
components:
  schemas:
    Error:
      type: object
      required:
      - error
      - code
      - exceptionId
      - status
      properties:
        error:
          type: string
        code:
          type: integer
        exceptionId:
          type: string
        status:
          enum:
          - error
        context:
          type: object
  responses:
    422_UnprocessableEntity:
      description: Unprocessable entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    400_BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    StorageToken:
      type: apiKey
      in: header
      name: X-StorageApi-Token
    ManageToken:
      type: apiKey
      in: header
      name: X-KBC-ManageApiToken