https://github.com/grokify/go-scim-client
SCIM 2.0 API client auto-generated using RingCentral SCIM OpenAPI / Swagger 2.0 specification.
https://github.com/grokify/go-scim-client
Last synced: about 2 months ago
JSON representation
SCIM 2.0 API client auto-generated using RingCentral SCIM OpenAPI / Swagger 2.0 specification.
- Host: GitHub
- URL: https://github.com/grokify/go-scim-client
- Owner: grokify
- License: mit
- Created: 2018-01-16T09:09:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T20:37:54.000Z (3 months ago)
- Last Synced: 2025-04-30T22:09:42.030Z (about 2 months ago)
- Language: Go
- Homepage:
- Size: 335 KB
- Stars: 18
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/Supported.md
Awesome Lists containing this project
README
# Go API client for SCIM
[![Build Status][build-status-svg]][build-status-url]
[![Go Report Card][goreport-svg]][goreport-url]
[![Docs][docs-godoc-svg]][docs-godoc-url]
[![License][license-svg]][license-url]
SCIM V2 API implemented by RingCentral
## Overview
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
- API version: 0.1.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.GoClientCodegen
## Installation
```
$ go get github.com/grokify/go-scim-client
```
The package name is: `scim`
## Documentation for API Endpoints
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ServiceProviderConfigApi* | [**GetServiceProviderConfig**](docs/ServiceProviderConfigApi.md#getserviceproviderconfig) | **Get** /ServiceProviderConfig | get service provider config
*UserApi* | [**CreateUser**](docs/UserApi.md#createuser) | **Post** /Users | create a user
*UserApi* | [**DeleteUser**](docs/UserApi.md#deleteuser) | **Delete** /Users/{id} | delete a user
*UserApi* | [**GetUserById**](docs/UserApi.md#getuserbyid) | **Get** /Users/{id} | get a user by id
*UserApi* | [**PatchUser**](docs/UserApi.md#patchuser) | **Patch** /Users/{id} | partially update/patch a user
*UserApi* | [**ReplaceUser**](docs/UserApi.md#replaceuser) | **Put** /Users/{id} | fully update/replace a user
*UserApi* | [**SearchViaGet**](docs/UserApi.md#searchviaget) | **Get** /Users | search or list users
*UserApi* | [**SearchViaPost**](docs/UserApi.md#searchviapost) | **Post** /Users/.search | search or list users
## Documentation For Models
- [Address](docs/Address.md)
- [AuthenticationScheme](docs/AuthenticationScheme.md)
- [AuthenticationSchemes](docs/AuthenticationSchemes.md)
- [BulkSupported](docs/BulkSupported.md)
- [Email](docs/Email.md)
- [EnterpriseUser](docs/EnterpriseUser.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [FilterSupported](docs/FilterSupported.md)
- [Meta](docs/Meta.md)
- [Name](docs/Name.md)
- [PatchOperation](docs/PatchOperation.md)
- [PhoneNumber](docs/PhoneNumber.md)
- [Photo](docs/Photo.md)
- [SearchRequest](docs/SearchRequest.md)
- [ServiceProviderConfig](docs/ServiceProviderConfig.md)
- [Supported](docs/Supported.md)
- [User](docs/User.md)
- [UserPatch](docs/UserPatch.md)
- [UserSearchResponse](docs/UserSearchResponse.md)
- [UserResponse](docs/UserResponse.md)
## Documentation For Authorization
## OAuth2
- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**:
- **Scopes**: N/A
Example
```
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
```
import "golang.org/x/oauth2"
/ .. Perform OAuth2 round trip request and obtain a token .. //
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```
[used-by-svg]: https://sourcegraph.com/github.com/grokify/go-scim-client/-/badge.svg
[used-by-url]: https://sourcegraph.com/github.com/grokify/go-scim-client?badge
[build-status-svg]: https://github.com/grokify/go-scim-client/actions/workflows/ci.yaml/badge.svg?branch=master
[build-status-url]: https://github.com/grokify/go-scim-client/actions/workflows/ci.yaml
[goreport-svg]: https://goreportcard.com/badge/github.com/grokify/go-scim-client
[goreport-url]: https://goreportcard.com/report/github.com/grokify/go-scim-client
[docs-godoc-svg]: https://pkg.go.dev/badge/github.com/grokify/go-scim-client
[docs-godoc-url]: https://pkg.go.dev/github.com/grokify/go-scim-client
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/grokify/go-scim-client/blob/master/LICENSE.md