> For the complete documentation index, see [llms.txt](https://guide.fariaedu.com/integrations-portal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.fariaedu.com/integrations-portal/schoolsbuddy/recipes/schoolsbuddy-api-authentication-creating-an-auth-client.md).

# SchoolsBuddy API Authentication: Creating an Auth Client

#### Step 1: Accessing the API Manager

1. Log in to your SchoolsBuddy administrative portal.
2. Click on the Settings (cog icon) in the top right-hand navigation bar.
3. In the left-hand sidebar menu, under Main Settings, select API Manager.

<figure><img src="/files/nrxhW0a6ZODwdJMDhDLF" alt=""><figcaption></figcaption></figure>

#### Step 2: Creating a New Client

Once in the API Manager, click the button to initiate a new client creation. A modal titled "Create new client" will appear:

1. Client ID & Secret: Click the Refresh/Rotate icons next to the Client Id and Client Secret fields to generate unique identifiers for this integration.
2. Client Name: Enter a descriptive name (e.g., "Demo API Token" or "Data Sync Integration") to help you identify the purpose of this client later.
3. Description: (Optional) Add internal notes regarding who requested the token or what system it is connecting to.
4. Allowed Scopes: Select the specific permissions this client should have. For example:
   * Contacts: Read or Write access to contact data.
   * Events: Read access to school events.
5. Click + Create Client.

<figure><img src="/files/AUKhA5YtmtxwEEoNSSIL" alt=""><figcaption></figcaption></figure>

#### Step 3: Saving Your Credentials

After clicking create, a confirmation screen will appear displaying your active credentials.

> Important Security Warning: This is the only time you will be able to view the Client Secret. Make sure to copy it and store it in a secure location (such as a password manager) immediately.

1. Use the Copy buttons next to the Client Id and Client Secret.
2. Once you have securely saved both strings, click Done

<figure><img src="/files/2qOWOv0LLCwZ0baABSHr" alt=""><figcaption></figcaption></figure>

#### Troubleshooting & Security

* Secret Visibility: If you lose your Client Secret, you cannot retrieve it. you will need to delete the existing client in the API Manager and create a new one.
* Scopes: Always follow the Principle of Least Privilege - only select the minimum scopes required for your integration to function.
* Deactivation: If you believe a Client Secret has been compromised, navigate back to the API Manager to revoke or delete the client immediately.