---
title: "Switch Access Mode"
method: POST
path: "/api/py/integrations/{provider}/access-mode"
---

# Switch Access Mode

`POST /api/py/integrations/{provider}/access-mode`

## Request

- Base URL: `https://api.getauctor.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getauctor.com/api/py/integrations/{provider}/access-mode`
- Auth: none declared

## Path parameters

- `provider` string, required

## Request body

- AccessModeSwitchBody
  - `principal_type` 'org', required
  - `principal_id` string, required
  - `requested_mode` 'broad_oauth' | 'sites_selected', required
  - `switch_id` string, uuid, required
  - `request_context` AccessModeRequestContext
    - `ip_address` string, nullable
    - `user_agent` string, nullable

## Response `200`

Successful Response

- union
  - AccessModeUnchanged
    - `kind` 'no_change', required
    - `mode` 'broad_oauth' | 'sites_selected', required
  - AccessModeSwitched
    - `kind` 'switched', required
    - `from` 'broad_oauth' | 'sites_selected', required
    - `to` 'broad_oauth' | 'sites_selected', required
    - `invalidatedTokenCount` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-24** `91ca93f86d79`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getauctor/apis/getauctor-api/changes/api/py/integrations/:provider/access-mode/post.md)

---

[API](https://skmtc.dev/getauctor/apis/getauctor-api.md) - [All operations](https://skmtc.dev/getauctor/apis/getauctor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getauctor/apis/getauctor-api/revisions/be39c59c13f6?raw)