---
title: "Get auth requirements"
method: GET
path: "/auth-requirements"
tags: ["Auth"]
---

# Get auth requirements

`GET /auth-requirements`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/auth-requirements`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

Get a list of authentication provider ids

## Response `200`

- AuthenticationRequirement[]
  - `workspace_id` string, required
  - `workspace_name` string, required
  - `authentication_provider_id` string, required
  - `keycloak_idp_alias` string, nullable

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)