Update an OpenID provider

put

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

namestringRequired

Name of the OpenID provider.

Body

application/json

admin_emailstring · nullableOptional

base_urlstringRequired

client_idstringRequired

client_secretstringRequired

create_accountbooleanRequired

directory_sync_admin_behaviorstringRequired

directory_sync_enabledbooleanRequired

directory_sync_group_matchstring · nullableOptional

directory_sync_intervalinteger · int32Required

directory_sync_targetstringRequired

directory_sync_user_behaviorstringRequired

directory_sync_user_groupsstring · nullableOptional

disable_password_managementbooleanRequired

display_namestring · nullableOptional

google_service_account_emailstring · nullableOptional

google_service_account_keystring · nullableOptional

jumpcloud_api_keystring · nullableOptional

kindstring · enumRequiredPossible values:

namestringRequired

okta_dirsync_client_idstring · nullableOptional

okta_private_jwkstring · nullableOptional

prefetch_usersbooleanRequired

username_handlingstring · enumRequiredPossible values:

Responses

200

OpenID provider updated.

No content

400

Invalid provider configuration.

application/json

401

Session is missing or invalid.

application/json

403

Requires admin privileges and an active enterprise license.

application/json

404

OpenID provider not found.

500

Unable to update OpenID provider.

application/json

put/api/v1/openid/provider/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/openid/provider/{name} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 630

{
  "admin_email": null,
  "base_url": "text",
  "client_id": "text",
  "client_secret": "text",
  "create_account": true,
  "directory_sync_admin_behavior": "text",
  "directory_sync_enabled": true,
  "directory_sync_group_match": null,
  "directory_sync_interval": 1,
  "directory_sync_target": "text",
  "directory_sync_user_behavior": "text",
  "directory_sync_user_groups": null,
  "disable_password_management": true,
  "display_name": null,
  "google_service_account_email": null,
  "google_service_account_key": null,
  "jumpcloud_api_key": null,
  "kind": "Custom",
  "name": "text",
  "okta_dirsync_client_id": null,
  "okta_private_jwk": null,
  "prefetch_users": true,
  "username_handling": "RemoveForbidden"
}

No content