# README

Go API client for delegatedadministration

Deglated Administration

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
  • Package version: 1.0.0
  • Generator version: 7.10.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/net/context

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

import delegatedadministration "github.com/GIT_USER_ID/GIT_REPO_ID"

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 delegatedadministration.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), delegatedadministration.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 identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using delegatedadministration.ContextOperationServerIndices and delegatedadministration.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

ClassMethodHTTP requestDescription
DelegatedAdministrationAPICreateDelegatePost /ECM/api/v5/createDelegateCreate Delegate
DelegatedAdministrationAPIDeleteDelegatePost /ECM/api/v5/deleteDelegateDelete Delegate
DelegatedAdministrationAPIEditDelegatePost /ECM/api/v5/editDelegateEdit Delegate
DelegatedAdministrationAPIFetchDelegatesListPost /ECM/api/v5/fetchDelegatesListFetch Existing Delegates List
DelegatedAdministrationAPIGetDelegateUserListGet /ECM/api/v5/getDelegateUserListGet Delegate User List

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), delegatedadministration.ContextAccessToken, "BEARER_TOKEN_STRING")
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

Author

https://github.com/saviynt

# Packages

No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewCreateDelegateRequest instantiates a new CreateDelegateRequest 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.
NewCreateDelegateRequestWithDefaults instantiates a new CreateDelegateRequest 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.
NewCreateDelegateResponse instantiates a new CreateDelegateResponse 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.
NewCreateDelegateResponseWithDefaults instantiates a new CreateDelegateResponse 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.
NewDelegate instantiates a new Delegate 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.
NewDelegateUser instantiates a new DelegateUser 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.
NewDelegateUserWithDefaults instantiates a new DelegateUser 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.
NewDelegateWithDefaults instantiates a new Delegate 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.
NewEditDelegateRequest instantiates a new EditDelegateRequest 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.
NewEditDelegateRequestWithDefaults instantiates a new EditDelegateRequest 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.
NewFetchDelegatesListRequest instantiates a new FetchDelegatesListRequest 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.
NewFetchDelegatesListRequestWithDefaults instantiates a new FetchDelegatesListRequest 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.
NewFetchDelegatesListResponse instantiates a new FetchDelegatesListResponse 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.
NewFetchDelegatesListResponseWithDefaults instantiates a new FetchDelegatesListResponse 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.
NewGetDelegateUserListRequest instantiates a new GetDelegateUserListRequest 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.
NewGetDelegateUserListRequestWithDefaults instantiates a new GetDelegateUserListRequest 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.
NewGetDelegateUserListResponse instantiates a new GetDelegateUserListResponse 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.
NewGetDelegateUserListResponseWithDefaults instantiates a new GetDelegateUserListResponse 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.
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
NewResponse instantiates a new Response 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.
NewResponseWithDefaults instantiates a new Response 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.

# Variables

ContextAccessToken takes a string oauth2 access token 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.
No description provided by the author
No description provided by the author

# Structs

APIClient manages communication with the Saviynt Delegated Administration API API v1.0 In most cases there should be only one, shared, APIClient.
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
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
CreateDelegateRequest struct for CreateDelegateRequest.
CreateDelegateResponse struct for CreateDelegateResponse.
Delegate Delegate represents a Deleate returne dfrom the Fetch Eisting Delegates List API.
DelegateUser struct for DelegateUser.
EditDelegateRequest .
FetchDelegatesListRequest struct for FetchDelegatesListRequest.
FetchDelegatesListResponse struct for FetchDelegatesListResponse.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetDelegateUserListRequest struct for GetDelegateUserListRequest.
GetDelegateUserListResponse struct for GetDelegateUserListResponse.
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
Response struct for Response.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.

# Interfaces

No description provided by the author

# Type aliases

DelegatedAdministrationAPIService DelegatedAdministrationAPI service.
ServerConfigurations stores multiple ServerConfiguration items.