---
title: "Configure Custom OIDC settings"
method: PUT
path: "/custom-oidc"
tags: ["CustomOIDC"]
---

# Configure Custom OIDC settings

`PUT /custom-oidc`

## Request

- Base URL: `https://localhost:8446/api/v2`
- URL: `https://localhost:8446/api/v2/custom-oidc`
- Auth: API key in header `Authorization`

Configure Custom OIDC settings. Returns Custom OIDC settings. See get Custom OIDC settings for the response details.

## Request body

- object
  - `idp_name` string: Custom OIDC Identity Provider name. This parameter is not required if the purpose of the request is to disable Custom OIDC
  - `authorization_code_flow_enabled` boolean, required: Determines whether Custom OIDC Authorization code flow is enabled or not. Set false if you intend to disable Custom OIDC
  - `client_id` string: Client ID. This parameter is not required if the purpose of the request is to disable Custom OIDC but required if the Custom OIDC Authorization Code Flow is enabled.
  - `client_secret` string: Client secret. This parameter is optional if the request aims to disable Custom OIDC but required if the Custom OIDC Authorization Code Flow is enabled.
  - `metadata_url` string, required: Custom OIDC metadata URL. Set empty string if you intend to disable Custom OIDC
  - `authorization_scopes` string: Authorization scopes. If not provided, default scopes will be used. Default scopes: openid email profile offline_access groups . This parameter is not required if the purpose of the request is to disable Custom OIDC
  - `user_roles_claim` string: User roles claim. If not provided, the default claim will be used. Default claim: roles . This parameter is not required if the purpose of the request is to disable Custom OIDC
  - `user_display_name_claim` string: User display name claim. If not provided, the default claim will be used. Default claim: preferred_username . This parameter is not required if the purpose of the request is to disable Custom OIDC
  - `is_issuer_validation_enabled` boolean: Determines whether issuer validation is enabled or not. This parameter is not required if the purpose of the request is to disable Custom OIDC
  - `groups_mapping_type` string: Groups mapping type. This parameter is not required if the purpose of the request is to disable Custom OIDC
  - `groups_mapping_rules` object: Groups mapping rules. Required if groups_mapping_type is custom . This parameter is not required if the purpose of the request is to disable Custom OIDC

## Response `200`

Successful response

## Other responses

- `default`: Error response. Depending on the error, either a 4xx or 5xx response status is returned.

---

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