> ## Documentation Index
> Fetch the complete documentation index at: https://docs-platform.crewai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Authorize a connection

> Starts an authorization for the connection and returns the page where the user connects
their account. Call it after creating a connection, after an authorization failed or was
revoked, or to replace the connected account. `authorization_url` is null when the
provider authorized the connection at once.




## OpenAPI

````yaml /openapi/platform-v1.yaml post /api/v1/connections/{connection_id}/authorize
openapi: 3.0.1
info:
  title: CrewAI Platform API
  version: v1
  description: Supported public API for CrewAI Platform.
servers:
  - url: https://app.crewai.com
    description: Current CrewAI Platform host
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Users in the organization.
  - name: Status
    description: Platform health and API availability.
  - name: Automations
    description: >-
      Automations, their source artifacts, their executions, and their
      schedules.
  - name: Teams
    description: Teams in the organization.
  - name: Group Mappings
    description: Identity-provider group mappings to Teams.
  - name: Service Accounts
    description: Service accounts in the organization.
  - name: Webhook Endpoints
    description: Endpoints that receive signed event deliveries.
  - name: Studio Projects
    description: Projects built in Crew Studio.
  - name: Environment Variables
    description: Environment variables in the organization.
  - name: Git Repositories
    description: Git repositories connected to the organization.
  - name: LLM Connections
    description: Connections to LLM providers.
  - name: Tools
    description: Tools in the organization's tool repository.
  - name: Applications
    description: Applications the organization can connect, with their tools and triggers.
  - name: Connections
    description: Application connections the caller can use.
paths:
  /api/v1/connections/{connection_id}/authorize:
    parameters:
      - name: connection_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
    post:
      tags:
        - Connections
      summary: Authorize a connection
      description: >
        Starts an authorization for the connection and returns the page where
        the user connects

        their account. Call it after creating a connection, after an
        authorization failed or was

        revoked, or to replace the connected account. `authorization_url` is
        null when the

        provider authorized the connection at once.
      operationId: authorizeConnection
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                success:
                  value:
                    data:
                      authorization_url: >-
                        https://app.crewai.com/crewai_plus/clipper/links/4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a/authorize
                  summary: Authorization started
              schema:
                type: object
                required:
                  - data
                additionalProperties: false
                properties:
                  data:
                    type: object
                    required:
                      - authorization_url
                    additionalProperties: false
                    properties:
                      authorization_url:
                        type: string
                        example: >-
                          https://app.crewai.com/crewai_plus/clipper/links/4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a/authorize
                        format: uri
                        nullable: true
                        description: >-
                          Where the user connects their account. Null when the
                          provider authorized the connection at once.
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                unauthorized:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/unauthorized
                        code: unauthorized
                        title: Unauthorized
                        status: 401
                        detail: Missing or invalid bearer token.
                  summary: Missing or invalid bearer token
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Forbidden
          content:
            application/json:
              examples:
                forbidden:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/forbidden
                        code: forbidden
                        title: Forbidden
                        status: 403
                        detail: >-
                          You don't have permission to authorize this
                          connection.
                  summary: The caller can use the connection but not authorize it
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                not_found:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/not_found
                        code: not_found
                        title: Not found
                        status: 404
                        detail: The requested resource could not be found.
                  summary: No connection the caller can use has this ID
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - errors
      additionalProperties: false
      properties:
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      description: Public API error object.
      required:
        - type
        - code
        - title
        - status
        - detail
      additionalProperties: false
      properties:
        type:
          type: string
          format: uri
          enum:
            - https://docs-platform.crewai.com/api/problems/bad_request
            - https://docs-platform.crewai.com/api/problems/clipper_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_disallowed
            - >-
              https://docs-platform.crewai.com/api/problems/clipper_feature_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_not_found
            - https://docs-platform.crewai.com/api/problems/conflict
            - https://docs-platform.crewai.com/api/problems/forbidden
            - https://docs-platform.crewai.com/api/problems/internal_error
            - https://docs-platform.crewai.com/api/problems/not_found
            - https://docs-platform.crewai.com/api/problems/service_unavailable
            - >-
              https://docs-platform.crewai.com/api/problems/tool_execution_failed
            - https://docs-platform.crewai.com/api/problems/unauthorized
            - https://docs-platform.crewai.com/api/problems/validation_error
          example: https://docs-platform.crewai.com/api/problems/bad_request
        code:
          type: string
          enum:
            - bad_request
            - clipper_disabled
            - clipper_disallowed
            - clipper_feature_disabled
            - clipper_not_found
            - conflict
            - forbidden
            - internal_error
            - not_found
            - service_unavailable
            - tool_execution_failed
            - unauthorized
            - validation_error
          example: bad_request
        title:
          type: string
          x-crewai-enum-format: freeform
          enum:
            - Bad request
            - Clipper resource disabled
            - Clipper resource disallowed
            - Clipper feature disabled
            - Clipper resource not found
            - Conflict
            - Forbidden
            - Internal error
            - Not found
            - Service unavailable
            - Tool execution failed
            - Unauthorized
            - Validation error
          example: Bad request
        status:
          type: integer
          enum:
            - 400
            - 401
            - 403
            - 404
            - 409
            - 422
            - 500
            - 503
          example: 400
        detail:
          type: string
          example: The request is invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.