OIDC Clients

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

DNAnexus Open ID Connect (OIDC) clients are web-based applications that let end-users sign in using their DNAnexus Platform credentials. For details on how to set up OIDC for your web apps, see Enabling Web Application Users to Log In with DNAnexus Credentials.

API Method Specifications

API method: /oidcClient-xxxx/describe

Specification

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

Outputs

The following fields are returned for all users.

• clientId string 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 only for logged-in 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 registered author of a web app configured as an OIDC client, a call to this method either initializes or resets the OIDC 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.