Global OAuth Clients

JSON Format

Global OAuth Clients are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
company string true false The company that users are asked to approve access to
description string true false A short description of the client
id integer true false Automatically assigned when the client is created
identifier string true false The unique identifier for the client
logo_url string true false The API logo url of this record
name string true false The name of the client

Example

{  "company": "Zendesk",  "description": "Zendesk global Client",  "id": 1,  "identifier": "global_client",  "logo_url": "https://example.com/logo",  "name": "Global Client"}

List Global OAuth Clients

  • GET /api/v2/oauth/global_clients

Returns all the global OAuth clients that users on your account have authorized.

Allowed For

  • Admins

Using curl

curl https://{subdomain}.zendesk.com/api/v2/oauth/global_clients.json \  -v -u {email_address}:{password}

Example Response

Status 200 OK
{  "global_clients": [    {      "id": 223443,      "name": "Stats Widget"    },    {      "id": 8678530,      "name": "Zendesk Mobile"    }  ]}