OIDC Clients

Learn how to use API methods related to enabling users of a third-party web app to log into that app using DNAnexus Platform login credentials.

If you're the developer of an web app that will be used by DNAnexus Platform users, you can enable them to log into your app, easily and securely, using Platform credentials. See this documentation for details on how to set this up.

API Method Specifications

API Method: /oidcClient-xxxx/describe

Specification

If the requesting user is the same as the user registered as the author of a web app that is configured as an OIDC client, a call to this method returns detailed information on that OIDC client.

Outputs

• clientId string/UUID The client ID of the app that is configured as an OIDC client

• clientName string The name of the app

The following fields are returned for a logged-in user only. Fields above are available to all users.

• homepageUri string The URL of the page used to access and use the app

• policyUri string The URL of the app's privacy policy document

• tosUri string The URL of the app's terms of service document

API Method: /oidcClient-xxxx/resetClientSecret

Specification

If the requesting user is the same as the user registered as the author of a web app that is configured as an OIDC client, a call to this method will either initialize or reset the client's client secret.

Outputs

• clientId string The client ID of the app that is configured as an OIDC client

• clientSecret string The generated client secret