Skip to main content

Create group

POST 

/bv/org/v1/groups

Creates a new group within the organization using the provided access token.


Required field(s):

  • name

  • Returns a 400/BadRequest error if any request body is invalid.

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
    name stringrequired

    Required. The name of the group to create.

    description string

    Input only. The description of the group to create.

    user_ids string[]

    Input only. The user list to add to the group when creating.

Responses

A successful response.

Schema
    group object
    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 string

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

    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.

Loading...