Invitation Management Interface

Last Updated：2020-10-22

Create Invitation

Interface description

Invite an existing account to join an enterprise organization.

Request structure

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

{
    "accountId": "target accountId",
    "expireTime": "expire time"
    "description": "description" 
}

Request header

There are no other special headers except the public headers.

Request parameter

Name	Type	Location	Description	Required or not
organizationId	String	URL parameter	Enterprise organization ID	Yes
accountId	String	RequestBody parameter	Inviting account id	Yes
expireTime	DateTime	RequestBody parameter	Invitation expiration time	No
description	String	RequestBody parameter	Description of the invitation	No

Response header fields

There are no other special headers except the public headers.

Response parameter

Invitation Object

Request example

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

{"accountId":"6381f247b7c3433da0fb34786040baa9", "description":"test"}

Response example

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"
}

Cancel Invitation

Interface description

Cancel the invitation to the created organization.

Request structure

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

Request header

There are no other special headers except the public headers.

Request parameter

Name	Type	Location	Description	Required or not
organizationId	String	URL parameter	Enterprise organization ID	Yes
invitationId	String	URL parameter	Invitation id	Yes

Response header fields

There are no other special headers except the public headers.

Response parameter

Invitation Object

Request example

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

Response example

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

View Invitation

Interface description

View corporate invitations.

Request structure

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

Request header

There are no other special headers except the public headers.

Request parameter

Name	Type	Location	Description	Required or not
organizationId	String	URL parameter	Enterprise organization ID	Yes
invitationId	String	URL parameter	Invitation id	Yes

Response header fields

There are no other special headers except the public headers.

Response parameter

Invitation Object

Request example

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

Response example

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"
    }
]

List Invitation

Interface description

List all corporate invitations.

Request structure

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

Request header

There are no other special headers except the public headers.

Request parameter

Name	Type	Location	Description	Required or not
organizationId	String	URL parameter	Enterprise organization ID	Yes

Response header fields

There are no other special headers except the public headers.

Response parameter

Name	Type	Description
invitations	List <Invitation>	Invitation list

Request example

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

Response example

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"
    }
]

View Invitation under Account

Interface description

List the invitations of enterprise organizations under the current account.

Request structure

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

Request header

There are no other special headers except the public headers.

Request parameter

None

Response header fields

There are no other special headers except the public headers.

Response parameter

Name	Type	Description
invitations	List <Invitation>	Invitation list

Request example

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

Response example

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"
    }
]

Accept Invitation

Interface description

The invited account accepts the invitation of the enterprise organization.

Request structure

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

Request header

There are no other special headers except the public headers.

Request parameter

Name	Type	Location	Description	Required or not
invitationId	String	URL parameter	Invitation id	Yes

Response header fields

There are no other special headers except the public headers.

Response parameter

Invitation Object

Request example

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

Response example

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"
}

Decline Invitation

Interface description

The invited account rejected the corporate invitation.

Request structure

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

Request header

There are no other special headers except the public headers.

Request parameter

Name	Type	Location	Description	Required or not
invitationId	String	URL parameter	Invitation id	Yes

Response header fields

There are no other special headers except the public headers.

Response parameter

Invitation Object

Request example

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

Response example

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"
}

Account Management Interface

Unit Management Interface

百度智能云

Reference

Invitation Management Interface

Create Invitation

Cancel Invitation

View Invitation

List Invitation

View Invitation under Account

Accept Invitation

Decline Invitation