Skip to main content

Introduction

Developer Console is a Web console for developers to manage their client applications. It is not explicitly written in any specification, but you have to provide third-party developers (and yourself) with a Web console for them to manage their client applications. It is a time-consuming task to develop such a tool, but you are free from the task. Authlete offers Developer Console and you can let your third-party developers use it. To let third-party developers login Developer Console, you are required to implement a developer authentication callback endpoint. On the other hand, if you are the only developer for your service, you don’t have to implement the endpoint. Read “Developer Authentication Callback” for details. Anyway, this document describes how to use Developer Console.

Login

Developer Console for a service is provided at the URL below. https://cd.authlete.com/SERVICE_API_KEY/ The login form accepts a pair of ID & password of a developer. It is different from the ID & password of your Authlete account. Authlete delegates developer authentication to your developer authentication callback endpoint, so any developer cannot login Developer Console until you implement the endpoint for the service. cd_console_login
However, as a special behavior, the login form accepts the pair of API key & API secret of the corresponding service as if it were a valid pair of ID & password of a developer. Therefore, if you are the only person who manages client applications for your service, you don’t have to implement a developer authentication callback endpoint. Anyway, you (the service owner of the service) can login Developer Console with the API key and the API secret of the service without implementing a developer authentication callback endpoint. It is only when you want to let other developers use Developer Console that you are required to implement a developer authentication callback. Read “Developer Authentication Callback” for details.

List Apps

To list client applications, do either of the following.
  • Open “Menu” on the left and select “Your Apps”.
  • Access the URL below directly. https://cd.authlete.com/service-api-key/clients/list
Right after registration, your first service has one client application, so if you login Developer Console with the API key and the API secret of the service, the list will appear like the following. cd_console_app_list
By clicking the client name, you can display App Details page of the client application. In the figure, “Client 5008706718” is the client name. “Edit” button on the right is a button to start editing configuration parameters of the client application. See “Edit App” for details. “Delete” button is a button to delete the client application. See “Delete App” for details.

Create App

It is very easy to create a new client application using Developer Console. To start creating a new client application, do one of the following.
  • Open “Menu” on the left and select “Create App”.
  • Click “Create App” button in the app list page.
  • Access the URL below directly. https://cd.authlete.com/service-api-key/clients/new
As the number of configuration parameters of a client application is not small, they are categorized. In Create App page, there are tabs for each category. Change the values of the configuration parameters as you like, or leave all of them untouched to use their default values. See Edit App for details about the configuration parameters. After editing, click “Create” button at the bottom of Create App page to create a new service. That’s all.

There are two upper limits on the number of client applications. One is the upper limit per developer. Its value is a configuration parameter of a service and can be changed using Service Owner Console. The other is the upper limit per service owner. Its value is determined based on your plan. For example, 10 is the upper limit for Free plan. See “Pricing” page for details.

Edit App

1. Start Editing

To start editing configuration parameters of a client application, do either of the following.
  • Click “Edit” button in Your Apps page or App Details page.
  • Access the URL below directly. Don’t forget to replace service-api-key and client-id. https://cd.authlete.com/service-api-key/clients/client-id/edit

2. Configuration Categories

As the number of configuration parameters of a client application is not small, they are categorized. In Edit App page, there are tabs for the categories.

3. Configuration: Basic

4. Configuration: Authorization

5. Configuration: ID Token

6. Configuration: JWK Set

7. Configuration: OIDC Endpoint

8. Configuration: Document

9. Apply Changes

After editing configuration parameters, click “Update” button at the bottom of Edit App page to apply the changes.

Delete App

To delete a client application, click “Delete” button in Your Apps page or App Details page. A confirmation dialog is displayed. Initially, “Delete” button in the dialog is disabled. Input the name of the client application in the text field in the dialog, and “Delete” button is enabled. cd_console_delete_dialog_2
Click “Delete” button in the dialog, and the client application is deleted.