Add patch methods for User & Group

Author: elminster-aom

github/enterprise_scim.go

@@ -22,6 +22,10 @@ const SCIMSchemasURINamespacesUser = "urn:ietf:params:scim:schemas:core:2.0:User
 // This constant represents the standard SCIM namespace for list responses used in paginated queries, as defined by RFC 7644.
 const SCIMSchemasURINamespacesListResponse = "urn:ietf:params:scim:api:messages:2.0:ListResponse"
 
+// SCIMSchemasURINamespacesPatchOp is the SCIM schema URI namespace for patch operations.
+// This constant represents the standard SCIM namespace for patch operations as defined by RFC 7644.
+const SCIMSchemasURINamespacesPatchOp = "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+
 // SCIMEnterpriseGroupAttributes represents supported SCIM Enterprise group attributes.
 //
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#supported-scim-group-attributes
@@ -140,6 +144,21 @@ type ListProvisionedSCIMUsersEnterpriseOptions struct {
 	Count *int `url:"count,omitempty"`
 }
 
+// SCIMEnterpriseAttributeOptions represents options for UpdateAttributeSCIMGroup or UpdateAttributeSCIMUser.
+//
+// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
+type SCIMEnterpriseAttributeOptions struct {
+	Schemas    []string                            `json:"schemas"`    // The URIs that are used to indicate the namespaces for a SCIM patch operation.
+	Operations []SCIMEnterpriseAttributeOperations `json:"Operations"` // Set of operations to be performed.
+}
+
+// SCIMEnterpriseAttributeOperations represents operations for UpdateAttributeSCIMGroup or UpdateAttributeSCIMUser.
+type SCIMEnterpriseAttributeOperations struct {
+	Op    string  `json:"op"`              // Can be one of: add, replace, remove
+	Path  *string `json:"path,omitempty"`  // Path to the attribute being modified (Filters are not supported).
+	Value *string `json:"value,omitempty"` // New value for the attribute being modified.
+}
+
 // ListProvisionedSCIMGroups lists provisioned SCIM groups in an enterprise.
 //
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise
@@ -193,3 +212,47 @@ func (s *EnterpriseService) ListProvisionedSCIMUsers(ctx context.Context, enterp
 
 	return users, resp, nil
 }
+
+// UpdateAttributeSCIMGroup Update a provisioned group’s individual attributes.
+//
+// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
+//
+//meta:operation PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
+func (s *EnterpriseService) UpdateAttributeSCIMGroup(ctx context.Context, enterprise, scimGroupID string, opts SCIMEnterpriseAttributeOptions) (*SCIMEnterpriseGroupAttributes, *Response, error) {
+	u := fmt.Sprintf("scim/v2/enterprises/%v/Groups/%v", enterprise, scimGroupID)
+	req, err := s.client.NewRequest("PATCH", u, opts)
+	if err != nil {
+		return nil, nil, err
+	}
+	req.Header.Set("Accept", mediaTypeSCIM)
+
+	group := new(SCIMEnterpriseGroupAttributes)
+	resp, err := s.client.Do(ctx, req, group)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return group, resp, nil
+}
+
+// UpdateAttributeSCIMUser Update a provisioned user's individual attributes.
+//
+// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
+//
+//meta:operation PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
+func (s *EnterpriseService) UpdateAttributeSCIMUser(ctx context.Context, enterprise, scimUserID string, opts SCIMEnterpriseAttributeOptions) (*SCIMEnterpriseUserAttributes, *Response, error) {
+	u := fmt.Sprintf("scim/v2/enterprises/%v/Users/%v", enterprise, scimUserID)
+	req, err := s.client.NewRequest("PATCH", u, opts)
+	if err != nil {
+		return nil, nil, err
+	}
+	req.Header.Set("Accept", mediaTypeSCIM)
+
+	user := new(SCIMEnterpriseUserAttributes)
+	resp, err := s.client.Do(ctx, req, user)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return user, resp, nil
+}

github/enterprise_scim_test.go

@@ -244,6 +244,37 @@ func TestSCIMEnterpriseGroupAttributes_Marshal(t *testing.T) {
 	testJSONMarshal(t, u, want)
 }
 
+func TestSCIMEnterpriseAttributeOptions_Marshal(t *testing.T) {
+	t.Parallel()
+	testJSONMarshal(t, &SCIMEnterpriseAttributeOptions{}, "{}")
+
+	u := &SCIMEnterpriseAttributeOptions{
+		Schemas: []string{"s"},
+		Operations: []SCIMEnterpriseAttributeOperations{{
+			Op:    "o1",
+			Path:  Ptr("p1"),
+			Value: Ptr("v1"),
+		},
+			{
+				Op: "o2",
+			}},
+	}
+
+	want := `{
+		"schemas": ["s"],
+		"Operations": [{
+			"op": "o1",
+			"path": "p1",
+			"value": "v1"
+		},
+		{
+			"op": "o2"
+		}]
+	}`
+
+	testJSONMarshal(t, u, want)
+}
+
 func TestEnterpriseService_ListProvisionedSCIMGroups(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
@@ -445,3 +476,185 @@ func TestEnterpriseService_ListProvisionedSCIMUsers(t *testing.T) {
 		return resp, err
 	})
 }
+
+func TestEnterpriseService_UpdateAttributeSCIMGroup(t *testing.T) {
+	t.Parallel()
+	client, mux, _ := setup(t)
+
+	mux.HandleFunc("/scim/v2/enterprises/ee/Groups/abcd", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "PATCH")
+		testHeader(t, r, "Accept", mediaTypeSCIM)
+		testBody(t, r, `{"schemas":["`+SCIMSchemasURINamespacesPatchOp+`"],"Operations":[{"op":"replace","path":"displayName","value":"Employees"}]}`+"\n")
+		w.WriteHeader(http.StatusOK)
+		fmt.Fprint(w, `{
+			"schemas": ["`+SCIMSchemasURINamespacesGroups+`"],
+			"id": "abcd",
+			"externalId": "8aa1",
+			"displayName": "Employees",
+			"members": [{
+				"value": "879d",
+				"$ref": "https://api.github.localhost/scim/v2/enterprises/ee/Users/879d",
+				"display": "User 1"
+			}],
+			"meta": {
+				"resourceType": "Group",
+				"created": `+referenceTimeStr+`,
+				"lastModified": `+referenceTimeStr+`,
+				"location": "https://api.github.localhost/scim/v2/enterprises/ee/Groups/abcd"
+			}
+		}`)
+	})
+	want := &SCIMEnterpriseGroupAttributes{
+		Schemas:     []string{SCIMSchemasURINamespacesGroups},
+		ID:          Ptr("abcd"),
+		ExternalID:  Ptr("8aa1"),
+		DisplayName: Ptr("Employees"),
+		Members: []*SCIMEnterpriseDisplayReference{{
+			Value:   "879d",
+			Ref:     "https://api.github.localhost/scim/v2/enterprises/ee/Users/879d",
+			Display: Ptr("User 1"),
+		}},
+		Meta: &SCIMEnterpriseMeta{
+			ResourceType: "Group",
+			Created:      &Timestamp{referenceTime},
+			LastModified: &Timestamp{referenceTime},
+			Location:     Ptr("https://api.github.localhost/scim/v2/enterprises/ee/Groups/abcd"),
+		},
+	}
+
+	ctx := t.Context()
+	input := SCIMEnterpriseAttributeOptions{
+		Schemas: []string{SCIMSchemasURINamespacesPatchOp},
+		Operations: []SCIMEnterpriseAttributeOperations{{
+			Op:    "replace",
+			Path:  Ptr("displayName"),
+			Value: Ptr("Employees"),
+		}},
+	}
+	got, _, err := client.Enterprise.UpdateAttributeSCIMGroup(ctx, "ee", "abcd", input)
+	if err != nil {
+		t.Fatalf("Enterprise.UpdateAttributeSCIMGroup returned unexpected error: %v", err)
+	}
+	if diff := cmp.Diff(want, got); diff != "" {
+		t.Errorf("Enterprise.UpdateAttributeSCIMGroup diff mismatch (-want +got):\n%v", diff)
+	}
+
+	const methodName = "UpdateAttributeSCIMGroup"
+	testBadOptions(t, methodName, func() (err error) {
+		_, _, err = client.Enterprise.UpdateAttributeSCIMGroup(ctx, "\n", "\n", SCIMEnterpriseAttributeOptions{})
+		return err
+	})
+
+	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
+		got, resp, err := client.Enterprise.UpdateAttributeSCIMGroup(ctx, "ee", "abcd", input)
+		if got != nil {
+			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
+		}
+		return resp, err
+	})
+}
+
+func TestEnterpriseService_UpdateAttributeSCIMUser(t *testing.T) {
+	t.Parallel()
+	client, mux, _ := setup(t)
+
+	mux.HandleFunc("/scim/v2/enterprises/ee/Users/7fce", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "PATCH")
+		testHeader(t, r, "Accept", mediaTypeSCIM)
+		testBody(t, r, `{"schemas":["`+SCIMSchemasURINamespacesPatchOp+`"],"Operations":[{"op":"replace","path":"emails[type eq 'work'].value","value":"[email protected]"},{"op":"replace","path":"name.familyName","value":"updatedFamilyName"}]}`+"\n")
+		w.WriteHeader(http.StatusOK)
+		fmt.Fprint(w, `{
+			"schemas": ["`+SCIMSchemasURINamespacesUser+`"],
+			"id": "7fce",
+			"externalId": "e123",
+			"active": true,
+			"userName": "e123",
+			"name": {
+				"formatted": "John Doe X",
+				"familyName": "updatedFamilyName",
+				"givenName": "John",
+				"middleName": "X"
+			},
+			"displayName": "John Doe",
+			"emails": [{
+				"value": "[email protected]",
+				"type": "work",
+				"primary": true
+			}],
+			"roles": [{
+				"value": "User",
+				"primary": false
+			}],
+			"meta": {
+				"resourceType": "User",
+				"created": `+referenceTimeStr+`,
+				"lastModified": `+referenceTimeStr+`,
+				"location": "https://api.github.localhost/scim/v2/enterprises/ee/Users/7fce"
+			}
+		}`)
+	})
+	want := &SCIMEnterpriseUserAttributes{
+		Schemas:     []string{SCIMSchemasURINamespacesUser},
+		ID:          Ptr("7fce"),
+		ExternalID:  "e123",
+		Active:      true,
+		UserName:    "e123",
+		DisplayName: "John Doe",
+		Name: &SCIMEnterpriseUserName{
+			Formatted:  Ptr("John Doe X"),
+			FamilyName: "updatedFamilyName",
+			GivenName:  "John",
+			MiddleName: Ptr("X"),
+		},
+		Emails: []*SCIMEnterpriseUserEmail{{
+			Value:   "[email protected]",
+			Type:    "work",
+			Primary: true,
+		}},
+		Roles: []*SCIMEnterpriseUserRole{{
+			Value:   "User",
+			Primary: Ptr(false),
+		}},
+		Meta: &SCIMEnterpriseMeta{
+			ResourceType: "User",
+			Created:      &Timestamp{referenceTime},
+			LastModified: &Timestamp{referenceTime},
+			Location:     Ptr("https://api.github.localhost/scim/v2/enterprises/ee/Users/7fce"),
+		},
+	}
+
+	ctx := t.Context()
+	input := SCIMEnterpriseAttributeOptions{
+		Schemas: []string{SCIMSchemasURINamespacesPatchOp},
+		Operations: []SCIMEnterpriseAttributeOperations{{
+			Op:    "replace",
+			Path:  Ptr("emails[type eq 'work'].value"),
+			Value: Ptr("[email protected]"),
+		}, {
+			Op:    "replace",
+			Path:  Ptr("name.familyName"),
+			Value: Ptr("updatedFamilyName"),
+		}},
+	}
+	got, _, err := client.Enterprise.UpdateAttributeSCIMUser(ctx, "ee", "7fce", input)
+	if err != nil {
+		t.Fatalf("Enterprise.UpdateAttributeSCIMUser returned unexpected error: %v", err)
+	}
+	if diff := cmp.Diff(want, got); diff != "" {
+		t.Errorf("Enterprise.UpdateAttributeSCIMUser diff mismatch (-want +got):\n%v", diff)
+	}
+
+	const methodName = "UpdateAttributeSCIMUser"
+	testBadOptions(t, methodName, func() (err error) {
+		_, _, err = client.Enterprise.UpdateAttributeSCIMUser(ctx, "\n", "\n", SCIMEnterpriseAttributeOptions{})
+		return err
+	})
+
+	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
+		got, resp, err := client.Enterprise.UpdateAttributeSCIMUser(ctx, "ee", "7fce", input)
+		if got != nil {
+			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
+		}
+		return resp, err
+	})
+}