https://github.com/ionos-cloud/sdk-go-auth
IONOS Cloud SDK Go Auth
https://github.com/ionos-cloud/sdk-go-auth
Last synced: 2 months ago
JSON representation
IONOS Cloud SDK Go Auth
- Host: GitHub
- URL: https://github.com/ionos-cloud/sdk-go-auth
- Owner: ionos-cloud
- License: apache-2.0
- Created: 2021-11-15T12:17:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T12:34:37.000Z (6 months ago)
- Last Synced: 2024-12-26T08:27:31.703Z (4 months ago)
- Homepage:
- Size: 139 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go API client for ionoscloud
Use the Auth API to manage tokens for secure access to IONOS Cloud APIs (Auth API, Cloud API, Reseller API, Activity Log API, and others).
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: 1.0
- Package version: 1.0.10
- Build package: org.openapitools.codegen.languages.GoClientCodegen
## Installation
Install the following dependencies:
```shell
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:
```golang
import ionoscloud "github.com/ionos-cloud/sdk-go-auth"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
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`.
```golang
ctx := context.WithValue(context.Background(), ionoscloud.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`.
```golang
ctx := context.WithValue(context.Background(), ionoscloud.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
## Documentation for API Endpoints
All URIs are relative to *https://api.ionos.com/auth/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*TokensApi* | [**TokensDeleteByCriteria**](docs/api/TokensApi.md#tokensdeletebycriteria) | **Delete** /tokens | Delete tokens by criteria
*TokensApi* | [**TokensDeleteById**](docs/api/TokensApi.md#tokensdeletebyid) | **Delete** /tokens/{tokenId} | Delete tokens
*TokensApi* | [**TokensFindById**](docs/api/TokensApi.md#tokensfindbyid) | **Get** /tokens/{tokenId} | Get tokens by Key ID
*TokensApi* | [**TokensGenerate**](docs/api/TokensApi.md#tokensgenerate) | **Get** /tokens/generate | Create new tokens
*TokensApi* | [**TokensGet**](docs/api/TokensApi.md#tokensget) | **Get** /tokens | List all tokens
## Documentation For Models
- [DeleteResponse](docs/models/DeleteResponse.md)
- [Error](docs/models/Error.md)
- [ErrorMessages](docs/models/ErrorMessages.md)
- [Jwt](docs/models/Jwt.md)
- [Token](docs/models/Token.md)
- [Tokens](docs/models/Tokens.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### BasicAuthentication
- **Type**: HTTP basic authentication
Example
```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```
### TokenAuthentication
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
Note, each API key must be added to a map of `map[string]APIKey` where the key is: Authorization and passed in as the auth context for each request.
Example
```golang
auth := context.WithValue(
context.Background(),
sw.ContextAPIKeys,
map[string]sw.APIKey{
"Authorization": {Key: "API_KEY_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