Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

access_users: Add ZeroTrust Users & Seats functions. #1427

Merged
merged 5 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
64 changes: 64 additions & 0 deletions access_seats.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package cloudflare

import (
"context"
"errors"
"fmt"
"net/http"

"github.com/goccy/go-json"
)

var errMissingAccessSeatUID = errors.New("missing required access seat UID")

type AccessUserSeat struct {
AccessSeat bool `json:"access_seat"`
CreatedAt string `json:"created_at"`
GatewaySeat bool `json:"gateway_seat"`
SeatUID string `json:"seat_uid"`
UpdatedAt string `json:"updated_at"`
}

// Removes a user from a Zero Trust seat when both access_seat and gateway_seat are set to false.
type UpdateAccessUserSeatParams struct {
SeatUID string `json:"seat_uid"`
AccessSeat bool `json:"access_seat"`
GatewaySeat bool `json:"gateway_seat"`
}

type UpdateAccessUserSeatResponse struct {
Success bool `json:"success"`
Errors []string `json:"errors"`
Messages []string `json:"messages"`
gavinelder marked this conversation as resolved.
Show resolved Hide resolved
Result AccessUserSeat `json:"result"`
ResultInfo ResultInfo `json:"result_info"`
}

// UpdateAccessUserSeat updates a Access User Seat.
// UpdateAccessUserSeat Removes a user from a Zero Trust seat when both access_seat and gateway_seat are set to false.
gavinelder marked this conversation as resolved.
Show resolved Hide resolved
//
// Access API reference: https://developers.cloudflare.com/api/operations/zero-trust-seats-update-a-user-seat
gavinelder marked this conversation as resolved.
Show resolved Hide resolved
gavinelder marked this conversation as resolved.
Show resolved Hide resolved
func (api *API) UpdateAccessUserSeat(ctx context.Context, rc *ResourceContainer, params UpdateAccessUserSeatParams) (AccessUserSeat, error) {
if params.SeatUID == "" {
return AccessUserSeat{}, errMissingAccessSeatUID
}
jacobbednarz marked this conversation as resolved.
Show resolved Hide resolved

uri := fmt.Sprintf(
"/%s/%s/access/seats",
rc.Level,
rc.Identifier,
)

res, err := api.makeRequestContext(ctx, http.MethodPatch, uri, params)
if err != nil {
return AccessUserSeat{}, fmt.Errorf("%s: %w", errMakeRequestError, err)
}

var updateAccessUserSeatResponse UpdateAccessUserSeatResponse
err = json.Unmarshal(res, &updateAccessUserSeatResponse)
if err != nil {
return AccessUserSeat{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}

return updateAccessUserSeatResponse.Result, nil
}
19 changes: 19 additions & 0 deletions access_seats_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package cloudflare

import (
"context"
"testing"

"github.com/stretchr/testify/assert"
)

func TestUpdateAccessUserSeatWithMissingUID(t *testing.T) {
setup()
defer teardown()

_, err := client.UpdateAccessUserSeat(context.Background(), testAccountRC, UpdateAccessUserSeatParams{})
assert.EqualError(t, err, "missing required access seat UID")

_, err = client.UpdateAccessUserSeat(context.Background(), testZoneRC, UpdateAccessUserSeatParams{})
assert.EqualError(t, err, "missing required access seat UID")
jacobbednarz marked this conversation as resolved.
Show resolved Hide resolved
}