# README

Go API client for rbac

The API for Role Based Access Control.

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: 1.0.0
Package version: 1.0.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/api/rbac/v1

Class	Method	HTTP request	Description
AccessApi	GetPrincipalAccess	Get /access/	Get the permitted access for a principal in the tenant (defaults to principal from the identity header)
CrossAccountRequestApi	CreateCrossAccountRequests	Post /cross-account-requests/	Create a cross account request
CrossAccountRequestApi	GetCrossAccountRequest	Get /cross-account-requests/{uuid}/	Get a cross account request
CrossAccountRequestApi	ListCrossAccountRequests	Get /cross-account-requests/	List the cross account requests for a user or account
CrossAccountRequestApi	PatchCrossAccountRequest	Patch /cross-account-requests/{uuid}/	Update a cross account request
CrossAccountRequestApi	PutCrossAccountRequest	Put /cross-account-requests/{uuid}/	Update a cross account request
GroupApi	AddPrincipalToGroup	Post /groups/{uuid}/principals/	Add a principal to a group in the tenant
GroupApi	AddRoleToGroup	Post /groups/{uuid}/roles/	Add a role to a group in the tenant
GroupApi	CreateGroup	Post /groups/	Create a group in a tenant
GroupApi	DeleteGroup	Delete /groups/{uuid}/	Delete a group in the tenant
GroupApi	DeletePrincipalFromGroup	Delete /groups/{uuid}/principals/	Remove a principal from a group in the tenant
GroupApi	DeleteRoleFromGroup	Delete /groups/{uuid}/roles/	Remove a role from a group in the tenant
GroupApi	GetGroup	Get /groups/{uuid}/	Get a group in the tenant
GroupApi	GetPrincipalsFromGroup	Get /groups/{uuid}/principals/	Get a list of principals from a group in the tenant
GroupApi	ListGroups	Get /groups/	List the groups for a tenant
GroupApi	ListRolesForGroup	Get /groups/{uuid}/roles/	List the roles for a group in the tenant
GroupApi	UpdateGroup	Put /groups/{uuid}/	Udate a group in the tenant
PermissionApi	ListPermissionOptions	Get /permissions/options/	List the available options for fields of permissions for a tenant
PermissionApi	ListPermissions	Get /permissions/	List the permissions for a tenant
PolicyApi	CreatePolicies	Post /policies/	Create a policy in a tenant
PolicyApi	DeletePolicy	Delete /policies/{uuid}/	Delete a policy in the tenant
PolicyApi	GetPolicy	Get /policies/{uuid}/	Get a policy in the tenant
PolicyApi	ListPolicies	Get /policies/	List the policies in the tenant
PolicyApi	UpdatePolicy	Put /policies/{uuid}/	Update a policy in the tenant
PrincipalApi	ListPrincipals	Get /principals/	List the principals for a tenant
RoleApi	CreateRoles	Post /roles/	Create a roles for a tenant
RoleApi	DeleteRole	Delete /roles/{uuid}/	Delete a role in the tenant
RoleApi	GetRole	Get /roles/{uuid}/	Get a role in the tenant
RoleApi	GetRoleAccess	Get /roles/{uuid}/access/	Get access for a role in the tenant
RoleApi	ListRoles	Get /roles/	List the roles for a tenant
RoleApi	PatchRole	Patch /roles/{uuid}/	Patch a Role in the tenant
RoleApi	UpdateRole	Put /roles/{uuid}/	Update a Role in the tenant
StatusApi	GetStatus	Get /status/	Obtain server status

Documentation For Models

Documentation For Authorization

basic_auth

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

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