modulepackage
0.1.26
Repository: https://github.com/grokify/go-scim-client.git
Documentation: pkg.go.dev
# README
Go API client for SCIM
SCIM V2 API implemented by RingCentral
Overview
This API client was generated by the swagger-codegen project. By using the 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 | Get /ServiceProviderConfig | get service provider config |
UserApi | CreateUser | Post /Users | create a user |
UserApi | DeleteUser | Delete /Users/{id} | delete a user |
UserApi | GetUserById | Get /Users/{id} | get a user by id |
UserApi | PatchUser | Patch /Users/{id} | partially update/patch a user |
UserApi | ReplaceUser | Put /Users/{id} | fully update/replace a user |
UserApi | SearchViaGet | Get /Users | search or list users |
UserApi | SearchViaPost | Post /Users/.search | search or list users |
Documentation For Models
- Address
- AuthenticationScheme
- AuthenticationSchemes
- BulkSupported
- EnterpriseUser
- ErrorResponse
- FilterSupported
- Meta
- Name
- PatchOperation
- PhoneNumber
- Photo
- SearchRequest
- ServiceProviderConfig
- Supported
- User
- UserPatch
- UserSearchResponse
- UserResponse
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)
# Packages
No description provided by the author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
# Structs
No description provided by the author
APIClient manages communication with the SCIM API API v0.1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
resource metadata.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author