package
4.3.0+incompatible
Repository: https://github.com/nextlinux/enterprise-client-go.git
Documentation: pkg.go.dev

# README

Go API client for rbac

Enterprise API for managing roles, permissions, and user mappings

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.0
  • Package version: 4.6.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./rbac"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
DefaultApiAddIdpPost /saml/idps
DefaultApiAddRoleUserPost /roles/{rolename}/membersAdd a user to the role
DefaultApiDeleteIdpDelete /saml/idps/{name}
DefaultApiDeleteRoleUserDelete /roles/{rolename}/membersRemove a user from the role
DefaultApiGetIdpGet /saml/idps/{name}
DefaultApiGetRoleGet /roles/{rolename}Get detailed information about a specific role
DefaultApiGetStatusGet /statusService status
DefaultApiHealthCheckGet /health
DefaultApiListIdpsGet /saml/idps
DefaultApiListRoleMembersGet /roles/{rolename}/membersReturns a list of objects that have members in the role. The list is filtered by 'listRoleMembers' access for the 'account' element of each entry.
DefaultApiListRolesGet /rolesList roles available in the system
DefaultApiListUserRolesGet /users/{username}/rolesList the roles for which the requested user is a member
DefaultApiMyRolesGet /my_rolesList the roles for which the authenticated user is a member
DefaultApiSamlLoginGet /saml/login/{idp_name}
DefaultApiSamlSsoPost /saml/sso/{idp_name}
DefaultApiUpdateIdpPut /saml/idps/{name}
DefaultApiVersionCheckGet /version

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
No description provided by the author
NewAccountRole instantiates a new AccountRole object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountRoleWithDefaults instantiates a new AccountRole object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIClient creates a new API client.
NewApiErrorResponse instantiates a new ApiErrorResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewApiErrorResponseWithDefaults instantiates a new ApiErrorResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
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
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
No description provided by the author
NewPermission instantiates a new Permission object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionWithDefaults instantiates a new Permission object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRole instantiates a new Role object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRoleMember instantiates a new RoleMember object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRoleMembership instantiates a new RoleMembership object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRoleMembershipWithDefaults instantiates a new RoleMembership object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRoleMemberWithDefaults instantiates a new RoleMember object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRoleSummary instantiates a new RoleSummary object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRoleSummaryWithDefaults instantiates a new RoleSummary object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRoleWithDefaults instantiates a new Role object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSamlConfiguration instantiates a new SamlConfiguration object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSamlConfigurationWithDefaults instantiates a new SamlConfiguration object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewServiceVersion instantiates a new ServiceVersion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewServiceVersionApi instantiates a new ServiceVersionApi object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewServiceVersionApiWithDefaults instantiates a new ServiceVersionApi object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewServiceVersionDb instantiates a new ServiceVersionDb object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewServiceVersionDbWithDefaults instantiates a new ServiceVersionDb object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewServiceVersionEngine instantiates a new ServiceVersionEngine object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewServiceVersionEngineWithDefaults instantiates a new ServiceVersionEngine object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewServiceVersionService instantiates a new ServiceVersionService object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewServiceVersionServiceWithDefaults instantiates a new ServiceVersionService object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewServiceVersionWithDefaults instantiates a new ServiceVersion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStatusResponse instantiates a new StatusResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStatusResponseWithDefaults instantiates a new StatusResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTokenResponse instantiates a new TokenResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTokenResponseWithDefaults instantiates a new TokenResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Constants

No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

AccountRole An account identifier and roles a user has within that account.
No description provided by the author
No description provided by the author
APIClient manages communication with the Nextlinux Enterprise RBAC API API v0.1.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
ApiErrorResponse Generic HTTP API error response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
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.
Configuration stores the configuration of the API client.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
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
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
No description provided by the author
Permission A grant of specific action against a specific scope and target.
Role Role definition.
RoleMember A mapping between a username and a role with an account context.
RoleMembership Membership for a role in an account.
RoleSummary struct for RoleSummary.
SamlConfiguration A named configuration for interaction with an Identity Provider that supports SAML 2.0.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ServiceVersion Version information for a service.
ServiceVersionApi Api Version string.
ServiceVersionDb struct for ServiceVersionDb.
ServiceVersionEngine struct for ServiceVersionEngine.
ServiceVersionService struct for ServiceVersionService.
StatusResponse System status response.
TokenResponse An auth token for use in future requests as an Authorization header value of type 'bearer'.

# Interfaces

No description provided by the author

# Type aliases

DefaultApiService DefaultApi service.
ServerConfigurations stores multiple ServerConfiguration items.