---
title: "Get the configuration for the login page for a specific category"
method: GET
path: "/api/v3/login_config/{category_id}"
---

# Get the configuration for the login page for a specific category

`GET /api/v3/login_config/{category_id}`

## Request

- The document declares no server URL.
- Auth: none required
- TypeScript: <https://skmtc.dev/isard-vdi/apis/isardvdi-api/docs/api/v3/login_config/:category_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `category_id` string, required

## Response `200`

- GetLoginConfigResponse
  - `locale` object
    - `hide` boolean
    - `available_locales` string[]
    - `default` string
  - `logo` object
    - `hide` boolean
  - `info` object
    - `title` string
  - `maintenance` object
    - `title` string
    - `description` string
  - `notification_cover` GetLoginConfigResponseNotification
    - `enabled` boolean
    - `icon` string
    - `title` string
    - `description` string
    - `button` object
      - `text` string, required
      - `url` string, required
      - `extra_styles` string
  - `notification_form` GetLoginConfigResponseNotification
    - `enabled` boolean
    - `icon` string
    - `title` string
    - `description` string
    - `button` object
      - `text` string, required
      - `url` string, required
      - `extra_styles` string
  - `providers` object
    - `all` object
      - `description` string
      - `hide_categories_dropdown` boolean
      - `display_providers` string[]
    - `form` GetLoginConfigResponseProvider
      - `description` string
      - `hide_categories_dropdown` boolean
      - `hide_forgot_password` boolean
      - `submit_icon` string
      - `submit_text` string
      - `submit_extra_styles` string
    - `saml` GetLoginConfigResponseProvider
      - `description` string
      - `hide_categories_dropdown` boolean
      - `hide_forgot_password` boolean
      - `submit_icon` string
      - `submit_text` string
      - `submit_extra_styles` string
    - `google` GetLoginConfigResponseProvider
      - `description` string
      - `hide_categories_dropdown` boolean
      - `hide_forgot_password` boolean
      - `submit_icon` string
      - `submit_text` string
      - `submit_extra_styles` string

## Changes

- **2026-07-17** `95068d823baa`: 1 info
  - endpoint added
- **2024-09-05** `113852fcf431`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/isard-vdi/apis/isardvdi-api/changes/api/v3/login_config/:category_id/get.md)

---

[API](https://skmtc.dev/isard-vdi/apis/isardvdi-api.md) - [All operations](https://skmtc.dev/isard-vdi/apis/isardvdi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/isard-vdi/apis/isardvdi-api/revisions/95068d823baa?raw)