メインコンテンツまでスキップ

Get account information

GET 
/bv/account/v1/accounts/:id

Fetches the account information based on the account id from the given request.

Required field(s):

  • id
  • Returns a 404/NotFound error if the requested resource is not found.

Request​

Path Parameters

    id stringrequired

    Required. The resource identifier of account.

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.

Responses​

A successful response.

Schema
    account object
    id string

    Output only. The resource identifier of account.

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

    Required. The password of account. 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.

    status string

    Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]

    Output only. The status of account.

    default_org_id Output only. The default organization of account. The account login the console, will enter default organization workspace automatically (string)
    account_infos object[]
  • Array [
    • organization object
    id string

    Output only. The resource identifier of the organization.

    name string

    Output only. The name of the organization.

    parent_id string

    Output only. The appended parent organization id.

    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

    Output only. The description of the organization.

    owner_email string

    Output only. The owner email of the organization.

    billing_cycle int32

    Output only. The billing cycle of the organization.

    contract_valid_start_time date-time

    Output only. The contract valid start day won't be valid before the day.

    contract_months int32

    Output only. The contract duration unit. It might one of the contract_months or contract_days.

    contract_days int32

    Output only. The contract duration unit. It might one of the contract_months or contract_days.

    contract_valid_end_time date-time

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

    next_contract object

    Output only. The next contract of the organization.

    start_time date-time

    Output only. The start time of the organization.

    months int32

    Output only. The months of the organization.

    days int32

    Output only. The days of the organization.

    end_time date-time

    Output only. The valid end time of the organization.

    parent_id string

    Output only. The parent id of the organization.

    plan_id string

    Output only. The plan id of the organization.

    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.

    time_zone string

    Output only. The time zone of the organization.

    owner object
    id string

    Output only. The unique id of the user.

    email string

    Output only. The email of the user.

    status string

    Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]

    Output only. The status of the user.

    role_type - ROLE_TYPE_CXM_ADMIN: CXM (string)

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER, ROLE_TYPE_CONTENT_CONTRIBUTOR, ROLE_TYPE_CUSTOM, ROLE_TYPE_CXM_ADMIN, ROLE_TYPE_CXM_MODERATOR, ROLE_TYPE_CXM_CONTRIBUTOR, ROLE_TYPE_CXM_PARTICIPANT]

    Output only. The role of the user.

    created_at date-time

    Output only. The created time of the user.

    first_name string

    Output only. The first name of the user.

    last_name string

    Output only. The last name of the user.

    business_setting object
    business_plan_type string

    Possible values: [BUSINESS_PLAN_TYPE_BVONE, BUSINESS_PLAN_TYPE_CXM, BUSINESS_PLAN_TYPE_CPM]

    Output only. The plan type of the business sub-organization. Values:

    • BUSINESS_PLAN_TYPE_BVONE: Indicates the BVOne plan, allowing the business sub-organization to create sites and enable custom domains.
    • BUSINESS_PLAN_TYPE_CXM: Indicates the CXM plan, allowing add the marketplace url.
    category Optional. The category of the business sub-organization. This field is optional and can contain custom classifications. Max length: 40 (string)
    tax_id Optional. The tax ID of the business sub-organization. Max length: 8 (string)
    enable_create_site boolean

    Optional. Indicates whether the business sub-organization has permission to create sites. This field should only be provided when the business sub-organization plan is BVOne plan.

    site_limit int32

    Optional. The maximum number of sites that the business sub-organization can create. This field should only be provided when the business sub-organization plan is BVOne plan. This field is optional and must be within the range of 0 to 50, inclusive.

    enable_custom_domain boolean

    Optional. Indicates if the business sub-organization can enable a custom domain. This field should only be provided when the business sub-organization plan is BVOne plan.

    marketplace_url string

    Optional. The marketplace URL of the business sub-organization. This field should only be provided when the business sub-organization plan is CXM plan. Max length: 2000, must be a valid URL format.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

    role_type - ROLE_TYPE_CXM_ADMIN: CXM (string)

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER, ROLE_TYPE_CONTENT_CONTRIBUTOR, ROLE_TYPE_CUSTOM, ROLE_TYPE_CXM_ADMIN, ROLE_TYPE_CXM_MODERATOR, ROLE_TYPE_CXM_CONTRIBUTOR, ROLE_TYPE_CXM_PARTICIPANT]

    groups object[]
  • Array [
    • id string

    Output only. The unique id of the group.

    name string

    Output only. The name of the group.

    description string

    Output only. The description of the group.

    creator_name string

    Output only. The name of the creator for the group.

    user_infos object[]

    Output only.

  • Array [
    • id string

    Output only. The unique id of the user.

    email string

    Output only. The email of the user.

    status string

    Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]

    Output only. The status of the user.

    role_type - ROLE_TYPE_CXM_ADMIN: CXM (string)

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER, ROLE_TYPE_CONTENT_CONTRIBUTOR, ROLE_TYPE_CUSTOM, ROLE_TYPE_CXM_ADMIN, ROLE_TYPE_CXM_MODERATOR, ROLE_TYPE_CXM_CONTRIBUTOR, ROLE_TYPE_CXM_PARTICIPANT]

    Output only. The role of the user.

    created_at date-time

    Output only. The created time of the user.

    first_name string

    Output only. The first name of the user.

    last_name string

    Output only. The last name of the user.

  • ]
    • members int32

    Output only. The number of members in the group.

    created_at date-time

    Output only. The timestamp of the group that was created.

    updated_at date-time

    Output only. The timestamp of the group that was last updated.

  • ]
  • ]
    • connected_accounts object[]
  • Array [
    • id string

    Output only. The id of connected account.

    provider string

    Possible values: [OAUTH2_PROVIDER_GOOGLE]

    Output only. The provider of connected account.

    email string

    Output only. The email of connected account.

  • ]
    • attrs object
    property name* string
    created_at date-time

    Output only.

    updated_at date-time

    Output only.

    nickname string

    Optional. The nickname of account.

    avatar_icon_url string

    Output only. The avatar icon url of account.

Loading...