邀请管理接口
更新时间：2020-02-25
创建邀请
接口描述
邀请已有账户加入企业组织。
请求结构
Plain Text
1POST /v1/organization/{organizationId}/invitation HTTP/1.1
2Host: organization.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "accountId": "target accountId",
7 "expireTime": "expire time"
8 "description": "description"
9}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| organizationId | String | URL参数 | 企业组织ID | 是 |
| accountId | String | RequestBody参数 | 邀请账户的id | 是 |
| expireTime | DateTime | RequestBody参数 | 邀请的过期时间 | 否 |
| description | String | RequestBody参数 | 邀请的描述 | 否 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
Plain Text
1POST /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation
2host: organization.bj.baidubce.com
3Authorization: AuthorizationString
4
5{"accountId":"6381f247b7c3433da0fb34786040baa9", "description":"test"}响应示例
Plain Text
1HTTP/1.1 201 Created
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
4Server: BWS
5
6{
7 "status": "OPEN",
8 "description": "test",
9 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
10 "createTime": "2019-09-23T11:29:14Z",
11 "expireTime": "2019-09-26T11:29:14Z",
12 "id": "fcb25901719e4d80941da326d8a0046c",
13 "accountId": "6381f247b7c3433da0fb34786040baa9"
14}取消邀请
接口描述
取消已创建的企业组织邀请。
请求结构
Plain Text
1PUT /v1/organization/{organizationId}/invitation/{invitationId}?cancel HTTP/1.1
2Host: organization.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| organizationId | String | URL参数 | 企业组织ID | 是 |
| invitationId | String | URL参数 | 邀请的id | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
Plain Text
1PUT /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation/6f302551380b47bfb6494e5778d16a1c?cancel
2host: organization.bj.baidubce.com
3Authorization: AuthorizationString响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
4Server: BWS查看邀请
接口描述
查看企业组织邀请。
请求结构
Plain Text
1GET /v1/organization/{organizationId}/invitation/{invitationId} HTTP/1.1
2Host: organization.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| organizationId | String | URL参数 | 企业组织ID | 是 |
| invitationId | String | URL参数 | 邀请的id | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
Plain Text
1GET /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation
2host: organization.bj.baidubce.com
3Authorization: AuthorizationString响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
4Server: BWS
5
6[
7 {
8 "status": "OPEN",
9 "description": "test",
10 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
11 "createTime": "2019-09-23T11:29:14Z",
12 "expireTime": "2019-09-26T11:29:14Z",
13 "id": "fcb25901719e4d80941da326d8a0046c",
14 "accountId": "6381f247b7c3433da0fb34786040baa9"
15 }
16]列举邀请
接口描述
列举全部的企业组织邀请。
请求结构
Plain Text
1GET /v1/organization/{organizationId}/invitation HTTP/1.1
2Host: organization.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| organizationId | String | URL参数 | 企业组织ID | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| invitations | List<Invitation> | 邀请的列表 |
请求示例
Plain Text
1GET /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation
2host: organization.bj.baidubce.com
3Authorization: AuthorizationString响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
4Server: BWS
5
6[
7 {
8 "status": "CANCELED",
9 "description": "test",
10 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
11 "createTime": "2019-09-24T01:50:16Z",
12 "expireTime": "2019-09-27T01:50:16Z",
13 "id": "6f302551380b47bfb6494e5778d16a1c",
14 "accountId": "8375b8d6092c4b61b9be443d191ededb"
15 },
16 {
17 "status": "OPEN",
18 "description": "",
19 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
20 "createTime": "2019-09-24T01:45:43Z",
21 "expireTime": "2019-09-27T01:45:43Z",
22 "id": "c94976d927e541878ce92d4a8587e033",
23 "accountId": "bfdbd1e6316b4729ab49f2cb25710068"
24 },
25 {
26 "status": "DECLINED",
27 "description": "test",
28 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
29 "createTime": "2019-09-23T11:29:14Z",
30 "expireTime": "2019-09-26T11:29:14Z",
31 "id": "fcb25901719e4d80941da326d8a0046c",
32 "accountId": "6381f247b7c3433da0fb34786040baa9"
33 }
34]查看账户下邀请
接口描述
列举当前账户下的企业组织邀请。
请求结构
Plain Text
1GET /v1/invitation HTTP/1.1
2Host: organization.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
无。
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| invitations | List<Invitation> | 邀请的列表 |
请求示例
Plain Text
1GET /v1/invitation
2host: organization.bj.baidubce.com
3Authorization: AuthorizationString响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
4Server: BWS
5
6[
7 {
8 "status": "OPEN",
9 "description": "test",
10 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
11 "createTime": "2019-09-23T11:29:14Z",
12 "expireTime": "2019-09-26T11:29:14Z",
13 "id": "fcb25901719e4d80941da326d8a0046c",
14 "accountId": "6381f247b7c3433da0fb34786040baa9"
15 }
16]授受邀请
接口描述
被邀请账户接受企业组织邀请。
请求结构
Plain Text
1PUT /v1/invitation/{invitationId}?accept HTTP/1.1
2Host: organization.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| invitationId | String | URL参数 | 邀请的id | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
Plain Text
1PUT /v1/invitation/4eeab346ceac422fa788940c5251d8a8?accept
2host: organization.bj.baidubce.com
3Authorization: AuthorizationString响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
4Server: BWS
5
6{
7 "status": "ACCEPTED",
8 "description": "",
9 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
10 "createTime": "2019-09-24T04:06:38Z",
11 "expireTime": "2019-09-27T04:06:38Z",
12 "id": "4eeab346ceac422fa788940c5251d8a8",
13 "accountId": "8760c415d06c47169c3561d51538d75a"
14}拒绝邀请
接口描述
被邀请账户拒绝企业组织邀请。
请求结构
Plain Text
1PUT /v1/invitation/{invitationId}?decline HTTP/1.1
2Host: organization.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| invitationId | String | URL参数 | 邀请的id | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
Plain Text
1PUT /v1/invitation/fcb25901719e4d80941da326d8a0046c?decline
2host: organization.bj.baidubce.com
3Authorization: AuthorizationString响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
4Server: BWS
5
6{
7 "status": "DECLINED",
8 "description": "test",
9 "organizationId": "25fc10b3bc61437aa72b35f76515b375",
10 "createTime": "2019-09-23T11:29:14Z",
11 "expireTime": "2019-09-26T11:29:14Z",
12 "id": "fcb25901719e4d80941da326d8a0046c",
13 "accountId": "6381f247b7c3433da0fb34786040baa9"
14}