Skip to content
Authrim

Discover an OIDC provider configuration.

POST
/api/admin/external-providers/discover-oidc
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/external-providers/discover-oidc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://accounts.google.com" }'

Fetches and sanitizes an external OIDC discovery document for a supplied HTTPS issuer, discovery URL, or RFC 7033 WebFinger resource. WebFinger responses require an exact subject match and the OpenID Connect issuer relation. The implementation blocks localhost, private/internal hosts, non-standard ports, oversized responses, unsafe redirects, and non-JSON responses.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
One of:
object
url
required

HTTPS issuer URL or full OpenID Provider Configuration URL.

string format: uri
resource

An acct URI or HTTPS URL to resolve using WebFinger.

string
key
additional properties
Example 
{
  "url": "https://accounts.google.com"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Sanitized OIDC discovery response.

Media type application/json
object
issuer
required
string format: uri
authorization_endpoint
required
string format: uri
token_endpoint
required
string format: uri
userinfo_endpoint
string format: uri
jwks_uri
string format: uri
scopes_supported
Array<string>
discovery_source
object
method
required
string
Allowed values: webfinger
resource
required
string
webfinger_endpoint
required
string format: uri
key
additional properties
key
additional properties
Example 
{
  "discovery_source": {
    "method": "webfinger"
  }
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}