Categorygithub.com/grokify/go-saviyntecf
modulepackage
0.1.9
Repository: https://github.com/grokify/go-saviyntecf.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
6
Dependents
1
Files
1k SLOC

# README

Saviynt External Connector Framework (ECF) in Go

Build Status Go Report Card Docs License

This is the Saviynt External Connector Framework (ECF) implemented in Go with Chi.

It is built with oapi-codegen.

Usage

To use go-saviyntecf to create a connector, see go-saviyntecf-tutorial.

To implement a connector, implement the functions listed here in ServerInterface.

Rebuild

To rebuild this module using an updated OpenAPI spec, do the following:

git clone https://github.com/grokify/go-saviyntecf
cd go-saviyntecf
curl -XGET https://raw.githubusercontent.com/saviynt/ExternalConnectorFramework-APISpec/main/spec/OpenAPISpec.yaml > openapi.yaml
go generate

This will create a new server.gen.go file using the config at oapi-codegen.yaml.

For more information on oapi-codegen, see the following:

  1. https://www.jvt.me/posts/2022/07/12/go-openapi-server/

# Functions

Handler creates http.Handler with routing matching OpenAPI spec.
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
No description provided by the author
HandlerWithOptions creates http.Handler with additional options.

# Constants

No description provided by the author

# Structs

Account defines model for account.
Accounts defines model for accounts.
No description provided by the author
Createaccount defines model for createaccount.
Group defines model for group.
Groups defines model for groups.
Groupsmembership defines model for groupsmembership.
No description provided by the author
PostAccountsJSONBody defines parameters for PostAccounts.
PostAccountsParams defines parameters for PostAccounts.
PostEntitlementsGroupsJSONBody defines parameters for PostEntitlementsGroups.
PostEntitlementsGroupsParams defines parameters for PostEntitlementsGroups.
PostEntitlementsRolesJSONBody defines parameters for PostEntitlementsRoles.
PostEntitlementsRolesParams defines parameters for PostEntitlementsRoles.
PostUsersJSONBody defines parameters for PostUsers.
PostUsersParams defines parameters for PostUsers.
PutChangePasswordJSONBody defines parameters for PutChangePassword.
PutEntitlementGroupRemoveAccessJSONBody defines parameters for PutEntitlementGroupRemoveAccess.
PutEntitlementgroupsJSONBody defines parameters for PutEntitlementgroups.
PutEntitlementRoleAddAccessJSONBody defines parameters for PutEntitlementRoleAddAccess.
PutEntitlementRoleRemoveAccessJSONBody defines parameters for PutEntitlementRoleRemoveAccess.
No description provided by the author
No description provided by the author
Role defines model for role.
Roles defines model for roles.
Rolesmembership defines model for rolesmembership.
ServerInterfaceWrapper converts contexts to parameters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Updateuser defines model for updateuser.
Users defines model for users.

# Interfaces

ServerInterface represents all server handlers.

# Type aliases

Childgroups defines model for childgroups.
Childroles defines model for childroles.
No description provided by the author
PatchUpdateAccountJSONBody defines parameters for PatchUpdateAccount.
PatchUpdateAccountJSONRequestBody defines body for PatchUpdateAccount for application/json ContentType.
PatchUpdateUserJSONRequestBody defines body for PatchUpdateUser for application/json ContentType.
PostAccountsJSONRequestBody defines body for PostAccounts for application/json ContentType.
PostCreateAccountJSONRequestBody defines body for PostCreateAccount for application/json ContentType.
PostEntitlementsGroupsJSONRequestBody defines body for PostEntitlementsGroups for application/json ContentType.
PostEntitlementsRolesJSONRequestBody defines body for PostEntitlementsRoles for application/json ContentType.
PostUsersJSONRequestBody defines body for PostUsers for application/json ContentType.
PutChangePasswordJSONRequestBody defines body for PutChangePassword for application/json ContentType.
PutEntitlementGroupRemoveAccessJSONRequestBody defines body for PutEntitlementGroupRemoveAccess for application/json ContentType.
PutEntitlementgroupsJSONRequestBody defines body for PutEntitlementgroups for application/json ContentType.
PutEntitlementRoleAddAccessJSONRequestBody defines body for PutEntitlementRoleAddAccess for application/json ContentType.
PutEntitlementRoleRemoveAccessJSONRequestBody defines body for PutEntitlementRoleRemoveAccess for application/json ContentType.
User defines model for user.