This page shows how to create a project, view project information, and manage app certificates in Agora Console.
Restrictions
- If your account has multiple members, only those with the role of Admin, Engineer, or an authorized custom role have access to the Project Management page.
- Each Agora account can create up to 20 projects including deleted projects. If you need to create more projects, contact Agora by submitting a ticket.
The Agora accounts created before October 1, 2021 can create up to 10 projects each including deleted projects. If you need to create more projects, contact Agora by
submitting a ticket.
Create an Agora project
To create an Agora project, do the following:
- Enter the Project Management page.
- Click Create.
- Follow the on-screen instructions to enter a project name and use case, and check Secured mode: APP ID + Token (Recommended) as the authentication mechanism.
- Click Submit. You can now see the project on the Project Management page.
For a project listed on the Project Management page, you can do the following:
- View basic information, such as the stage, name, and creation date of the project.
- Click to copy the App ID of the project.
- Click Config to enter the project detail page, where you can view and configure App certificate, Project status, and Extensions
Manage app certificates
An app certificate is a string generated by Console to enable token authentication. For different security requirements, Agora provides the following app certificate options:
- Primary certificate: This certificate is used to generate tokens for temporary use or production environments.
- Secondary certificate: This certificate is used to generate tokens for production environments only and does not apply to RESTful APIs.
- No certificate: This certificate appears only if you choose APP ID as the authentication mechanism when creating a project. In this case, you can complete authentication with the App ID only.
If you have both No certificate and Primary/Secondary certificate in your project, you can either complete authentication with the App ID only or use tokens generated by the Primary/Secondary certificate for authentication.
Enable the primary certificate
For high-security scenarios, enable the primary certificate as follows:
If you choose APP ID + Token as the authentication mechanism when creating a project, the primary certificate is enabled by default. On the project detail page, you can click the under Primary certificate to view and copy it. In this case, you need to use the token generated by the Primary certificate for authentication.
If you choose APP ID as the authentication mechanism when creating a project, you need to enable the primary certificate manually. On the project detail page, click the switch under Primary certificate to enable it.
Once the primary certificate is enabled, you can click to view and copy it. In this case, you can either complete authentication with the App ID only or use tokens generated by the Primary certificate for authentication.
Enable the secondary certificate
If you need to change the primary certificate after enabling it, you can enable the secondary certificate.
On the project detail page, click the switch under Secondary certificate.
Once the secondary certificate is enabled, you can click to view and copy it. In this case, both the primary and secondary certificate can be used to generate tokens for authentication.
Switch to a new primary certificate
If the primary certificate is exposed to security risks, you can use the secondary certificate as a new primary certificate and delete the original primary certificate.
To switch to a new primary certificate, follow these steps:
- Enable the secondary certificate.
- On the project detail page, click Set as primary to the right of Secondary certificate. The secondary certificate and the primary certificate are switched.
- Click the switch under Secondary certificate to disable the current secondary certificate.
- Follow the on-screen instructions to complete verification. If verified successfully, the status of the secondary certificate is updated to Disabled, and the Delete button appears.
- Click the Delete button.
- Follow the on-screen instructions to complete verification. If verified successfully, the Delete button disappears, and the current secondary certificate (the original primary certificate) is deleted.
Agora recommends that you switch to a new primary certificate only when it is necessary. Note that after you switch the primary certificate and the secondary certificate, the following effects occur:
Users cannot join a channel through the tokens previously generated by the primary or secondary certificate. Users who have joined a channel cannot get new tokens through the renewToken
method.To avoid service disruption, ensure that most users have switched to the new certificate before deleting the old certificate. Once deleted, the certificate cannot be restored.
Delete the no certificate option
No certificate is enabled only if you choose APP ID as the authentication mechanism when creating a project. No certificate means that your project uses only the App ID for authentication, which is less secure.
To delete the no certificate option, follow these steps:
- Enable the primary certificate.
- Click the Delete button to the right of No certificate.
- Follow the on-screen instructions to complete verification.
Once you delete the No certificate option, you can no longer complete authentication with the App ID only and the project cannot return to the status of No certificate.