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

Download Open API Spec

OAuthClient

org.sagebionetworks.repo.model.oauth.OAuthClient

OAuth 2.0 Client metadata described in OpenID Connect Core 1.0 Client Metadata

Field Type Description
client_id STRING The unique ID for the OAuth client, created by Synapse
client_name STRING Name of the Client to be presented to the End-User.
redirect_uris ARRAY<STRING> Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request. If the 'sector_identifier_uri' is provided then the URIs in this list must be in the list of URIs in the JSON document referenced by the sector_identifier_uri.
verified BOOLEAN Initially false, to verify your client please see the Synapse OAuth Server Documentation
client_uri STRING URL of the home page of the Client. The value of this field MUST point to a valid Web page.
policy_uri STRING URL that the Relying Party Client provides to the End-User to read about the how the profile data will be used. The value of this field MUST point to a valid web page.
tos_uri STRING URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service. The value of this field MUST point to a valid web page.
sector_identifier_uri STRING URL using the https scheme to be used in calculating Pseudonymous Identifiers by Synapse. The URL must reference a file with a single JSON array of redirect_uri values. Synapse will utilize the sector_identifier_uri value provided in the Subject Identifier calculation for pairwise identifiers.
sector_identifier STRING The sector identified, computed by the server from the redirect_uris and sector_identifier_uri fields as described in OpenID Connect Core 1.0 Pairwise Identifier Algorithm
userinfo_signed_response_alg OIDCSigningAlgorithm The JWT signing algorithms supported by Synapse
createdOn STRING The date this client was created.
modifiedOn STRING The date this client was last modified.
createdBy STRING The ID of the user that created this client.
etag STRING Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time a client is updated it is used to detect when a client's current representation of an entity is out-of-date.