ClientService

Setup Group

Creates a new Group, provisions any new Users, and records existing and new users as members. Returns once the group and its existing members exist. New user invitations continue in the background.

post/v1alpha2/organizations/{organization}/groups:setup

Request

Base URL: https://api.thirdfort.dev/client/api
URL: https://api.thirdfort.dev/client/api/v1alpha2/organizations/{organization}/groups:setup
Auth: HTTP bearer

Path parameters

organizationstring required

The organization identifier of the resource path.

Request body

displayNamestring required

Human-readable group name.

emailstring

Optional shared contact email address for the group.

notificationBehaviour'NOTIFICATION_BEHAVIOUR_UNSPECIFIED' | 'SEND_TO_GROUP_EMAIL' | 'SEND_TO_MEMBERS' | 'SEND_TO_GROUP_EMAIL_AND_MEMBERS' required

Determines where notifications for a Group are delivered.

SEND_TO_GROUP_EMAIL: Send notifications to the group's shared email address only.
SEND_TO_MEMBERS: Send notifications to every member of the group individually.
SEND_TO_GROUP_EMAIL_AND_MEMBERS: Send notifications to both the group's shared email address and every member.

Response

A successful response.

namestring

The unique resource name of the group. This field is system-generated and immutable.

displayNamestring required

Human-readable group name.

emailstring

Optional shared contact email address for the group.

notificationBehaviour'NOTIFICATION_BEHAVIOUR_UNSPECIFIED' | 'SEND_TO_GROUP_EMAIL' | 'SEND_TO_MEMBERS' | 'SEND_TO_GROUP_EMAIL_AND_MEMBERS'

Determines where notifications for a Group are delivered.

SEND_TO_GROUP_EMAIL: Send notifications to the group's shared email address only.
SEND_TO_MEMBERS: Send notifications to every member of the group individually.
SEND_TO_GROUP_EMAIL_AND_MEMBERS: Send notifications to both the group's shared email address and every member.

membersstring[]

The member Users of the group.

Changes

No recorded changes to this operation across all 1 revision of this API.