This is an open source implementation of the SCIM v2.0 specification for use in Golang. SCIM defines a flexible schema mechanism and REST API for managing identity data. The goal is to reduce the complexity of user management operations by providing patterns for exchanging schemas using HTTP.
In this implementation it is easy to add custom schemas and extensions with the provided structures. Incoming resources will be validated by their corresponding schemas before being passed on to their callbacks.
The following features are supported:
- GET for
/Schemas
,/ServiceProviderConfig
and/ResourceTypes
- CRUD (POST/GET/PUT/DELETE and PATCH) for your own resource types (i.e.
/Users
,/Groups
,/Employees
, ...)
Other optional features such as sorting, bulk, etc. are not supported in this version.
Installation
Assuming you already have a (recent) version of Go installed, you can get the code with go get:
go get github.com/elimity-com/scim
Usage
! errors are ignored for simplicity.
1. Create a service provider configuration.
config := scim.ServiceProviderConfig{
DocumentationURI: optional.NewString("www.example.com/scim"),
}
! no additional features/operations are supported in this version.
2. Create all supported schemas and extensions.
RFC Schema | User Schema | Group Schema | Extension Schema
schema := schema.Schema{
ID: "urn:ietf:params:scim:schemas:core:2.0:User",
Name: optional.NewString("User"),
Description: optional.NewString("User Account"),
Attributes: []schema.CoreAttribute{
schema.SimpleCoreAttribute(schema.SimpleStringParams(schema.StringParams{
Name: "userName",
Required: true,
Uniqueness: schema.AttributeUniquenessServer(),
})),
},
}
extension := schema.Schema{
ID: "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
Name: optional.NewString("EnterpriseUser"),
Description: optional.NewString("Enterprise User"),
Attributes: []schema.CoreAttribute{
schema.SimpleCoreAttribute(schema.SimpleStringParams(schema.StringParams{
Name: "employeeNumber",
})),
schema.SimpleCoreAttribute(schema.SimpleStringParams(schema.StringParams{
Name: "organization",
})),
},
}
3. Create all resource types and their callbacks.
RFC Resource Type | Example Resource Type
ResourceHandler
)
3.1 Callback (implementation of
var userResourceHandler scim.ResourceHandler
// initialize w/ own implementation
! each resource type should have its own resource handler.
3.2 Resource Type
resourceTypes := []ResourceType{
{
ID: optional.NewString("User"),
Name: "User",
Endpoint: "/Users",
Description: optional.NewString("User Account"),
Schema: schema,
SchemaExtensions: []SchemaExtension{
{Schema: extension},
},
Handler: userResourceHandler,
},
},
4. Create Server
server := Server{
Config: config,
ResourceTypes: resourceTypes,
}
5. Listen and Serve
log.Fatal(http.ListenAndServe(":8080", server))
Contributing
We are happy to review pull requests, but please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
If you would like to propose a change please ensure the following:
- all checks of CircleCI are passing (GolangCI-Lint:
goimports
andgolint
) - all already existing tests are passing
- you have written tests that cover the code you are making
- there is documentation for at least all public functions you have added
- new public functions and structures are kept to a minimum
- the same practices are applied (such as the anatomy of methods, names, etc.)
- your changes are compliant with SCIM v2.0 (released as RFC7642, RFC7643 and RFC7644 under IETF)