Enable or disable an API client
    • 19 Oct 2022
    • 1 minute to read

    Enable or disable an API client

    Article Summary

    After setting up an API client, you can later choose to enable or disable it as required. 

    Disabling a client means the OAuth 2 provider is also disabled, so any requests made using tokens based on that client will no longer be authenticated. When you re-enable a client, any existing access tokens will immediately start working again. Disabling is useful if you want to temporarily remove access without permanently deleting the client, or if you want to configure the client while it's disabled then enable it quickly later.

    To enable or disable a client, follow these steps:

    1. Navigate to Quick-access menu > Development > API > API clients.
    2. For the client you want to enable/disable, select the icon of three dots (three_dots(1)).
    3. From the dropdown menu, select Enable or Disable. Disabled clients will not be available to use.
    4. A message will appear to confirm that the client has been enabled or disabled.

    Alternatively, you can check or uncheck the Enabled checkbox when editing the client details.

    © Copyright 2024 Totara Learning Solutions. All rights reserved.

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.