Categorygithub.com/grokify/go-scim-client
modulepackage
0.1.26
Repository: https://github.com/grokify/go-scim-client.git
Documentation: pkg.go.dev

# README

Go API client for SCIM

Build Status Go Report Card Docs License

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

ClassMethodHTTP requestDescription
ServiceProviderConfigApiGetServiceProviderConfigGet /ServiceProviderConfigget service provider config
UserApiCreateUserPost /Userscreate a user
UserApiDeleteUserDelete /Users/{id}delete a user
UserApiGetUserByIdGet /Users/{id}get a user by id
UserApiPatchUserPatch /Users/{id}partially update/patch a user
UserApiReplaceUserPut /Users/{id}fully update/replace a user
UserApiSearchViaGetGet /Userssearch or list users
UserApiSearchViaPostPost /Users/.searchsearch or list users

Documentation For Models

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