---
title: "GET /v1alpha1/settings"
method: GET
path: "/v1alpha1/settings"
tags: ["SettingsService"]
---

# GET /v1alpha1/settings

`GET /v1alpha1/settings`

## Request

- Base URL: `http://localhost:4000`
- URL: `http://localhost:4000/v1alpha1/settings`
- Auth: HTTP bearer and API key in header `x-id-api-key`

Get Settings

## Response `200`

OK

- Settings: Identity Settings
  - `apiKey` ApiKey: An Identity API Key.
    - `apiKey` string
  - `issuerSettings` IssuerSettings: Issuer Settings
    - `issuerId` string: A unique identifier for the Issuer. This is typically the Issuer's ID in the Identity.
    - `idpType` 'IDP_TYPE_UNSPECIFIED' | 'IDP_TYPE_DUO' | 'IDP_TYPE_OKTA' | 'IDP_TYPE_ORY' | 'IDP_TYPE_SELF' | 'IDP_TYPE_KEYCLOAK' | 'IDP_TYPE_PING' | 'IDP_TYPE_ENTRA_ID', enum, required: The type of the IdP.
    - `duoIdpSettings` DuoIdpSettings: Duo IdP Settings
      - `hostname` string
      - `integrationKey` string
      - `secretKey` string
    - `oktaIdpSettings` OktaIdpSettings: Okta IdP Settings
      - `orgUrl` string
      - `clientId` string
      - `privateKey` string
    - `oryIdpSettings` OryIdpSettings: Ory IdP Settings
      - `projectSlug` string
      - `apiKey` string
    - `keycloakIdpSettings` KeycloakIdpSettings: Keycloak IdP Settings
      - `baseUrl` string
      - `realm` string
      - `clientId` string
      - `clientSecret` string
    - `pingIdpSettings` PingIdpSettings: Ping IdP Settings
      - `environmentId` string
      - `clientId` string
      - `clientSecret` string
      - `region` string
    - `entraIdpSettings` EntraIdpSettings: Entra ID (Azure AD) IdP Settings
      - `tenantId` string
      - `clientId` string
      - `clientSecret` string
    - `createdAt` string, date-time: CreatedAt records the timestamp of when the IssuerSettings was initially created
    - `updatedAt` string, date-time: UpdatedAt records the timestamp of the last update to the IssuerSettings

## Other responses

- `default`: Default error response

## Changes

> 18 revisions in range; 7 not diffed.

- **2026-07-17** `1dc8f8328648`: 1 warning, 1 info
  - added the new `IDP_TYPE_ENTRA_ID` enum value to the `issuerSettings/allOf[#/components/schemas/IssuerSettings]/idpType` response property for the response status `200`
  - added the optional property `issuerSettings/allOf[#/components/schemas/IssuerSettings]/entraIdpSettings` to the response with the `200` status
- **2026-01-26** `25adba52b633`: 1 warning, 1 info
  - added the new `IDP_TYPE_PING` enum value to the `issuerSettings/allOf[#/components/schemas/IssuerSettings]/idpType` response property for the response status `200`
  - added the optional property `issuerSettings/allOf[#/components/schemas/IssuerSettings]/pingIdpSettings` to the response with the `200` status
- **2025-10-28** `639bf179b6bd`: 2 info
  - added the optional property `issuerSettings/allOf[#/components/schemas/IssuerSettings]/createdAt` to the response with the `200` status
  - added the optional property `issuerSettings/allOf[#/components/schemas/IssuerSettings]/updatedAt` to the response with the `200` status
- **2025-10-27** `5c4ad1cb6f0c`: 1 warning, 1 info
  - added the new `IDP_TYPE_KEYCLOAK` enum value to the `issuerSettings/allOf[#/components/schemas/IssuerSettings]/idpType` response property for the response status `200`
  - added the optional property `issuerSettings/allOf[#/components/schemas/IssuerSettings]/keycloakIdpSettings` to the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/agntcy/apis/agntcy-identity-service-api/changes/v1alpha1/settings/get.md)

---

[API](https://skmtc.dev/agntcy/apis/agntcy-identity-service-api.md) - [All operations](https://skmtc.dev/agntcy/apis/agntcy-identity-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agntcy/apis/agntcy-identity-service-api/revisions/1dc8f8328648?raw)