OpenID Connect configuration example

OpenID Connect is an open standard and decentralized authentication protocol that allows authentication by participating sites, known as relying parties (RP). A third-party service lets users log into multiple unrelated websites using a single identity and password. OpenID Connect is an identity layer on top of the OAuth 2.0 protocol, allowing web-based, mobile, and JavaScript clients to request information about authenticated end-users.

The following example is a configuration of the OpenID Connect authentication service provider.

RequestResponse

"open_id_connect": [
    {
        "authentication_mode": "Passive",
        "client_id": "<ClientId>",
        "client_secret": "<ClientSecret>",
        "authority": "<Authority>",
        "get_claims_from_user_info_endpoint": false,
        "metadata_address": "<MetadataAddress>",
        "max_age": "<MaxAge>",
        "signed_out_redirect_uri": "<URL>",
        "authentication_method": "<AuthenticationMethod>",
        "response_mode": "<ResponseMode>",
        "response_type": "<ResponseType>",
        "prompt": "<Prompt>",
        "email_claim_type": "<ClaimTypeOverride>",
        "external_user_creation_url": "https://www.registerme.com",
        "is_enabled": true,
        "messages": {
            "signIn": "T_translationKey",
            "signInDescription": "T_translationKey",
            "signInTitle": "T_translationKey"
        },
        "provider_name": "OpenIDConnect,",
        "username_claim_type": "<ClaimTypeOverride>",
        "is_internal": false,
        "clear_default_scope": false,
        "scope": [
            "<CustomScope>"
        ]
    }
]

Note

The OpenID Connect specification includes many properties. You can find more information about these properties and their implementation in the official OpenID Connect, OAuth 2, or .NET OpenID Connect specifications.

Do you have some feedback for us?

If you have suggestions for improving this article,