Documentation API Reference

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

Code Samples

旋度 
              

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

               
import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/oauth/global_clients"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
Java 
              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/oauth/global_clients").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
Nodejs 
              

               
varaxios=require('axios');varconfig={method:'GET',url:“https://support.zendesk.com/api/v2/oauth/global_clients',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
Python 
              

               
importrequestsurl="https://support.zendesk.com/api/v2/oauth/global_clients"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)
Ruby 
              

               
require"net/http"uri=URI("https://support.zendesk.com/api/v2/oauth/global_clients")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK 
              

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