> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an authentication configuration

> Modifies an existing authentication configuration with new credentials or other settings. Only specified fields will be updated.



## OpenAPI

````yaml api-reference/openapi.json PATCH /api/v3.1/auth_configs/{nanoid}
openapi: 3.1.0
info:
  version: 3.1.0
  title: Composio Platform API v3.1
  description: >-
    Composio v3.1 API — all endpoints available under /api/v3.1/. Tool endpoints
    default to the latest tool version.
  contact:
    name: Composio Support
    url: https://composio.dev/support
    email: support@composio.dev
  license:
    name: Proprietary
    url: https://composio.dev/terms
servers:
  - url: https://backend.composio.dev
    description: Composio production API
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: Authentication related endpoints
    x-group: Authentication
  - name: Auth Configs
    description: Authentication configuration management
    x-group: Auth Configs
  - name: Connected Accounts
    description: Connected account management
    x-group: Connected Accounts
  - name: Logs
    description: Logging and monitoring
    x-group: Logs
  - name: OpenAPI
    description: OpenAPI specification management
    x-group: OpenAPI
  - name: Organization
    description: Organization management
    x-group: Organization
  - name: API Keys
    description: API key management
    x-group: API Keys
  - name: Webhooks
    description: Webhook configuration
    x-group: Webhooks
  - name: Webhook Endpoints
    description: >-
      Per-OAuth-app webhook ingress endpoints. Inbound URLs the provider posts
      to, plus signing secret storage and verification.
    x-group: Webhook Endpoints
  - name: Webhook Subscriptions
    description: >-
      Webhook delivery subscriptions. Outbound URLs Composio posts trigger
      events to, plus signing secret rotation and event-type filters.
    x-group: Webhook Subscriptions
  - name: Team
    description: Team member management
    x-group: Team
  - name: Consumer Skills
    description: Organization-authored Skill management
    x-group: Consumer Skills
  - name: Toolkits
    description: Toolkit and tool management
    x-group: Toolkits
  - name: Tools
    description: Tool execution endpoints
    x-group: Tools
  - name: Triggers
    description: Trigger management and execution
    x-group: Triggers
  - name: Payments
    description: Payment and subscription management
    x-group: Payments
  - name: Billing
    description: Dashboard billing state — usage, subscription, contract (cookie-auth only)
    x-group: Billing
  - name: Compliance
    description: Organization compliance agreements and acceptance state
    x-group: Compliance
  - name: Files
    description: File management
    x-group: Files
  - name: MCP
    description: MCP server management
    x-group: MCP
  - name: MCP Partner
    description: MCP partner management
    x-group: MCP Partner
  - name: Stripe Projects
    description: Stripe Projects provisioning
    x-group: Stripe Projects
  - name: Tool Router
    description: (Labs) Tool router endpoints
    x-group: Sessions (Prev Tool Router)
  - name: Playground
    description: Dashboard playground chat
    x-group: Playground
  - name: Arena
    description: Arena conversations, messages and terms
    x-group: Arena
  - name: Projects
    description: Projects API endpoints.
    x-group: Projects
  - name: Organization Management
    description: Organization Management API endpoints.
    x-group: Organization Management
  - name: Webhook Events
    description: Events delivered by Composio to your registered webhook endpoints
    x-group: Webhook Events
paths:
  /api/v3.1/auth_configs/{nanoid}:
    patch:
      tags:
        - Auth Configs
      summary: Update an authentication configuration
      description: >-
        Modifies an existing authentication configuration with new credentials
        or other settings. Only specified fields will be updated.
      operationId: patchAuthConfigsByNanoid
      parameters:
        - schema:
            type: string
            format: authConfigId
            description: >-
              The unique identifier of the authentication configuration to
              update
          required: true
          description: The unique identifier of the authentication configuration to update
          name: nanoid
          in: path
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CustomAuthConfigUpdate'
                - $ref: '#/components/schemas/DefaultAuthConfigUpdate'
              discriminator:
                propertyName: type
                mapping:
                  custom: '#/components/schemas/CustomAuthConfigUpdate'
                  default: '#/components/schemas/DefaultAuthConfigUpdate'
            examples:
              standardUpdate:
                summary: Standard credential update
                value:
                  auth_config:
                    credentials:
                      api_key: YOUR_NEW_API_KEY
                      client_secret: YOUR_NEW_CLIENT_SECRET
      responses:
        '200':
          description: Successfully updated auth config
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the auth config was updated
                  message:
                    type: string
                    description: A human-readable result message
                required:
                  - success
                  - message
        '400':
          description: Bad request - Invalid input or credentials format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found - Auth configuration does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error - Something went wrong on the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
        - UserApiKeyAuth: []
components:
  schemas:
    CustomAuthConfigUpdate:
      type: object
      properties:
        type:
          type: string
          enum:
            - custom
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: The display name of the authentication configuration
        credentials:
          type: object
          properties:
            scopes:
              anyOf:
                - type: string
                - type: array
                  items:
                    type: string
              description: OAuth scopes requested for the auth config.
            user_scopes:
              anyOf:
                - type: string
                - type: array
                  items:
                    type: string
              description: >-
                OAuth user-token scopes requested for the auth config. This is
                primarily used by Slack OAuth v2.
        sealed_credentials:
          type: object
          additionalProperties:
            type: string
            minLength: 1
            maxLength: 16384
          description: >-
            [EXPERIMENTAL] Client-sealed secret fields to redeem through the
            organization keyring instance (GET /api/v3.1/keyring/transfer_keys).
            The plaintext must not also appear in credentials. Rotates the
            stored client_secret without Composio ever holding it.
          x-experimental: true
        proxy_config:
          type:
            - object
            - 'null'
          properties:
            proxy_url:
              type: string
              format: uri
              description: The url of the auth proxy
            proxy_auth_key:
              type: string
              description: The auth key for the auth proxy
          required:
            - proxy_url
        restrict_to_following_tools:
          type: array
          items:
            type: string
          description: >-
            List of tool slugs this auth config is restricted to use with.
            DEPRECATED: use [Get required
            scopes](/reference/api-reference/toolkits/recommendToolkitScopes) to
            resolve the scopes for the tools you need, then pass those scopes in
            `credentials.scopes`.
          deprecated: true
        tool_access_config:
          type: object
          properties:
            tools_for_connected_account_creation:
              type: array
              items:
                type: string
              description: >-
                Tools used to generate the minimum required scopes for the auth
                config (only valid for OAuth). If passed, this will update the
                scopes. DEPRECATED: use [Get required
                scopes](/reference/api-reference/toolkits/recommendToolkitScopes)
                to resolve the scopes for the tools you need, then pass those
                scopes in `credentials.scopes`.
              deprecated: true
            tools_available_for_execution:
              type: array
              items:
                type: string
              description: >-
                The actions that the user can perform on the auth config. If
                passed, this will update the actions that the user can perform
                on the auth config. DEPRECATED: use [Get required
                scopes](/reference/api-reference/toolkits/recommendToolkitScopes)
                to resolve the scopes for the tools you need, then pass those
                scopes in `credentials.scopes`.
              deprecated: true
          description: >-
            DEPRECATED: use [Get required
            scopes](/reference/api-reference/toolkits/recommendToolkitScopes) to
            resolve the scopes for the tools you need, then pass those scopes in
            `credentials.scopes`.
          deprecated: true
        shared_credentials:
          type: object
          additionalProperties: {}
          description: >-
            Shared credentials inherited by all connected accounts using this
            auth config. Secret values are redacted in responses, so provide the
            real values when updating; omit this field to leave them unchanged.
            DEPRECATED: use `shared_connection_fields` instead. It takes the
            same value and behaves the same way.
          deprecated: true
        shared_connection_fields:
          type: object
          additionalProperties: {}
          description: >-
            Connection field values inherited by every connected account created
            under this auth config. Secret values are redacted in responses, so
            provide the real values when updating; omit this field to leave them
            unchanged.
        is_enabled_for_tool_router:
          type: boolean
          description: Whether this auth config is enabled for tool router
      required:
        - type
    DefaultAuthConfigUpdate:
      type: object
      properties:
        type:
          type: string
          enum:
            - default
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: The display name of the authentication configuration
        scopes:
          anyOf:
            - type: string
            - type: array
              items:
                type: string
          description: OAuth scopes requested for the auth config.
        user_scopes:
          anyOf:
            - type: string
            - type: array
              items:
                type: string
          description: >-
            OAuth user-token scopes requested for the auth config. This is
            primarily used by Slack OAuth v2.
        restrict_to_following_tools:
          type: array
          items:
            type: string
          description: >-
            List of tool slugs this auth config is restricted to use with.
            DEPRECATED: use [Get required
            scopes](/reference/api-reference/toolkits/recommendToolkitScopes) to
            resolve the scopes for the tools you need, then pass those scopes in
            `credentials.scopes`.
          deprecated: true
        tool_access_config:
          type: object
          properties:
            tools_for_connected_account_creation:
              type: array
              items:
                type: string
              description: >-
                Tools used to generate the minimum required scopes for the auth
                config (only valid for OAuth). If passed, this will update the
                scopes. DEPRECATED: use [Get required
                scopes](/reference/api-reference/toolkits/recommendToolkitScopes)
                to resolve the scopes for the tools you need, then pass those
                scopes in `credentials.scopes`.
              deprecated: true
            tools_available_for_execution:
              type: array
              items:
                type: string
              description: >-
                The actions that the user can perform on the auth config. If
                passed, this will update the actions that the user can perform
                on the auth config. DEPRECATED: use [Get required
                scopes](/reference/api-reference/toolkits/recommendToolkitScopes)
                to resolve the scopes for the tools you need, then pass those
                scopes in `credentials.scopes`.
              deprecated: true
          description: >-
            DEPRECATED: use [Get required
            scopes](/reference/api-reference/toolkits/recommendToolkitScopes) to
            resolve the scopes for the tools you need, then pass those scopes in
            `credentials.scopes`.
          deprecated: true
        shared_credentials:
          type: object
          additionalProperties: {}
          description: >-
            Shared credentials inherited by all connected accounts using this
            auth config. Secret values are redacted in responses, so provide the
            real values when updating; omit this field to leave them unchanged.
            DEPRECATED: use `shared_connection_fields` instead. It takes the
            same value and behaves the same way.
          deprecated: true
        shared_connection_fields:
          type: object
          additionalProperties: {}
          description: >-
            Connection field values inherited by every connected account created
            under this auth config. Secret values are redacted in responses, so
            provide the real values when updating; omit this field to leave them
            unchanged.
        is_enabled_for_tool_router:
          type: boolean
          description: Whether this auth config is enabled for tool router
      required:
        - type
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: number
            slug:
              type: string
            status:
              type: number
            request_id:
              type: string
            suggested_fix:
              type: string
            errors:
              type: array
              items:
                type: string
          required:
            - message
            - code
            - slug
            - status
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Composio project API key. Create or copy it from the Composio
        dashboard.
      x-default: your-project-api-key
    UserApiKeyAuth:
      type: apiKey
      in: header
      name: x-user-api-key
      description: Your Composio user API key for user-scoped endpoints.
      x-default: your-user-api-key

````