组织会员

会员资格将用户与组织联系起来。组织可以有许多用户。如果帐户支持多个组织，则用户可以属于多个组织。您可以使用API列出组织中的用户，并重新分配组织成员。

JSON格式

组织成员关系表示为具有以下属性的JSON对象:

的名字	类型	只读	强制性的	描述
created_at	字符串	真正的	假	当创建此记录时
默认的	布尔	假	真正的	表示这是否是用户的默认组织成员。如果为false，则返回`零`
id	整数	真正的	假	创建成员时自动分配
organization_id	整数	真正的	真正的	在此成员资格中与此用户关联的组织的ID
organization_name	字符串	真正的	假	在此成员资格中与此用户关联的组织的名称
updated_at	字符串	真正的	假	这条记录上次更新的时候
url	字符串	真正的	假	这个成员的API url
user_id	整数	真正的	真正的	此会员资格所属的用户的ID
view_tickets	布尔	真正的	假	表示用户是否能够访问所有组织的票证。

例子

             
              ｛“created_at”：“2009 - 05 - 13 - t00:07:08z”，“默认”：真正的，“id”：4，“organization_id”：12，“organization_name”：“第一次组织”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://example.亚博zendesk.com/api/v2/organization_memberships/4.json”，“user_id”：29，“view_tickets”：真正的｝

会员列表

GET / api / v2 / organization_memberships
GET / api / v2 /用户/ {user_id} / organization_memberships.json
GET / api / v2 /组织/ {organization_id} / organization_memberships.json

返回有关帐户、用户或组织的组织成员列表。

请注意:当为用户返回组织成员时，组织成员将先按默认组织排序，然后按组织名称排序。

分页

游标分页(推荐)
抵消分页

看到分页．

每页最多返回100条记录。

允许

代理
最终用户

旋度

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

示例响应(年代)

200好了

              
               // Status 200 OK｛“organization_memberships”：［｛“created_at”：“2009 - 05 - 13 - t00:07:08z”，“默认”：真正的，“id”：4，“organization_id”：12，“organization_name”：“第一次组织”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“user_id”：29，“view_tickets”：真正的｝，｛“created_at”：“2012 - 03 - 13 - t22:01:32z”，“默认”：零，“id”：49，“organization_id”：3.，“organization_name”：“第二次组织”，“updated_at”：“2012 - 03 - 13 - t22:01:32z”，“user_id”：155，“view_tickets”：真正的｝］｝

显示会员

GET / api / v2 / organization_memberships / {organization_membership_id}
GET / api / v2 /用户/ {user_id} / organization_memberships / {organization_membership_id} . json

允许

代理

参数

的名字	类型	在	要求	描述
organization_membership_id	整数	路径	真正的	组织成员的ID

旋度

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

示例响应(年代)

200好了

              
               // Status 200 OK｛“organization_membership”：｛“created_at”：“2009 - 05 - 13 - t00:07:08z”，“默认”：真正的，“id”：4，“organization_id”：12，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“user_id”：29｝｝

创建会员

POST / api / v2 / organization_memberships
POST / api / v2 /用户/ {user_id} / organization_memberships

将用户分配给给定的组织。如果用户已分配给组织，则返回状态为422的错误。

允许

管理员
代理在为最终用户创建新的组织成员时

旋度

              
               旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_memberships.json＼-X POST -d'{"organization_membership": {"user_id": 72， "organization_id": 88}}'＼- h“application / json内容类型:- v - u｛email_address｝：｛密码｝

示例响应(年代)

201年创建

              
               //状态201已创建｛“organization_membership”：｛“created_at”：“2012 - 04 - 03 - t12:34:01z”，“默认”：真正的，“id”：461，“organization_id”：88，“updated_at”：“2012 - 04 - 03 - t12:34:01z”，“user_id”：72｝｝

创建许多会员

POST / api / v2 / organization_memberships / create_many

这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成。

允许

管理员
代理

旋度

              
               旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_memberships/create_many.json＼- h“application / json内容类型:＼- d'{"organization_memberships": [{"user_id": 72， "organization_id": 88}， {"user_id": 27， "organization_id": 88}]}'＼- v - u｛email_address｝：｛密码｝- x的帖子

示例响应(年代)

200好了

              
               // Status 200 OK｛“job_status”：｛“id”：“8 b726e606741012ffc2d782bcb7848fe”，“消息”：“完成于4月13日星期五02:51:53 +0000 2012”，“进步”：2，“结果”：［｛“行动”：“创造”，“id”：380，“状态”：“创建”，“成功”：真正的｝］，“状态”：“完成”，“总”：2，“url”：“https://company.亚博zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe.json”｝｝

将成员资格设置为默认

把/ api / v2 /用户/ {user_id} / organization_memberships / {organization_membership_id} / make_default

设置给定用户的默认组织成员。

允许

管理员
在为最终用户设置默认组织成员资格时

参数

的名字	类型	在	要求	描述
organization_membership_id	整数	路径	真正的	组织成员的ID
user_id	整数	路径	真正的	用户的id

旋度

              
               旋度https://｛子域名｝.亚博zendesk.com/api/v2/users/｛user_id｝/ organization_memberships /｛organization_membership_id｝/ make_default.json＼- v - u｛email_address｝：｛密码｝-X PUT -d“{}”- h“application / json内容类型:

示例响应(年代)

200好了

              
               // Status 200 OK｛“organization_memberships”：［｛“created_at”：“2009 - 05 - 13 - t00:07:08z”，“默认”：真正的，“id”：4，“organization_id”：12，“organization_name”：“第一次组织”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“user_id”：29，“view_tickets”：真正的｝，｛“created_at”：“2012 - 03 - 13 - t22:01:32z”，“默认”：零，“id”：49，“organization_id”：3.，“organization_name”：“第二次组织”，“updated_at”：“2012 - 03 - 13 - t22:01:32z”，“user_id”：155，“view_tickets”：真正的｝］｝

组织设置为Default

把/ api / v2 /用户/ {user_id} /组织/ {organization_id} / make_default

设置给定用户的默认组织成员。

允许

代理

参数

的名字	类型	在	要求	描述
organization_id	整数	路径	真正的	组织ID
user_id	整数	路径	真正的	用户的id

旋度

              
               旋度https://｛子域名｝.亚博zendesk.com/api/v2/users/｛user_id｝/组织/｛organization_id｝/ make_default.json＼- v - u｛email_address｝：｛密码｝-X PUT -d“{}”- h“application / json内容类型:

示例响应(年代)

200好了

              
               // Status 200 OK｛“organization_membership”：｛“created_at”：“2009 - 05 - 13 - t00:07:08z”，“默认”：真正的，“id”：4，“organization_id”：12，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“user_id”：29｝｝

Unassign组织

删除/ api / v2 /用户/ {user_id} /组织/ {organization_id}

立即将用户从组织中移除，并安排作业取消当前分配给用户和组织组合的所有工作票。的organization_id的值设置为null。

允许

代理

参数

的名字	类型	在	要求	描述
organization_id	整数	路径	真正的	组织ID
user_id	整数	路径	真正的	用户的id

旋度

              
               旋度https://｛子域名｝.亚博zendesk.com/api/v2/users/｛user_id｝/组织/｛organization_id｝. json＼- v - u｛email_address｝：｛密码｝- x删除

示例响应(年代)

204无内容

              
               //状态204无内容零

删除会员

删除/ api / v2 / organization_memberships / {organization_membership_id}
删除/ api / v2 /用户/ {user_id} / organization_memberships / {organization_membership_id} . json

立即将用户从组织中移除，并安排作业取消当前分配给用户和组织组合的所有工作票。的organization_id的值设置为null。

允许

管理员
代理在删除最终用户的组织成员资格时

参数

的名字	类型	在	要求	描述
organization_membership_id	整数	路径	真正的	组织成员的ID

旋度

              
               旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_memberships/｛id｝. json＼- v - u｛email_address｝：｛密码｝- x删除

示例响应(年代)

204无内容

              
               //状态204无内容零

批量删除会员资格

删除/ api / v2 / organization_memberships / destroy_many

立即将用户从组织中移除，并安排作业取消当前分配给用户和组织组合的所有工作票。的organization_id的值设置为null。

响应

这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成。

允许

代理

参数

的名字	类型	在	要求	描述
id	数组	查询	假	需要删除的组织成员id

旋度

              
               旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/organization_memberships/destroy_many.json吗?＝1、2，3＼- v - u｛email_address｝：｛密码｝- x删除

示例响应(年代)

200好了

              
               // Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：“完成于2018-03-08 10:07:04 +0000”，“进步”：2，“结果”：［｛“行动”：“删除”，“id”：244，“状态”：“删除”，“成功”：真正的｝，｛“行动”：“删除”，“id”：245，“状态”：“删除”，“成功”：真正的｝］，“状态”：“完成”，“总”：2，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝