The Open API specification for Synapse is now available for download!

Download Open API Spec

OIDConnectConfiguration

org.sagebionetworks.repo.model.oauth.OIDConnectConfiguration

OpenID Provider Configuration, described by OpenID Connect Core 1.0. Fields are defined by the OpenID Provider Metadata.

Field Type Description
issuer STRING The issuer of OIDC tokens and claims.
authorization_endpoint STRING URL of the Synapse OAuth 2.0 Authorization Endpoint
token_endpoint STRING URL of the Synapse OAuth 2.0 Token Endpoint
revocation_endpoint STRING URL of the Synapse OAuth 2.0 Revocation Endpoint
userinfo_endpoint STRING URL of the Synapse UserInfo Endpoint
jwks_uri STRING URL of the Synapse JSON Web Key Set [JWK] document.
registration_endpoint STRING URL of the Synapse Dynamic Client Registration Endpoint
scopes_supported ARRAY<OAuthScope> List of the OAuth 2.0 scope values that Synapse supports.
response_types_supported ARRAY<OAuthResponseType> List of the OAuth 2.0 response types that Synapse supports.
grant_types_supported ARRAY<OAuthGrantType> List of the OAuth 2.0 grant types that Synapse supports.
subject_types_supported ARRAY<OIDCSubjectIdentifierType> List of the subject identified types that Synapse supports.
id_token_signing_alg_values_supported ARRAY<OIDCSigningAlgorithm> List of the JWS signing algorithms (alg values) supported by Synapse for the ID Token to encode the Claims in a JWT
userinfo_signing_alg_values_supported ARRAY<OIDCSigningAlgorithm> List of the JWS signing algorithms (alg values) supported by the UserInfo Endpoint to encode the Claims in a JWT
request_object_signing_alg_values_supported ARRAY<STRING> List of signing algorithms supported for signing request objects, or '["none"]' if passing by 'request' parameter is unsupported. See OpenID Connect Core 1.0
claims_supported ARRAY<OIDCClaimName> List of the Claim Names of the Claims that the Synapse MAY be able to supply values for.
service_documentation STRING URL of a page containing human-readable information that developers might want or need to know when using Synapse.
claims_parameter_supported BOOLEAN Boolean value specifying whether Synapse supports use of the claims parameter, with true indicating support.
token_endpoint_auth_methods_supported ARRAY<STRING> a list of Client Authentication methods supported by Synapse's Token Endpoint. See OpenID Connect Core 1.0 Client Authentication