feat!: Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMGroups #3814

elminster-aom · 2025-11-07T23:52:37Z

Summary

From API Docs https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/scim, implement:

GET /scim/v2/enterprises/{enterprise}/Groups

Breaking Change

The SCIMService.ListSCIMProvisionedGroupsForEnterprise method has been moved to EnterpriseService.ListProvisionedSCIMEnterpriseGroups.

…CIMGroupsForEnterprise

…terprise

…google#3806) (google#3811)

…oogle#3819)

codecov · 2025-11-11T19:53:12Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.33%. Comparing base (025030e) to head (4ed75ac).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3814   +/-   ##
=======================================
  Coverage   92.33%   92.33%           
=======================================
  Files         194      195    +1     
  Lines       13990    13990           
=======================================
  Hits        12917    12917           
  Misses        884      884           
  Partials      189      189

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gmlewis

Thanks, @elminster-aom!
Did we agree in another PR not to have methods end with the suffix ...ForEnterprise?

github/enterprise_scim.go

gmlewis · 2025-11-12T17:19:42Z

github/enterprise_scim.go

+// SCIMEnterpriseDisplayReference represents a JSON SCIM (System for Cross-domain Identity Management) resource.
+type SCIMEnterpriseDisplayReference struct {
+	Value   string  `json:"value"`             // The local unique identifier for the member
+	Ref     string  `json:"$ref"`              //nolint:jsonfieldname // The $ref is a standard SCIM field


Sorry about this. I should update jsonfieldname linter to ignore the dollar sign. I'll work on that.

I understand that in the meantime, I must keep the //nolint:jsonfieldname.

Oh, I forgot... this is one of those cases that can be handled by adding a line like this one to the exceptions list:

go-github/.golangci.yml

Line 205 in 025030e

- SCIMDisplayReference.Ref

Thanks, this is a better solution (commit 862685b)

github/enterprise_scim.go

alexandear · 2025-11-12T19:24:52Z

github/enterprise_scim.go

+// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise
+//
+//meta:operation GET /scim/v2/enterprises/{enterprise}/Groups
+func (s *EnterpriseService) ListProvisionedSCIMGroupsForEnterprise(ctx context.Context, enterprise string, opts *ListProvisionedSCIMGroupsForEnterpriseOptions) (*SCIMEnterpriseGroups, *Response, error) {


I think we can simplify:

Suggested change

func (s *EnterpriseService) ListProvisionedSCIMGroupsForEnterprise(ctx context.Context, enterprise string, opts *ListProvisionedSCIMGroupsForEnterpriseOptions) (*SCIMEnterpriseGroups, *Response, error) {

func (s *EnterpriseService) ListProvisionedSCIMGroups(ctx context.Context, enterprise string, opts *ListProvisionedSCIMGroupsOptions) (*SCIMEnterpriseGroups, *Response, error) {

As mentioned in #issuecomment-3527067929, I find it can be confusing when compared to the organization-SCIM resources, such as:

The GET /scim/v2/organizations/{org}/Users endpoint is implemented as ListSCIMProvisionedIdentities()

Following your suggestion, the method for GET /scim/v2/enterprises/{enterprise}/Users endpoint must be ListProvisionedSCIMUsers() but I find easier to understand ListProvisionedSCIMEnterpriseUsers().

Based on that, I would like to suggest ListProvisionedSCIMEnterpriseGroups() & ListProvisionedSCIMEnterpriseGroupsOptions here, but I am happy to follow your advice.

Sorry, I was this slow. Thanks @gmlewis

the service must first be specified, like enterpriseService.MethodToCall

So I'd like to change my previous suggestion. What about ListProvisionedSCIMGroups() & ListProvisionedSCIMGroupsEnterpriseOptions?

…nterpriseGroups

elminster-aom · 2025-11-13T10:29:32Z

Did we agree in another PR not to have methods end with the suffix ...ForEnterprise?

@gmlewis, I couldn't find the PR you mention but I think the word "Enterprise" should appear somehow (Maybe with just an "E"? Suggestions are welcome) otherwise it may get confusing with the other SCIM resources in /github/scim.go.

gmlewis · 2025-11-13T12:40:31Z

Did we agree in another PR not to have methods end with the suffix ...ForEnterprise?

@gmlewis, I couldn't find the PR you mention but I think the word "Enterprise" should appear somehow (Maybe with just an "E"? Suggestions are welcome) otherwise it may get confusing with the other SCIM resources in /github/scim.go.

The idea is that for all our methods, the service must first be specified, like enterpriseService.MethodToCall so we shouldn't need to repeat the ForEnterprise part.

gmlewis

Thank you, @elminster-aom!
LGTM
Awaiting second LGTM+Approval before merging.

cc: @alexandear

elminster-aom · 2025-11-13T15:11:40Z

github/enterprise_scim.go

+type ListProvisionedSCIMGroupsEnterpriseOptions struct {
+	// If specified, only results that match the specified filter will be returned. Multiple filters are not supported.
+	// Possible filters are `externalId`, id, and `displayName`. For example,`?filter=externalId eq "9138790-10932-109120392-12321"`.
+	Filter *string `url:"filter,omitempty"`
+	// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
+	ExcludedAttributes *string `url:"excludedAttributes,omitempty"`
+	// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
+	// Default: 1.
+	StartIndex *int `url:"startIndex,omitempty"`
+	// Used for pagination: the number of results to return per page.
+	// Default: 30.
+	Count *int `url:"count,omitempty"`
+}


Did I make a mistake here using pointers?

Suggested change

type ListProvisionedSCIMGroupsEnterpriseOptions struct {

// If specified, only results that match the specified filter will be returned. Multiple filters are not supported.

// Possible filters are `externalId`, id, and `displayName`. For example,`?filter=externalId eq "9138790-10932-109120392-12321"`.

Filter *string `url:"filter,omitempty"`

// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

ExcludedAttributes *string `url:"excludedAttributes,omitempty"`

// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

// Default: 1.

StartIndex *int `url:"startIndex,omitempty"`

// Used for pagination: the number of results to return per page.

// Default: 30.

Count *int `url:"count,omitempty"`

}

type ListProvisionedSCIMGroupsEnterpriseOptions struct {

// If specified, only results that match the specified filter will be returned. Multiple filters are not supported.

// Possible filters are `externalId`, id, and `displayName`. For example,`?filter=externalId eq "9138790-10932-109120392-12321"`.

Filter string `url:"filter,omitempty"`

// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

ExcludedAttributes string `url:"excludedAttributes,omitempty"`

// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

// Default: 1.

StartIndex int `url:"startIndex,omitempty"`

// Used for pagination: the number of results to return per page.

// Default: 30.

Count int `url:"count,omitempty"`

}

Yes.

go-github/github/github.go

Lines 262 to 288 in 4ed75ac

type ListCursorOptions struct {

// For paginated result sets, page of results to retrieve.

Page string `url:"page,omitempty"`

// For paginated result sets, the number of results to include per page.

PerPage int `url:"per_page,omitempty"`

// For paginated result sets, the number of results per page (max 100), starting from the first matching result.

// This parameter must not be used in combination with last.

First int `url:"first,omitempty"`

// For paginated result sets, the number of results per page (max 100), starting from the last matching result.

// This parameter must not be used in combination with first.

Last int `url:"last,omitempty"`

// A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

After string `url:"after,omitempty"`

// A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

Before string `url:"before,omitempty"`

// A cursor, as given in the Link header. If specified, the query continues the search using this cursor.

Cursor string `url:"cursor,omitempty"`

}

// UploadOptions specifies the parameters to methods that support uploads.

type UploadOptions struct {

Thank you and done (commit e8fffba)

github/enterprise_scim.go

alexandear · 2025-11-13T15:57:37Z

github/enterprise_scim.go

+type ListProvisionedSCIMGroupsEnterpriseOptions struct {
+	// If specified, only results that match the specified filter will be returned. Multiple filters are not supported.
+	// Possible filters are `externalId`, id, and `displayName`. For example,`?filter=externalId eq "9138790-10932-109120392-12321"`.
+	Filter *string `url:"filter,omitempty"`
+	// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
+	ExcludedAttributes *string `url:"excludedAttributes,omitempty"`
+	// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
+	// Default: 1.
+	StartIndex *int `url:"startIndex,omitempty"`
+	// Used for pagination: the number of results to return per page.
+	// Default: 30.
+	Count *int `url:"count,omitempty"`
+}


Yes.

go-github/github/github.go

Lines 262 to 288 in 4ed75ac

type ListCursorOptions struct {

// For paginated result sets, page of results to retrieve.

Page string `url:"page,omitempty"`

// For paginated result sets, the number of results to include per page.

PerPage int `url:"per_page,omitempty"`

// For paginated result sets, the number of results per page (max 100), starting from the first matching result.

// This parameter must not be used in combination with last.

First int `url:"first,omitempty"`

// For paginated result sets, the number of results per page (max 100), starting from the last matching result.

// This parameter must not be used in combination with first.

Last int `url:"last,omitempty"`

// A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

After string `url:"after,omitempty"`

// A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

Before string `url:"before,omitempty"`

// A cursor, as given in the Link header. If specified, the query continues the search using this cursor.

Cursor string `url:"cursor,omitempty"`

}

// UploadOptions specifies the parameters to methods that support uploads.

type UploadOptions struct {

Co-authored-by: Oleksandr Redko <[email protected]>

elminster-aom added 4 commits November 8, 2025 00:29

Initial Enterprise SCIM schema

65b5cfe

Add missing type structs

c1c2f12

Deprecate ListSCIMProvisionedGroupsForEnterprise for ListProvisionedS…

f7d36fc

…CIMGroupsForEnterprise

Refactor - Focus on ListProvisionedSCIMGroupsForEnterprise only

0838cc2

elminster-aom changed the title ~~Implement Enterprise SCIM~~ Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMGroupsForEnterprise Nov 10, 2025

elminster-aom and others added 10 commits November 10, 2025 07:41

Breaking change - Refactor SCIMService.ListSCIMProvisionedGroupsForEn…

a08d988

…terprise

Bump version of go-github to v78.0.0 (google#3815)

0700f94

Bump go-github from v77 to v78 in /scrape (google#3816)

b7731e5

chore: Enable 'modernize'; bump golangci-lint to v2.6.1 (google#3817)

ab42c15

feat: Add required_reviewers support to PullRequestRuleParameters (…

2b21b37

…google#3806) (google#3811)

Add support for new custom properties for orgs APIs (google#3804)

2568481

build(deps): Bump golang.org/x/sync from 0.17.0 to 0.18.0 in /tools (g…

a44d6ae

…oogle#3819)

chore: Enable nolintlint linter (google#3821)

c2d8c9e

Fix struct type issues and adjust standards

ee7887d

Merge branch 'master' into enterpriseSCIM

6bdaa40

elminster-aom marked this pull request as ready for review November 12, 2025 16:58

elminster-aom mentioned this pull request Nov 12, 2025

Implement Enterprise SCIM #3813

Open

12 tasks

Merge branch 'master' into enterpriseSCIM

5e283e1

gmlewis added NeedsReview PR is awaiting a review before merging. Breaking API Change PR will require a bump to the major version num in next release. Look here to see the change(s). labels Nov 12, 2025

gmlewis mentioned this pull request Nov 12, 2025

fix!: Fix field selection and bugs in ProjectsV2 GET endpoints #3809

Merged

gmlewis requested changes Nov 12, 2025

View reviewed changes

alexandear reviewed Nov 12, 2025

View reviewed changes

elminster-aom added 3 commits November 13, 2025 07:55

Rename ListProvisionedSCIMGroupsForEnterprise to ListProvisionedSCIME…

b33cd46

…nterpriseGroups

Improve comments

7bc8c30

Improve nomenclature

af91ab8

elminster-aom requested review from alexandear and gmlewis November 13, 2025 10:52

elminster-aom changed the title ~~Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMGroupsForEnterprise~~ Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMEnterpriseGroups Nov 13, 2025

elminster-aom and others added 2 commits November 13, 2025 13:54

Fix lint issue with jsonfieldname

862685b

Merge branch 'master' into enterpriseSCIM

e506052

gmlewis changed the title ~~Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMEnterpriseGroups~~ feat!: Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMEnterpriseGroups Nov 13, 2025

gmlewis approved these changes Nov 13, 2025

View reviewed changes

elminster-aom changed the title ~~feat!: Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMEnterpriseGroups~~ feat!: Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMGroups Nov 13, 2025

Simplify to ListProvisionedSCIMGroups()

4ed75ac

elminster-aom commented Nov 13, 2025

View reviewed changes

alexandear reviewed Nov 13, 2025

View reviewed changes

gmlewis mentioned this pull request Nov 13, 2025

Update jsonfieldname linter to support $ in json tag names #3826

Open

elminster-aom and others added 3 commits November 14, 2025 07:51

Fix ListProvisionedSCIMGroupsEnterpriseOptions type

e8fffba

Update github/enterprise_scim.go

919fbd9

Co-authored-by: Oleksandr Redko <[email protected]>

Merge branch 'master' into enterpriseSCIM

9de4f3d

alexandear approved these changes Nov 14, 2025

View reviewed changes

	func (s EnterpriseService) ListProvisionedSCIMGroupsForEnterprise(ctx context.Context, enterprise string, opts ListProvisionedSCIMGroupsForEnterpriseOptions) (SCIMEnterpriseGroups, Response, error) {
	func (s EnterpriseService) ListProvisionedSCIMGroups(ctx context.Context, enterprise string, opts ListProvisionedSCIMGroupsOptions) (SCIMEnterpriseGroups, Response, error) {

	type ListCursorOptions struct {
	// For paginated result sets, page of results to retrieve.
	Page string `url:"page,omitempty"`

	// For paginated result sets, the number of results to include per page.
	PerPage int `url:"per_page,omitempty"`

	// For paginated result sets, the number of results per page (max 100), starting from the first matching result.
	// This parameter must not be used in combination with last.
	First int `url:"first,omitempty"`

	// For paginated result sets, the number of results per page (max 100), starting from the last matching result.
	// This parameter must not be used in combination with first.
	Last int `url:"last,omitempty"`

	// A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
	After string `url:"after,omitempty"`

	// A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
	Before string `url:"before,omitempty"`

	// A cursor, as given in the Link header. If specified, the query continues the search using this cursor.
	Cursor string `url:"cursor,omitempty"`
	}

	// UploadOptions specifies the parameters to methods that support uploads.
	type UploadOptions struct {

feat!: Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMGroups #3814

Are you sure you want to change the base?

feat!: Implement Enterprise SCIM - EnterpriseService.ListProvisionedSCIMGroups #3814

Conversation

elminster-aom commented Nov 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Breaking Change

Uh oh!

codecov bot commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elminster-aom Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elminster-aom commented Nov 13, 2025

Uh oh!

gmlewis commented Nov 13, 2025

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

elminster-aom commented Nov 7, 2025 •

edited

Loading

codecov bot commented Nov 11, 2025 •

edited

Loading

elminster-aom Nov 13, 2025 •

edited

Loading