Update an external identity provider.

PUT

/api/admin/external-providers/{id}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/external-providers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "provider_key": "google", "display_name": "Google", "issuer": "https://accounts.google.com" }'

Forwards the update body to the configured External IdP Bridge for the provider id path parameter.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

External provider identifier.

Request Body ^required

Media type application/json

Body forwarded to the configured External IdP Bridge admin endpoint.

object

key

additional properties

Example

{
  "provider_key": "google",
  "display_name": "Google",
  "issuer": "https://accounts.google.com"
}

Responses

200

Response proxied from the External IdP Bridge.

Media type application/json

JSON body returned by the configured External IdP Bridge admin endpoint.

object

key

additional properties

Example ^generated

{
  "additionalProperty": "example"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}