feat: Implement Enterprise SCIM - Update Group & User attributes (#3848)

Author: elminster-aom

github/enterprise_scim.go

@@ -22,14 +22,18 @@ 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"
 
-// SCIMEnterpriseGroupAttributes represents supported SCIM Enterprise group attributes.
+// 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, and represents the result of calling UpdateSCIMGroupAttribute.
 //
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#supported-scim-group-attributes
 type SCIMEnterpriseGroupAttributes struct {
 	DisplayName *string                           `json:"displayName,omitempty"` // Human-readable name for a group.
 	Members     []*SCIMEnterpriseDisplayReference `json:"members,omitempty"`     // List of members who are assigned to the group in SCIM provider
 	ExternalID  *string                           `json:"externalId,omitempty"`  // This identifier is generated by a SCIM provider. Must be unique per user.
-	// Bellow: Only populated as a result of calling SetSCIMInformationForProvisionedGroup:
+	// Bellow: Only populated as a result of calling UpdateSCIMGroupAttribute:
 	Schemas []string            `json:"schemas,omitempty"` // The URIs that are used to indicate the namespaces of the SCIM schemas.
 	ID      *string             `json:"id,omitempty"`      // The internally generated id for the group object.
 	Meta    *SCIMEnterpriseMeta `json:"meta,omitempty"`    // The metadata associated with the creation/updates to the group.
@@ -76,7 +80,8 @@ type ListProvisionedSCIMGroupsEnterpriseOptions struct {
 	Count *int `url:"count,omitempty"`
 }
 
-// SCIMEnterpriseUserAttributes represents supported SCIM enterprise user attributes.
+// SCIMEnterpriseUserAttributes represents supported SCIM enterprise user attributes, and represents the result of calling UpdateSCIMUserAttribute.
+//
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#supported-scim-user-attributes
 type SCIMEnterpriseUserAttributes struct {
 	DisplayName string                     `json:"displayName"`     // Human-readable name for a user
@@ -87,7 +92,7 @@ type SCIMEnterpriseUserAttributes struct {
 	ExternalID  string                     `json:"externalId"`      // This identifier is generated by a SCIM provider. Must be unique per user.
 	Active      bool                       `json:"active"`          // Indicates whether the identity is active (true) or should be suspended (false).
 	Schemas     []string                   `json:"schemas"`         // The URIs that are used to indicate the namespaces of the SCIM schemas.
-	// Bellow: Only populated as a result of calling SetSCIMInformationForProvisionedUser:
+	// Bellow: Only populated as a result of calling UpdateSCIMUserAttribute:
 	ID     *string                           `json:"id,omitempty"`     // Identifier generated by the GitHub's SCIM endpoint.
 	Groups []*SCIMEnterpriseDisplayReference `json:"groups,omitempty"` // List of groups who are assigned to the user in SCIM provider
 	Meta   *SCIMEnterpriseMeta               `json:"meta,omitempty"`   // The metadata associated with the creation/updates to the user.
@@ -116,7 +121,7 @@ type SCIMEnterpriseUserRole struct {
 	Primary *bool   `json:"primary,omitempty"` // Is the role a primary role for the user?
 }
 
-// SCIMEnterpriseUsers represents the result of calling ProvisionSCIMEnterpriseUser.
+// SCIMEnterpriseUsers represents the result of calling ListProvisionedSCIMUsers.
 type SCIMEnterpriseUsers struct {
 	Schemas      []string                        `json:"schemas,omitempty"`
 	TotalResults *int                            `json:"totalResults,omitempty"`
@@ -125,7 +130,7 @@ type SCIMEnterpriseUsers struct {
 	Resources    []*SCIMEnterpriseUserAttributes `json:"Resources,omitempty"`
 }
 
-// ListProvisionedSCIMUsersEnterpriseOptions represents query parameters for ListSCIMProvisionedUsers.
+// ListProvisionedSCIMUsersEnterpriseOptions represents query parameters for ListProvisionedSCIMUsers.
 //
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise
 type ListProvisionedSCIMUsersEnterpriseOptions struct {
@@ -140,6 +145,21 @@ type ListProvisionedSCIMUsersEnterpriseOptions struct {
 	Count *int `url:"count,omitempty"`
 }
 
+// SCIMEnterpriseAttribute represents attribute operations for UpdateSCIMGroupAttribute or UpdateSCIMUserAttribute.
+//
+// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
+type SCIMEnterpriseAttribute struct {
+	Schemas    []string                            `json:"schemas"`    // The URIs that are used to indicate the namespaces for a SCIM patch operation.
+	Operations []*SCIMEnterpriseAttributeOperation `json:"Operations"` // Set of operations to be performed.
+}
+
+// SCIMEnterpriseAttributeOperation represents an operation for UpdateSCIMGroupAttribute or UpdateSCIMUserAttribute.
+type SCIMEnterpriseAttributeOperation 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 +213,47 @@ func (s *EnterpriseService) ListProvisionedSCIMUsers(ctx context.Context, enterp
 
 	return users, resp, nil
 }
+
+// UpdateSCIMGroupAttribute updates 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) UpdateSCIMGroupAttribute(ctx context.Context, enterprise, scimGroupID string, attribute SCIMEnterpriseAttribute) (*SCIMEnterpriseGroupAttributes, *Response, error) {
+	u := fmt.Sprintf("scim/v2/enterprises/%v/Groups/%v", enterprise, scimGroupID)
+	req, err := s.client.NewRequest("PATCH", u, attribute)
+	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
+}
+
+// UpdateSCIMUserAttribute updates 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) UpdateSCIMUserAttribute(ctx context.Context, enterprise, scimUserID string, attribute SCIMEnterpriseAttribute) (*SCIMEnterpriseUserAttributes, *Response, error) {
+	u := fmt.Sprintf("scim/v2/enterprises/%v/Users/%v", enterprise, scimUserID)
+	req, err := s.client.NewRequest("PATCH", u, attribute)
+	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
+}