OAuth令牌

JSON格式

OAuth令牌表示为具有以下属性的JSON对象:

例子

             

              
｛“client_id”：41，“created_at”：“2009 - 05 - 13 - t00:07:08z”，“expires_at”：“2011 - 07 - 22 - t00:11:12z”，“id”：1，“refresh_token”：“af3t24tfj34h43s……”，“范围”：［“读”］，“令牌”：“af3t24tfj34h43s……”，“url”：“https://example.亚博zendesk.com/api/v2/tokens/1.json”，“used_at”：“2010 - 01 - 22 t00:11:12z”，“user_id”：29｝
             

列表标记

• GET / api / v2 / oauth /令牌

返回令牌的属性。出于安全考虑，只包含每个访问令牌的前10个字符。

允许

• 管理员

参数

使用旋度

             

              
卷曲https://{subdomain}.zen亚博desk.com/api/v2/oauth/tokens.json \-v -u {email_address}:{password}
             

示例响应(年代)

              

               
状态200 OK｛“令牌”:[｛“client_id”:41岁“created_at”:“2009 - 05 - 13 t00:07:08z”,“expires_at”:“2011 - 07 - 22 t00:11:12z”,“id”:223443年,:“refresh_token af3t24tfj34h43s……”“范围”:[“读”),“令牌”:“af3345kdj3”,“url”:“https://example.z亚博endesk.com/api/v2/tokens/223443.json”,“used_at”:“2010 - 01 - 22 t00:11:12z”,“user_id”:29}，｛“client_id”:41岁“created_at”:“2009 - 05 - 13 t00:07:08z”,“expires_at”:“2011 - 07 - 22 t00:11:12z”,“id”:8678530,:“refresh_token af3t24tfj34h43s……”“范围”:[“读”),“令牌”:“34 hjgkjas4”,“url”:“https://example.z亚博endesk.com/api/v2/tokens/8678530.json”,“used_at”:“2010 - 01 - 22 t00:11:12z”,“user_id”:29｝］｝
              

展示牌

• GET / api / v2 / oauth /令牌/ {oauth_token_id}
• GET / api / v2 / oauth /令牌/ current.json

返回指定令牌的属性。出于安全考虑，只包含访问令牌的前10个字符。

在第一个端点，id是令牌id，而不是完整的令牌。

在第二个端点中，包含授权:持票人头的完整标记，以获取其相关属性。例子:

             

              
卷曲https://{subdomain}.zen亚博desk.com/api/v2/oauth/tokens/current.json \-H '授权:持有者${authToken}' \-v -u {email_address}:{password}
             

允许

• 管理员、代理、最终用户

参数

使用旋度

             

              
卷曲https://{subdomain}.zen亚博desk.com/api/v2/oauth/tokens/{oauth_token_id}.json \-v -u {email_address}:{password}
             

示例响应(年代)

              

               
状态200 OK｛“令牌”:{“client_id”:1234年,“created_at”:“2009 - 05 - 13 t00:07:08z”,“expires_at”:“2011 - 07 - 22 t00:11:12z”,“id”:223443年,:“refresh_token af3t24tfj34h43s……”“范围”:[“读”,“写”),“令牌”:“af3345kdj3”,“url”:“https://example.z亚博endesk.com/api/v2/tokens/223443.json”,“used_at”:“2010 - 01 - 22 t00:11:12z”,“user_id”:29｝｝
              

创建令牌

• POST / api / v2 / oauth /令牌

返回指定的OAuth访问令牌范围．

不使用刷新令牌。访问令牌不会过期，但可能会过期撤销．

有关教程，请参见使用API创建和使用OAuth令牌．

请注意:对于OAuth授权代码或密码授予类型，请使用为授权类型创建令牌端点。这两个api不共享相同的路径、JSON格式或请求参数。但是，这两个api都返回可用于的访问令牌验证API请求．

允许

• 管理员

请求参数

POST请求接受一个“令牌”对象，该对象包含OAuth客户端的资源id和作用域。

作用域

的作用域参数定义使用令牌进行身份验证的请求是否可以发布、放置和删除数据，还是只能获取数据。

请注意:不要混淆作用域参数(复数)范围参数(单数)grant-type令牌．

的作用域参数是一个字符串数组，每个字符串指定一个资源名和一个访问设置。访问是“读”或“写”。如果不指定资源，则假定可以访问所有资源。亚博电脑端如果您没有指定访问权限，则假定有读写权限。

语法如下:

"scopes":[资源:scope，…]

在哪里资源是可选的。

例子

“范围”(“读”):

“范围”:(“门票:阅读”)

要对资源进行读写访问，需要指定两个作用域:

"scopes": ["users:read"， "users:write"]

只给一个资源写权限，而给其他所有资源读权限:

"scopes": ["organizations:write"， "read"]

请注意:即使指定了无效的作用域，端点也会返回访问令牌。使用令牌发出的任何请求都将返回一个“Forbidden”错误。

可用范围

• 读-允许访问GET端点。包括

侧加载相关资源的权限亚博电脑端

• 写-允许访问POST、PUT和DELETE端点
• 模仿-允许Zendes亚博k支持管理员代表

最终用户。看到代表最终用户发出API请求

亚博电脑端可以限定范围的资源

• 票
• 用户
• 审计日志(只读)
• 组织
• hc
• 应用程序
• 触发器
• 自动化
• 目标
• 人则
• 宏
• 请求
• satisfaction_ratings
• dynamic_content
• Any_channel(只写)
• Web_widget(只写)

参数

使用旋度

             

              
卷曲https://{subdomain}.zen亚博desk.com/api/v2/oauth/tokens.json \-H "Content-Type: application/json" \- d '{“令牌”:{“client_id”:1234年,“范围”:[“读”、“写”]}}‘\-X POST -v -u {email_address}:{password}
             

示例响应(年代)

              

               
状态201已创建｛“令牌”:{“client_id”:1234年,“created_at”:“2009 - 05 - 13 t00:07:08z”,“expires_at”:“2011 - 07 - 22 t00:11:12z”,“id”:223443年,:“refresh_token af3t24tfj34h43s……”“范围”:[“读”,“写”),“令牌”:“af3345kdj3”,“url”:“https://example.z亚博endesk.com/api/v2/tokens/223443.json”,“used_at”:“2010 - 01 - 22 t00:11:12z”,“user_id”:29｝｝
              

撤销令牌

• 删除/ api / v2 / oauth /令牌/ {oauth_token_id}
• 删除/ api / v2 / oauth /令牌/ current.json

允许

• 管理员、代理、最终用户

参数

使用旋度

             

              
卷曲https://{subdomain}.zen亚博desk.com/api/v2/oauth/tokens/{oauth_token_id}.json \-X DELETE -v -u {email_address}:{password}
             

示例响应(年代)

              

               
204无内容