Categorygithub.com/netsoc/iam/client
modulepackage
1.0.11
Repository: https://github.com/netsoc/iam.git
Documentation: pkg.go.dev

# README

Go API client for iam

API for managing and authenticating Netsoc users.

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.11
  • 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
go get github.com/antihax/optional

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

import "./iam"

Documentation for API Endpoints

All URIs are relative to https://iam.netsoc.ie/v1

ClassMethodHTTP requestDescription
UsersApiCreateUserPost /usersCreate a new user
UsersApiDeleteUserDelete /users/{username}Delete a user by their username
UsersApiGetUserGet /users/{username}Get a user by their username
UsersApiGetUserByIDGet /users/id:{uid}Get a user by their ID
UsersApiGetUsersGet /usersList users
UsersApiIssueTokenPost /users/{username}/tokenIssue a token
UsersApiLoginPost /users/{username}/loginLog into a user account (obtain JWT)
UsersApiLogoutDelete /users/{username}/loginLog out of a user account (invalidate existing JWT's)
UsersApiResetPasswordPut /users/{username}/loginReset password
UsersApiUpdateUserPatch /users/{username}Update a user by their username
UsersApiValidateTokenGet /users/self/tokenValidate a token
UsersApiVerifyPatch /users/{username}/loginVerify email address

Documentation For Models

Documentation For Authorization

jwt

  • 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)

jwt_admin

  • 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)

jwt_reset

  • 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)

jwt_verify

  • 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)

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the Netsoc IAM API v1.0.11 In most cases there should be only one, shared, APIClient.
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.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
IssueTokenRequest struct for IssueTokenRequest.
LoginRequest struct for LoginRequest.
ResetPasswordOpts Optional parameters for the method 'ResetPassword'.
ResetPasswordRequest struct for ResetPasswordRequest.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
TokenResponse struct for TokenResponse.
User struct for User.
UserMeta Metadata about the user, not modifiable.

# Type aliases

UsersApiService UsersApi service.