文档 API参考

OAuth客户

JSON格式

OAuth客户端表示为具有以下属性的JSON对象:

的名字 类型 只读 强制性的 描述
公司 字符串 假 假 要求用户授予对应用程序的访问权限时显示的公司名称。
created_at 字符串 真正的 假 创建客户端的时间
描述 字符串 假 假 当用户考虑批准对应用程序的访问时显示给用户的客户端的简短描述
全球 布尔 真正的 假 该客户端是否全局可访问。看到设置一个全局OAuth客户端
id 整数 真正的 假 在创建时自动分配
标识符 字符串 假 真正的 此客户端的唯一标识符
logo_url 字符串 真正的 假 此记录的API标志url
的名字 字符串 假 真正的 此客户端的名称
redirect_uri 数组 假 假 此客户端的有效重定向uri数组
秘密 字符串 真正的 假 客户机密。在创建时自动生成，仅在当时完整返回
updated_at 字符串 真正的 假 客户端最后一次更新的时间
url 字符串 真正的 假 该记录的API url
user_id 整数 假 真正的 创建客户端的管理员的id

例子

             

              
｛“公司”：“亚博Zendesk”，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“描述”：“亚博Zendesk测试客户端”，“id”：1，“标识符”：“test_client”，“名称”：“我的测试客户端”，“redirect_uri”：［“https://example.com/callback”］，“秘密”：“af3t24tfj34h43s……”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/clients/1.json”，“user_id”：29｝

客户列表

  • GET / api / v2 / oauth /客户
  • GET / api / v2 /用户/我/ oauth / clients.json

允许

  • 管理员

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/oauth/clients.json＼- v - u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/oauth/clients”方法: =“获得”要求的事情，犯错: =http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res，犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/oauth/clients”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/oauth/clients”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/oauth/clients”）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
// Status 200 OK｛“客户”：［｛“公司”：“亚博Zendesk”，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“描述”：“亚博Zendesk测试客户端”，“id”：223443，“标识符”：“test_client”，“名称”：“统计部件”，“redirect_uri”：［“https://example.com/callback”］，“秘密”：“af3t24tfj34h43s……”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/clients/223443.json”，“user_id”：29｝，｛“公司”：“亚博Zendesk”，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“描述”：“亚博Zendesk移动客户端”，“id”：8678530，“标识符”：“mobile_client”，“名称”：“亚博Zendesk移动”，“redirect_uri”：［“https://example.com/callback”］，“秘密”：“af3t24tfj34h43s……”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/clients/8678530.json”，“user_id”：29｝］｝

显示客户端

  • GET / api / v2 / oauth /客户/ {oauth_client_id}

允许

  • 管理员

参数

的名字 类型 在 要求 描述
oauth_client_id 整数 路径 真正的 OAuth客户端ID

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/oauth/clients/｛oauth_client_id｝. json＼- v - u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”方法: =“获得”要求的事情，犯错: =http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res，犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
// Status 200 OK｛“客户端”：｛“公司”：“亚博Zendesk”，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“描述”：“亚博Zendesk测试客户端”，“id”：223443，“标识符”：“test_client”，“名称”：“测试客户端”，“redirect_uri”：［“https://example.com/callback”］，“秘密”：“af3t24tfj34h43s……”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/clients/223443.json”，“user_id”：29｝｝

创建客户端

  • POST / api / v2 / oauth /客户

允许

  • 管理员

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/oauth/clients.json＼-x post -h“application / json内容类型:＼- d“{”客户端”:{“名称”:“测试客户端”,“标识符”:“unique_id}}”- v - u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/oauth/clients”方法: =“职位”要求的事情，犯错: =http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res，犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“职位”，url：“https://support.亚博zendesk.com/api/v2/oauth/clients”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/oauth/clients”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“职位”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/oauth/clients”）请求＝网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

201年创建 
              

               
//状态201已创建｛“客户端”：｛“公司”：“亚博Zendesk”，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“描述”：“亚博Zendesk测试客户端”，“id”：223443，“标识符”：“test_client”，“名称”：“测试客户端”，“redirect_uri”：［“https://example.com/callback”］，“秘密”：“af3t24tfj34h43s……”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/clients/223443.json”，“user_id”：29｝｝

更新客户端

  • 把/ api / v2 / oauth /客户/ {oauth_client_id}

允许

  • 管理员

参数

的名字 类型 在 要求 描述
oauth_client_id 整数 路径 真正的 OAuth客户端ID

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/oauth/clients/｛oauth_client_id｝. json＼-x乘以-h“application / json内容类型:＼- d'{"client": {"name": "My New OAuth2 client"}}'- v - u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”方法: =“把”要求的事情，犯错: =http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res，犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“把”，url：“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“把”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”）请求＝网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
// Status 200 OK｛“客户端”：｛“公司”：“亚博Zendesk”，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“描述”：“亚博Zendesk测试客户端”，“id”：223443，“标识符”：“test_client”，“名称”：我的新OAuth2客户端，“redirect_uri”：［“https://example.com/callback”］，“秘密”：“af3t24tfj34h43s……”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/clients/223443.json”，“user_id”：29｝｝

删除客户端

  • 删除/ api / v2 / oauth /客户/ {oauth_client_id}

允许

  • 管理员

参数

的名字 类型 在 要求 描述
oauth_client_id 整数 路径 真正的 OAuth客户端ID

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/oauth/clients/｛oauth_client_id｝. json＼-X DELETE -v -u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”方法: =“删除”要求的事情，犯错: =http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res，犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“删除”，url：“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“删除”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/oauth/clients/223443”）请求＝网：：HTTP：：删除．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

204无内容 
              

               
//状态204无内容零

生成的秘密

  • 把/ api / v2 / oauth /客户/ {oauth_client_id} / generate_secret

允许

  • 管理员

参数

的名字 类型 在 要求 描述
oauth_client_id 整数 路径 真正的 OAuth客户端ID

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/oauth/clients/｛oauth_client_id｝/ generate_secret.json＼-X PUT -v -u｛email_address｝：｛密码｝
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/v2/oauth/clients/223443/generate_secret”方法: =“把”要求的事情，犯错: =http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res，犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“把”，url：“https://support.亚博zendesk.com/api/v2/oauth/clients/223443/generate_secret”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求url＝“https://support.亚博zendesk.com/api/v2/oauth/clients/223443/generate_secret”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“把”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/oauth/clients/223443/generate_secret”）请求＝网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
// Status 200 OK｛“客户端”：｛“公司”：“亚博Zendesk”，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“描述”：“亚博Zendesk测试客户端”，“id”：223443，“标识符”：“test_client”，“名称”：“测试客户端”，“redirect_uri”：［“https://example.com/callback”］，“秘密”：“af3t24tfj34h43s……”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/clients/223443.json”，“user_id”：29｝｝