This article shows how to create and manage projects in Agora Console.

Project members with the role of Admin or Engineer have access to the Project Management page.

Create a new project

You can create up to 10 projects, including the deleted ones. If you need to create more projects, please contact us by submitting a ticket.

To create a new project, follow these steps:

  1. Log in to Agora Console, and click img in the left navigation menu to enter the Project Management page.

  2. Click Create. img

  3. Enter your project name and select your authentication mechanism in the dialog box.

    We provide two authentication mechanisms:
    • APP ID + APP Certificate + Token (Recommended)
    • APP ID
    We recommend that you use the APP ID + APP Certificate + Token authentication mechanism which is more secure:

  4. Click Submit, and you can see the project on the Project Management page. Agora automatically assigns each project an App ID as a unique identifier.

Manage your projects

For created projects, you can also do the following on the Project Management page:

img

  • Search: Enter a project name or App ID, and click to search for a project.

  • View basic project information, including:

    • Stage: Testing, Live, and Not Specified
    • Project name
    • Creation date
    • App ID
  • Click img to enable real-time communication on the web page.

  • Click img to generate a temporary token for authentication during the project testing stage.

    You can only use the primary app certificate to generate a temporary token. See Enable the primary certificate.
  • Click Usage to view the amount of Agora services the project uses.

  • Click Edit to view the Edit Project page. You can edit your project information, including the following:

    • Project stage

    • Project name

    • App certificate

    • Temporary token

    • Project status

Manage your app certificates

An app certificate is a string generated from Agora Console, and it enables token authentication. For different security requirements, Agora provides two types of app certificates. The differences are as follows:

  • Primary certificate: You can use a primary certificate to generate tokens, including temporary tokens. You cannot delete a primary certificate.
  • Secondary certificate: You can use a secondary certificate to generate tokens, except for temporary tokens. After enabling a secondary certificate, you can switch it and the primary certificate, or delete it.
    • No certificate means that your project uses only the App ID for authentication. No certificate appears only if you choose the APP ID authentication mechanism when creating a project.
    • The secondary certificate does not applies to Agora RESTful API.

Enable a primary certificate

For scenarios requiring high security, you can enable a primary certificate as follows:

  • If you choose the APP ID + APP Certificate + Token authentication mechanism when creating a project, Agora enables the primary certificate for you by default. On the Edit Project page, you can click to view and copy the primary certificate.

  • If you choose the APP ID authentication mechanism when creating a project, you need to enable the primary certificate manually. On the Edit Project page, find Primary certificate and click Enable. Once the primary certificate is enabled, you can click to view and copy the primary certificate, and use either an App ID or the token generated by the primary certificate for authentication.

Enable a secondary certificate

After successfully enabling the primary certificate, you can enable the secondary certificate when you need to change app certificates.

On the Edit Project page, find Secondary certificate, and click Enable. Once the secondary certificate is enabled, you can click to view and copy the secondary certificate, and use either the primary certificate or the secondary certificate to generate tokens for authentication.

Switch and delete the primary certificate

After enabling both the primary certificate and the secondary certificate, if the primary certificate is exposed to security risks, you can switch it to Secondary certificate and delete it.

To switch and delete the primary app certificate, do the following:

  1. Find Secondary certificate, click Set as primary to switch the secondary certificate and the primary certificate. Once you switch the primary certificate to the secondary certificate, all temporary tokens become invalid.
  2. Click Delete to delete the original primary certificate. You cannot restore the deleted certificate, and all tokens generated by the original primary certificate become invalid. You need to use a new primary certificate to generate tokens for authentication.
  3. After deletion, the status of the secondary certificate becomes Disabled. A new secondary certificate is generated when you click Enable next time.

Delete No certificate

No certificate is enabled only if you choose the APP ID authentication mechanism when creating a project. No certificate means that your project uses only the App ID for authentication, which is less secure.

If you need to raise the security level, you can click Enable to enable the primary certificate, and generate a token for authentication. After enabling the primary certificate, you can delete No certificate.

Once you delete No certificate, you can no longer use only the App ID for authentication, and the project cannot enable No certificate again.