-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Implement SCIM #2062
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
Implement SCIM #2062
Changes from 3 commits
f20a77c
13d5e3f
ffb327a
21471e8
ccc1749
8a71369
f7aa77e
bf0a905
895980e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,4 +4,5 @@ coverage.out | |
| # intellij files | ||
| .idea/ | ||
| vendor/ | ||
| .DS_Store | ||
| .DS_Store | ||
| .vscode | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| package github | ||
gmlewis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| ) | ||
|
|
||
| // SCIMService provides access to SCIM related functions in the | ||
| // GitHub API. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/en/rest/reference/scim | ||
| type SCIMService service | ||
|
|
||
| type SCIMUserAttributes struct { | ||
gmlewis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| UserName string `json:"user_name"` // Configured by the admin. Could be an email, login, or username. (Required.) | ||
| Name SCIMUserName `json:"name"` // (Required.) | ||
| DisplayName *string `json:"display_name,omitempty"` // The name of the user, suitable for display to end-users. (Optional.) | ||
| Emails []*SCIMUserEmails `json:"email"` // User emails. (Required.) | ||
| Schemas []*string `json:"schemas,omitempty"` // (Optional.) | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ExternalID *string `json:"external_id,omitempty"` // (Optional.) | ||
| Groups []*string `json:"groups,omitempty"` // (Optional.) | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Active bool `json:"active,omitempty"` // (Optional.) | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| type SCIMUserName struct { | ||
| GivenName string `json:"given_name"` // The first name of the user. (Required.) | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| FamilyName string `json:"family_name"` // The last name of the user. (Required.) | ||
|
||
| Formatted *string `json:"formatted,omitempty"` // (Optional.) | ||
| } | ||
|
|
||
| type SCIMUserEmails struct { | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Value string `json:"value"` // (Required.) | ||
| Primary bool `json:"primary,omitempty"` // (Optional.) | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Type *string `json:"type,omitempty"` // (Optional.) | ||
| } | ||
|
|
||
| type ListSCIMProvisionedIdentitiesOptions struct { | ||
| StartIndex *int `json:"start_index,omitempty"` // Used for pagination: the index of the first result to return. (Optional.) | ||
| Count *int `json:"count,omitempty"` // Used for pagination: the number of results to return. (Optional.) | ||
| Filter *string `json:"filter,omitempty"` // Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query: ?filter=userName%20eq%20\"Octocat\". To filter results for the identity with the email [email protected], you would use this query: ?filter=emails%20eq%20\"[email protected]\". (Optional.) | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // ListSCIMProvisionedIdentities lists SCIM provisioned identities. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/en/rest/reference/scim#list-scim-provisioned-identities | ||
| func (s *SCIMService) ListSCIMProvisionedIdentities(ctx context.Context, org string, opts *ListSCIMProvisionedIdentitiesOptions) (*Response, error) { | ||
| u := fmt.Sprintf("scim/v2/organizations/%v/Users", org) | ||
| u, err := addOptions(u, opts) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| req, err := s.client.NewRequest("GET", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return s.client.Do(ctx, req, nil) | ||
| } | ||
|
|
||
| // ProvisionAndInviteSCIMUser provisions organization membership for a user, and send an activation email to the email address. | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // | ||
| // GitHub API docs: https://docs.github.com/en/rest/reference/scim#provision-and-invite-a-scim-user | ||
| func (s *SCIMService) ProvisionAndInviteSCIMUser(ctx context.Context, org string, opts *SCIMUserAttributes) (*Response, error) { | ||
| u := fmt.Sprintf("scim/v2/organizations/%v/Users", org) | ||
| u, err := addOptions(u, opts) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| req, err := s.client.NewRequest("POST", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return s.client.Do(ctx, req, nil) | ||
| } | ||
|
|
||
| // GetSCIMProvisioningInfoForUser returns SCIM provisioning information for a user | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // | ||
| // GitHub API docs: https://docs.github.com/en/rest/reference/scim#get-scim-provisioning-information-for-a-user | ||
| func (s *SCIMService) GetSCIMProvisioningInfoForUser(ctx context.Context, org, scimUserID string) (*Response, error) { | ||
| u := fmt.Sprintf("scim/v2/organizations/%v/Users/%v", org, scimUserID) | ||
| req, err := s.client.NewRequest("GET", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return s.client.Do(ctx, req, nil) | ||
| } | ||
|
|
||
| // UpdateProvisionedOrgMembership updates a provisioned organization membership. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/en/rest/reference/scim#update-a-provisioned-organization-membership | ||
| func (s *SCIMService) UpdateProvisionedOrgMembership(ctx context.Context, org, scimUserID string, opts *SCIMUserAttributes) (*Response, error) { | ||
| u := fmt.Sprintf("scim/v2/organizations/%v/Users/%v", org, scimUserID) | ||
| u, err := addOptions(u, opts) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| req, err := s.client.NewRequest("PUT", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return s.client.Do(ctx, req, nil) | ||
| } | ||
|
|
||
| type UpdateAttributeForSCIMUserOptions struct { | ||
gmlewis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Schemas []*string `json:"schemas"` // (Optional.) | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Operations UpdateAttributeForSCIMUserOperations `json:"operations"` // Set of operations to be performed. (Required.) | ||
| } | ||
|
|
||
| type UpdateAttributeForSCIMUserOperations struct { | ||
| Op string `json:"op"` // (Required.) | ||
| Path *string `json:"path,omitempty"` // (Optional.) | ||
| Value json.RawMessage `json:"value,omitempty"` // (Optional.) | ||
| } | ||
|
|
||
| // UpdateAttributeForSCIMUser updates an attribute for an SCIM user. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/en/rest/reference/scim#update-an-attribute-for-a-scim-user | ||
| func (s *SCIMService) UpdateAttributeForSCIMUser(ctx context.Context, org, scimUserID string, opts *UpdateAttributeForSCIMUserOptions) (*Response, error) { | ||
| u := fmt.Sprintf("scim/v2/organizations/%v/Users/%v", org, scimUserID) | ||
| u, err := addOptions(u, opts) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| req, err := s.client.NewRequest("PATCH", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return s.client.Do(ctx, req, nil) | ||
| } | ||
|
|
||
| // DeleteSCIMUserFromOrg deletes SCIM user from an organization | ||
gmlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // | ||
| // GitHub API docs: https://docs.github.com/en/rest/reference/scim#delete-a-scim-user-from-an-organization | ||
| func (s *SCIMService) DeleteSCIMUserFromOrg(ctx context.Context, org, scimUserID string) (*Response, error) { | ||
| u := fmt.Sprintf("scim/v2/organizations/%v/Users/%v", org, scimUserID) | ||
| req, err := s.client.NewRequest("DELETE", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return s.client.Do(ctx, req, nil) | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.