client

func (*Client) Delete ¶

func (c *Client) Delete(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) error

Delete a group by its ID.

Example:

client.Groups.Delete(
    context.TODO(),
    "id",
)

func (*Client) Get ¶

func (c *Client) Get(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) (*management.GetGroupResponseContent, error)

Retrieve a group by its ID.

Example:

client.Groups.Get(
    context.TODO(),
    "id",
)

func (*Client) List ¶

func (c *Client) List(
	ctx context.Context,
	request *management.ListGroupsRequestParameters,
	opts ...option.RequestOption,
) (*core.Page[*string, *management.Group, *management.ListGroupsPaginatedResponseContent], error)

List all groups in your tenant.

Example:

request := &management.ListGroupsRequestParameters{
    ConnectionID: management.String(
        "connection_id",
    ),
    Name: management.String(
        "name",
    ),
    ExternalID: management.String(
        "external_id",
    ),
    Search: management.String(
        "search",
    ),
    Fields: management.String(
        "fields",
    ),
    IncludeFields: management.Bool(
        true,
    ),
    IncludeTotals: management.Bool(
        true,
    ),
    From: management.String(
        "from",
    ),
    Take: management.Int(
        1,
    ),
}
client.Groups.List(
    context.TODO(),
    request,
)

func (*RawClient) Delete ¶

func (r *RawClient) Delete(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) (*core.Response[any], error)

func (*RawClient) Get ¶

func (r *RawClient) Get(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) (*core.Response[*management.GetGroupResponseContent], error)