百度智能云
All Product Document

          Reference

          • Reference
          • >
          • Enterprises Organizations
          • >
          • API Reference
          • >
          • Account Management Interface

          Account Management Interface

          Last Updated：2020-10-21

          Create Account

          Interface description

          Create an account and automatically become a member of the current enterprise organization.

          After the request is successfully called, the account status is inactive; the system will send a confirmation link to the mobile phone designated by the account, and the user will confirm the binding of the mobile phone number after clicking the link to complete activation.

          After the account is created and activated, the system assigns a random password to it. To log in to the console, go to AI Cloud login page-Cloud Account-Forgot Password, and reset the password by binding a mobile phone number.

          Request structure 

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

{
    "name": "name", 
    "mobile": "mobile",
    "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
          name String RequestBody parameter Account name, globally unique Yes
          mobile String RequestBody parameter Account bound phone Yes
          description String RequestBody parameter Account description No

          Response header fields

          There are no other special headers except the public headers.

          Response parameter

          Account Object

          Request example 

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

{"name":"accountasdx", "description": "test organization account", "mobile":"13312345678"}

          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": "CREATING",
    "description": "test organization",
    "mobile": "*******5678",
    "joinTime": "2019-09-24T01:45:43Z",
    "id": "bfdbd1e6316b4729ab49f2cb25710068",
    "name": "accountasdx"
}

          View Account

          Interface description

          View specified accounts in an enterprise organization.

          Request structure 

          GET /v1/organization/{organizationId}/account/{accountId} 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
          accountId String URL parameter Account ID Yes

          Response header fields

          There are no other special headers except the public headers.

          Response parameter

          Account Object

          Request example 

          GET /v1/organization/25fc10b3bc61437aa72b35f76515b375/account/a7409103bba94b0c8edf446a22c72bf7
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": "ACTIVE",
    "description": "",
    "mobile": "+86********243",
    "joinTime": "2019-09-23T11:16:51Z",
    "id": "a7409103bba94b0c8edf446a22c72bf7",
    "name": "bceaccount123"
}

          List Account

          Interface description

          Make a list of all accounts under the organization.

          Request structure 

          GET /v1/organization/{organizationId}/account 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
          accounts List <Account> List of account objects

          Request example 

          GET /v1/organization/25fc10b3bc61437aa72b35f76515b375/account
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": "ACTIVE",
        "description": "",
        "mobile": "+86********243",
        "joinTime": "2019-09-23T11:16:51Z",
        "id": "a7409103bba94b0c8edf446a22c72bf7",
        "name": "bceaccount123"
    }
]

          Create an AccessKey for Your Account

          Interface description

          Create a set of AccessKeys for an activated account.

          Calling this interface requires that the account has completed activation confirmation via SMS link.

          Request structure 

          POST /v1/organization/{organizationId}/account/{accountId}/accesskey 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
          accountId String URL parameter Account ID Yes

          Response header fields

          There are no other special headers except the public headers.

          Response parameter

          AccessKey Object

          Request example 

          POST /v1/organization/25fc10b3bc61437aa72b35f76515b375/account/a7409103bba94b0c8edf446a22c72bf7/accesskey
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

{
    "secret": "1234567890abcdef98e338e20217a1c7",
    "id": "eb848c3507344564bd4ab7b7da1cdd70",
    "createTime": "2019-09-23T11:24:10Z"
}

          Sub-Account Enables Enterprise Organization Finance

          Interface description

          Enable corporate organization financial functions for sub-accounts.

          The financial function of the enterprise organization requires that the identity verification name of the sub-account must be consistent with the master account; no account balance, no wireless contract placement; and the billing strategy must be based on consumption billing, no billable amount, and no default.

          Request structure 

          PUT /v1/organization/{organizationId}/account/{accountId}?consolidate_billing 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
          accountId String URL parameter Sub-account ID Yes

          Response header fields

          There are no other special headers except the public headers.

          Response parameter

          None

          Request example 

          PUT /v1/organization/25fc10b3bc61437aa72b35f76515b375/account/8760c415d06c47169c3561d51538d75a?consolidate_billing
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
content-length: 0
Server: BWS

          Leave the Organization

          Interface description

          The account leaves the enterprise organization.

          For accounts created quickly in an enterprise organization, you need to contact your account manager to change to a full account before leaving the organization.

          Request structure 

          PUT /v1/organization/{organizationId}/account/{accountId}?leave 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
          accountId String URL parameter Sub-account ID Yes

          Response header fields

          There are no other special headers except the public headers.

          Response parameter

          None

          Request example 

          PUT /v1/organization/25fc10b3bc61437aa72b35f76515b375/account/8760c415d06c47169c3561d51538d75a?leave
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
content-length: 0
Server: BWS
          Previous
          Enterprise Organization Management Interface
          Next
          Invitation Management Interface