Skip to main content

Batch create sub organizations

POST 

/bv/org/v1/sub-orgs:batch

Create multiple sub-organizations once with all necessary details for each sub-organization.

Request

Header Parameters

    x-bv-org-id stringrequired

    To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Body

required
    organizations object[]
  • Array [
  • name stringrequired

    Required. The name of sub-organization.

    parent_id stringrequired

    Required. The appended parent organization id of the sub-organization.

    type stringrequired

    Possible values: [ORGANIZATION_TYPE_ROOT, ORGANIZATION_TYPE_GENERAL_DISTRIBUTOR, ORGANIZATION_TYPE_RESELLER, ORGANIZATION_TYPE_BUSINESS]

    Required. The type of the sub-organization.

    description string

    Input only. The description of the sub-organization.

    owner objectrequired

    Required. The owner of the sub-organization.

    email Required. The email of account (string)required
    password string

    Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.

    first_name stringrequired

    Required. The first name of account.

    last_name stringrequired

    Required. The last name of account.

    attrs object
    property name* string
    need_confirm boolean

    Optional. Need to send confirm email to account email. Default: false.

    accounts object[]

    Input only. The member of the sub-organization.

  • Array [
  • email Required. The email of account (string)required
    password string

    Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.

    first_name stringrequired

    Required. The first name of account.

    last_name stringrequired

    Required. The last name of account.

    attrs object
    property name* string
    need_confirm boolean

    Optional. Need to send confirm email to account email. Default: false.

  • ]
  • plan_ids string[]

    Input only. The assigned plan ids of the sub-organization.

    billing_cycle int32

    Input only. The billing cycle of the reseller sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_RESELLER.

    contract_valid_start_time date-time

    Input only. The contract start day of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS.

    contract_months int32

    Input only. The contract months of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_days field, it'll get the higher priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.

    contract_days int32

    Input only. The contract days of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_months field, it'll get the lower priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.

    time_zone string

    Input only. The time zone to the sub-organization.

  • ]

Responses

A successful response.

Schema
    organizations object[]
  • Array [
  • organization object
    id string

    Output only. The resource identifier of the organization.

    name stringrequired

    Required. The name of the sub-organization.

    parent_id stringrequired

    Required. The appended parent organization id of the sub-organization.

    type string

    Possible values: [ORGANIZATION_TYPE_ROOT, ORGANIZATION_TYPE_GENERAL_DISTRIBUTOR, ORGANIZATION_TYPE_RESELLER, ORGANIZATION_TYPE_BUSINESS]

    Output only. Indicates the type of the organization.

    status string

    Possible values: [ORGANIZATION_STATUS_ACTIVATED, ORGANIZATION_STATUS_VERIFYING, ORGANIZATION_STATUS_FAIL_TO_VERIFY, ORGANIZATION_STATUS_DEACTIVATED, ORGANIZATION_STATUS_DELETING, ORGANIZATION_STATUS_DELETED, ORGANIZATION_STATUS_ACTIVATION_SCHEDULED]

    Output only. Indicates the status of the organization.

    description string

    Input only. The description of the sub-organization.

    owner objectrequired

    Required. The owner of the sub-organization. The service will genrate account password automatically.

    id string

    Output only. The resource identifier of account.

    email Required. The email of account (string)required
    password string

    Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.

    first_name stringrequired

    Required. The first name of account.

    last_name stringrequired

    Required. The last name of account.

    role_type string

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER]

    Output only. The role of account.

    status string

    Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]

    Output only. The status of account.

    created_status string

    Possible values: [CREATED_ACCOUNT_STATUS_SUCCEED, CREATED_ACCOUNT_STATUS_EXIST, CREATED_ACCOUNT_STATUS_FAILED, CREATED_ACCOUNT_STATUS_JOIN_ORG_FAILED]

    Outpu only. The created status of account.

    attrs object
    property name* string
    need_confirm boolean

    Optional. Need to send confirm email to account email. Default: false.

    created_at date-time
    updated_at date-time
    accounts object[]

    Optional. The member of the sub-organization. The service will genrate account password automatically.

  • Array [
  • id string

    Output only. The resource identifier of account.

    email Required. The email of account (string)required
    password string

    Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.

    first_name stringrequired

    Required. The first name of account.

    last_name stringrequired

    Required. The last name of account.

    role_type string

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER]

    Output only. The role of account.

    status string

    Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]

    Output only. The status of account.

    created_status string

    Possible values: [CREATED_ACCOUNT_STATUS_SUCCEED, CREATED_ACCOUNT_STATUS_EXIST, CREATED_ACCOUNT_STATUS_FAILED, CREATED_ACCOUNT_STATUS_JOIN_ORG_FAILED]

    Outpu only. The created status of account.

    attrs object
    property name* string
    need_confirm boolean

    Optional. Need to send confirm email to account email. Default: false.

    created_at date-time
    updated_at date-time
  • ]
  • time_zone string

    Optional. The time zone to the sub-organization. Default: Aisa/Taipei.

    billing_cycle int32

    Input only. The billing cycle of the reseller sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_RESELLER.

    contract_valid_start_time date-time

    Input only. The contract start day of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS.

    contract_months int32

    Input only. The contract months of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_days field, it'll get the higher priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.

    contract_days int32

    Input only. The contract days of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_months field, it'll get the lower priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.

    contract_valid_end_time date-time

    Output only. The contract valid end day won't be valid after the day.

    has_sub_orgs boolean

    Output only. Indicates there are sub-organizations appended to the organization.

    parent_name string

    Output only. The name of appended parent organization.

    license_key string

    Output only.

    created_at date-time
    updated_at date-time
    created_status string

    Possible values: [CREATED_ORG_STATUS_SUCCEED, CREATED_ORG_STATUS_FAILED]

  • ]
Loading...