Turning on and off API access

Enable API access to allow users to authenticate using API tokens or passwords. API tokens protect agent passwords, while password access lets end users make authenticated requests. You can toggle these settings in the Admin Center. When disabled, tokens and passwords won't work, making access anonymous. Ensure you accept the necessary terms before activating API access.





Location: Admin Center > Apps and integrations > APIs > API
configuration

Users can access the Zendesk API using these authentication methods:
They can use an auto-generated password called an API token.
They can use an OAuth access token, which is different from an
API token.
End users can use API password access to make authenticated or anonymous
API requests.


Use the API configuration page to turn on password and API token access to
the Zendesk API. For OAuth access, see Using OAuth authentication with your
application. For more information about the Zendesk API, see the
Zendesk Developer Documentation.
This article includes these sections:

Activating API access
Turning on and off API token access
Turning on and off API password access for end users

Related articles:

Managing access to the Zendesk
API
Developer documentation: Security and authentication




Activating API access

If you’re accessing the Zendesk API for the first time, you need to accept the
Zendesk Terms of Service and the
Application Developer and API
Agreement.
To activate API access

In Admin Center, click
Apps and integrations in the sidebar, then select APIs > API
configuration.
Click the checkbox to accept the terms and agreements.
Click Get started.





Turning on and off API token access

You use API tokens to keep your agent’s passwords safe. When authenticating
with tokens, add /token to the end of your email address. API
token access is disabled by default. You must enable API token access before
users can use API tokens.
To turn on token access to the API

In Admin Center, click
Apps and integrations in the sidebar, then select APIs > API
configuration.
Select Allow API token access.
Click Save.

After you turn on API token access, you can generate API access
tokens. See Generating API tokens.
To turn off token access to the API

In Admin Center, click
Apps and integrations in the sidebar, then select APIs > API
configuration.
Deselect Allow API token access.
Click Save.

When you turn off token access, your tokens stop working. You’ll need to turn
token access back on to reactivate them.



Turning on and off API password access for end users


Note: Some older accounts may include a setting for
activating API password access for team members (in addition to API token
access). API password access for team members has
been deprecated and is not supported in new accounts.
By default, API password access for end users is turned off. Therefore,
end-user access is considered anonymous.

To turn on API password access for end users

In Admin Center, click
Apps and integrations in the sidebar, then select APIs > API
configuration.
Select Allow password access for end users.
Click Save.

After turning on API password access, end users can make authenticated or
anonymous API requests.
To turn off API password access for end users

In Admin Center, click
Apps and integrations in the sidebar, then select APIs > API
configuration.
Deselect Allow password access for end users.
Click Save.

After turning off API password access, end-user access is considered
anonymous.



//
const fast_path_style = document.createElement('style');
fast_path_style.innerHTML = `#article-body .fastpath{font-size:.9em;background-color:#f3f3f3;border:1px solid #d3d3d3;padding:10px 10px 8px;margin-bottom:16px}#article-body .fastpath::before{content:none!important}`;
document.head.appendChild(fast_path_style);
//

//
const banner_style = document.createElement('style');
banner_style.innerHTML = `#styled-article-body{padding:0 0 0}#article-body #docs-wmp-link{text-align:right;font-size:.8em}#article-body .article-banners{margin-bottom:1rem}#article-body .article-banner{border:1px solid #ded7ca;background-color:#f6f0e6;margin:0 0 3px;line-height:1}#article-body .article-banner table{border-collapse:collapse;border:none;margin:0;width:auto}#article-body .article-banner td{padding:8px 6px 8px;border:none;font-size:.85em}#article-body .article-banner td:nth-child(2){border-left:1px solid #d0c9bd}#article-body .article-banner strong{font-weight:400;text-shadow:0 0 1px rgba(0,0,0,.5);letter-spacing:.5px}@media (min-width:1600px){#article-body .article-banner td{font-size:.8em}#article-body .docs-wmp-link{font-size:.7em}}`;
document.head.appendChild(banner_style);