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

List available appended organizations

GET 

/bv/org/v1/organizations:list-appends

Lists the available organizations that can be appended using the provided access token. Useful when determining which sub-organizations can be appended to.


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

Request

Query Parameters

    target_org_type string

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

    Input only. It'll limit the available appended organizations based on the target organization which can be appended into if provided. It's useful when editing a sub-org shows the available appended organizations based on its organization type.

    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]

    • ORGANIZATION_STATUS_ACTIVATED: The Organization is activated.
    • ORGANIZATION_STATUS_VERIFYING: The Organization is created but awaiting the owner to verify.
    • ORGANIZATION_STATUS_FAIL_TO_VERIFY: The Organization failed to verify since the invitation is expired.
    • ORGANIZATION_STATUS_DEACTIVATED: The Organization is deactivated since the contract is expired or manually changed by the parent admin.
    • ORGANIZATION_STATUS_DELETING: The Organization is awaiting related resources deleted.
    • ORGANIZATION_STATUS_DELETED: The Organization is deleted.
    • ORGANIZATION_STATUS_ACTIVATION_SCHEDULED: The Organization is activation scheduled since the first contract is not start.

Responses

A successful response.

Schema
    organizations object[]
  • Array [
  • id string

    Output only. The unique id of the organization.

    name string

    Output only. The name of the organization.

    type string

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

    Output only. The type of the organization.

  • ]
Loading...