相关参考Reference

    邀请管理接口

    创建邀请

    接口描述

    邀请已有账户加入企业组织。

    请求结构

    POST /v1/organization/{organizationId}/invitation HTTP/1.1
    Host: organization.bj.baidubce.com
    Authorization: authorization string
    
    {
        "accountId": "target accountId",
        "expireTime": "expire time"
        "description": "description"
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    名称 类型 位置 描述 是否必须
    organizationId String URL参数 企业组织ID
    accountId String RequestBody参数 邀请账户的id
    expireTime DateTime RequestBody参数 邀请的过期时间
    description String RequestBody参数 邀请的描述

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    Invitation对象

    请求示例

    POST /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation
    host: organization.bj.baidubce.com
    Authorization: AuthorizationString
    
    {"accountId":"6381f247b7c3433da0fb34786040baa9", "description":"test"}

    响应示例

    HTTP/1.1 201 Created
    Content-Type: application/json;charset=UTF-8
    X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
    Server: BWS
    
    {
        "status": "OPEN",
        "description": "test",
        "organizationId": "25fc10b3bc61437aa72b35f76515b375",
        "createTime": "2019-09-23T11:29:14Z",
        "expireTime": "2019-09-26T11:29:14Z",
        "id": "fcb25901719e4d80941da326d8a0046c",
        "accountId": "6381f247b7c3433da0fb34786040baa9"
    }

    取消邀请

    接口描述

    取消已创建的企业组织邀请。

    请求结构

    PUT /v1/organization/{organizationId}/invitation/{invitationId}?cancel HTTP/1.1
    Host: organization.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    名称 类型 位置 描述 是否必须
    organizationId String URL参数 企业组织ID
    invitationId String URL参数 邀请的id

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    Invitation对象

    请求示例

    PUT /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation/6f302551380b47bfb6494e5778d16a1c?cancel
    host: organization.bj.baidubce.com
    Authorization: AuthorizationString

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
    Server: BWS

    查看邀请

    接口描述

    查看企业组织邀请。

    请求结构

    GET /v1/organization/{organizationId}/invitation/{invitationId} HTTP/1.1
    Host: organization.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    名称 类型 位置 描述 是否必须
    organizationId String URL参数 企业组织ID
    invitationId String URL参数 邀请的id

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    Invitation对象

    请求示例

    GET /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation
    host: organization.bj.baidubce.com
    Authorization: AuthorizationString

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
    Server: BWS
    
    [
        {
            "status": "OPEN",
            "description": "test",
            "organizationId": "25fc10b3bc61437aa72b35f76515b375",
            "createTime": "2019-09-23T11:29:14Z",
            "expireTime": "2019-09-26T11:29:14Z",
            "id": "fcb25901719e4d80941da326d8a0046c",
            "accountId": "6381f247b7c3433da0fb34786040baa9"
        }
    ]

    列举邀请

    接口描述

    列举全部的企业组织邀请。

    请求结构

    GET /v1/organization/{organizationId}/invitation HTTP/1.1
    Host: organization.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    名称 类型 位置 描述 是否必须
    organizationId String URL参数 企业组织ID

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    名称 类型 描述
    invitations List<Invitation> 邀请的列表

    请求示例

    GET /v1/organization/25fc10b3bc61437aa72b35f76515b375/invitation
    host: organization.bj.baidubce.com
    Authorization: AuthorizationString

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
    Server: BWS
    
    [
        {
            "status": "CANCELED",
            "description": "test",
            "organizationId": "25fc10b3bc61437aa72b35f76515b375",
            "createTime": "2019-09-24T01:50:16Z",
            "expireTime": "2019-09-27T01:50:16Z",
            "id": "6f302551380b47bfb6494e5778d16a1c",
            "accountId": "8375b8d6092c4b61b9be443d191ededb"
        },
        {
            "status": "OPEN",
            "description": "",
            "organizationId": "25fc10b3bc61437aa72b35f76515b375",
            "createTime": "2019-09-24T01:45:43Z",
            "expireTime": "2019-09-27T01:45:43Z",
            "id": "c94976d927e541878ce92d4a8587e033",
            "accountId": "bfdbd1e6316b4729ab49f2cb25710068"
        },
        {
            "status": "DECLINED",
            "description": "test",
            "organizationId": "25fc10b3bc61437aa72b35f76515b375",
            "createTime": "2019-09-23T11:29:14Z",
            "expireTime": "2019-09-26T11:29:14Z",
            "id": "fcb25901719e4d80941da326d8a0046c",
            "accountId": "6381f247b7c3433da0fb34786040baa9"
        }
    ]

    查看账户下邀请

    接口描述

    列举当前账户下的企业组织邀请。

    请求结构

    GET /v1/invitation HTTP/1.1
    Host: organization.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    无。

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    名称 类型 描述
    invitations List<Invitation> 邀请的列表

    请求示例

    GET /v1/invitation
    host: organization.bj.baidubce.com
    Authorization: AuthorizationString

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
    Server: BWS
    
    [
        {
            "status": "OPEN",
            "description": "test",
            "organizationId": "25fc10b3bc61437aa72b35f76515b375",
            "createTime": "2019-09-23T11:29:14Z",
            "expireTime": "2019-09-26T11:29:14Z",
            "id": "fcb25901719e4d80941da326d8a0046c",
            "accountId": "6381f247b7c3433da0fb34786040baa9"
        }
    ]

    授受邀请

    接口描述

    被邀请账户接受企业组织邀请。

    请求结构

    PUT /v1/invitation/{invitationId}?accept HTTP/1.1
    Host: organization.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    名称 类型 位置 描述 是否必须
    invitationId String URL参数 邀请的id

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    Invitation对象

    请求示例

    PUT /v1/invitation/4eeab346ceac422fa788940c5251d8a8?accept
    host: organization.bj.baidubce.com
    Authorization: AuthorizationString

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
    Server: BWS
    
    {
        "status": "ACCEPTED", 
        "description": "", 
        "organizationId": "25fc10b3bc61437aa72b35f76515b375", 
        "createTime": "2019-09-24T04:06:38Z", 
        "expireTime": "2019-09-27T04:06:38Z", 
        "id": "4eeab346ceac422fa788940c5251d8a8", 
        "accountId": "8760c415d06c47169c3561d51538d75a"
    }

    拒绝邀请

    接口描述

    被邀请账户拒绝企业组织邀请。

    请求结构

    PUT /v1/invitation/{invitationId}?decline HTTP/1.1
    Host: organization.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    名称 类型 位置 描述 是否必须
    invitationId String URL参数 邀请的id

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    Invitation对象

    请求示例

    PUT /v1/invitation/fcb25901719e4d80941da326d8a0046c?decline
    host: organization.bj.baidubce.com
    Authorization: AuthorizationString

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    X-Bce-Request-Id: fc96771d-f2a3-4b1a-8ed2-ea7665461baf
    Server: BWS
    
    {
        "status": "DECLINED",
        "description": "test",
        "organizationId": "25fc10b3bc61437aa72b35f76515b375",
        "createTime": "2019-09-23T11:29:14Z",
        "expireTime": "2019-09-26T11:29:14Z",
        "id": "fcb25901719e4d80941da326d8a0046c",
        "accountId": "6381f247b7c3433da0fb34786040baa9"
    }
    上一篇
    账户管理接口
    下一篇
    单元管理接口