client

package
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 20, 2020 License: Apache-2.0 Imports: 25 Imported by: 2

README

Go API client for client

Handles all identities for tracking the users of the Moov platform.

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.0.1
  • 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 "./client"

Documentation for API Endpoints

All URIs are relative to https://local.moov.io

Class Method HTTP request Description
AuthenticationApi Authenticated Post /authentication/authenticated Complete a login via a OIDC. Once the OIDC client service has authenticated their identity the client service redirect to this endpoint.
AuthenticationApi Register Get /authentication/register Returns the partially completed registration details that were pulled by AuthN service.
AuthenticationApi RegisterWithCredentials Post /authentication/register Called when the user is registering for the first time. It requires that they have authenticated with a supported OIDC provider and recieved a valid invite code.
CredentialsApi DisableCredentials Delete /identities/{identityID}/credentials/{credentialID} Disables a credential so it can't be used anymore to login
CredentialsApi ListCredentials Get /identities/{identityID}/credentials List the credentials this user has used.
IdentitiesApi DisableIdentity Delete /identities/{identityID} Disable an identity. Its left around for historical reporting
IdentitiesApi GetIdentity Get /identities/{identityID} List identities and associates userId
IdentitiesApi ListIdentities Get /identities List identities and associates userId
IdentitiesApi UpdateIdentity Put /identities/{identityID} Update a specific Identity
InvitesApi DisableInvite Delete /invites/{inviteID} Delete an invite that was sent and invalidate the token.
InvitesApi ListInvites Get /invites List outstanding invites
InvitesApi SendInvite Post /invites Send an email invite to a new user

Documentation For Models

Documentation For Authorization

GatewayAuth

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

LoginAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    Key: "APIKEY",
    Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AuthenticationApi *AuthenticationApiService

	CredentialsApi *CredentialsApiService

	IdentitiesApi *IdentitiesApiService

	InvitesApi *InvitesApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Moov Identity API API v0.0.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type Address 

type Address struct {
	// UUID v4
	IdentityID string `json:"identityID,omitempty"`
	// UUID v4
	AddressID  string  `json:"addressID,omitempty"`
	Type       string  `json:"type,omitempty"`
	Address1   string  `json:"address1,omitempty"`
	Address2   *string `json:"address2,omitempty"`
	City       string  `json:"city,omitempty"`
	State      string  `json:"state,omitempty"`
	PostalCode string  `json:"postalCode,omitempty"`
	Country    string  `json:"country,omitempty"`
	Validated  bool    `json:"validated,omitempty"`
}

Address Address of the Identity

type AuthenticationApiService added in v0.2.0 

type AuthenticationApiService service

AuthenticationApiService AuthenticationApi service

func (*AuthenticationApiService) Authenticated added in v0.2.0 

func (a *AuthenticationApiService) Authenticated(ctx _context.Context) (LoggedIn, *_nethttp.Response, error)

Authenticated Complete a login via a OIDC. Once the OIDC client service has authenticated their identity the client service redirect to this endpoint.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LoggedIn

func (*AuthenticationApiService) Register added in v0.2.0 

func (a *AuthenticationApiService) Register(ctx _context.Context) (Register, *_nethttp.Response, error)

Register Returns the partially completed registration details that were pulled by AuthN service.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Register

func (*AuthenticationApiService) RegisterWithCredentials added in v0.2.0 

func (a *AuthenticationApiService) RegisterWithCredentials(ctx _context.Context, register Register) (LoggedIn, *_nethttp.Response, error)

RegisterWithCredentials Called when the user is registering for the first time. It requires that they have authenticated with a supported OIDC provider and recieved a valid invite code.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param register Arguments needed register a user with OIDC credentials.

@return LoggedIn

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type Credential 

type Credential struct {
	// UUID v4
	CredentialID string `json:"credentialID,omitempty"`
	// UUID v4
	IdentityID string `json:"identityID,omitempty"`
	// UUID v4
	TenantID   string     `json:"tenantID,omitempty"`
	CreatedOn  time.Time  `json:"createdOn,omitempty"`
	LastUsedOn time.Time  `json:"lastUsedOn,omitempty"`
	DisabledOn *time.Time `json:"disabledOn,omitempty"`
	// UUID v4
	DisabledBy *string `json:"disabledBy,omitempty"`
}

Credential Description of a successful OpenID connect credential

type CredentialsApiService 

type CredentialsApiService service

CredentialsApiService CredentialsApi service

func (*CredentialsApiService) DisableCredentials 

func (a *CredentialsApiService) DisableCredentials(ctx _context.Context, identityID string, credentialID string) (*_nethttp.Response, error)

DisableCredentials Disables a credential so it can't be used anymore to login

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param identityID ID of the Identity for the credential
  • @param credentialID ID of the credential to disable

func (*CredentialsApiService) ListCredentials 

func (a *CredentialsApiService) ListCredentials(ctx _context.Context, identityID string) ([]Credential, *_nethttp.Response, error)

ListCredentials List the credentials this user has used.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param identityID ID of the Identity to lookup

@return []Credential

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type IdentitiesApiService 

type IdentitiesApiService service

IdentitiesApiService IdentitiesApi service

func (*IdentitiesApiService) DisableIdentity 

func (a *IdentitiesApiService) DisableIdentity(ctx _context.Context, identityID string) (*_nethttp.Response, error)

DisableIdentity Disable an identity. Its left around for historical reporting

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param identityID ID of the Identity to lookup

func (*IdentitiesApiService) GetIdentity 

func (a *IdentitiesApiService) GetIdentity(ctx _context.Context, identityID string) (Identity, *_nethttp.Response, error)

GetIdentity List identities and associates userId

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param identityID ID of the Identity to lookup

@return Identity

func (*IdentitiesApiService) ListIdentities 

func (a *IdentitiesApiService) ListIdentities(ctx _context.Context, localVarOptionals *ListIdentitiesOpts) ([]Identity, *_nethttp.Response, error)

ListIdentities List identities and associates userId

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ListIdentitiesOpts - Optional Parameters:
  • @param "OrgID" (optional.Interface of string) - Filter in only for specific Organization

@return []Identity

func (*IdentitiesApiService) UpdateIdentity 

func (a *IdentitiesApiService) UpdateIdentity(ctx _context.Context, identityID string, updateIdentity UpdateIdentity) (Identity, *_nethttp.Response, error)

UpdateIdentity Update a specific Identity

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param identityID ID of the Identity to lookup
  • @param updateIdentity

@return Identity

type Identity 

type Identity struct {
	// UUID v4
	IdentityID string `json:"identityID,omitempty"`
	// UUID v4
	TenantID   string    `json:"tenantID,omitempty"`
	FirstName  string    `json:"firstName"`
	MiddleName string    `json:"middleName,omitempty"`
	LastName   string    `json:"lastName"`
	NickName   *string   `json:"nickName,omitempty"`
	Suffix     *string   `json:"suffix,omitempty"`
	BirthDate  time.Time `json:"birthDate,omitempty"`
	Status     string    `json:"status,omitempty"`
	// Email Address
	Email string `json:"email"`
	// The user has verified they have access to this email
	EmailVerified bool       `json:"emailVerified,omitempty"`
	Phones        []Phone    `json:"phones,omitempty"`
	Addresses     []Address  `json:"addresses,omitempty"`
	RegisteredOn  time.Time  `json:"registeredOn,omitempty"`
	LastLogin     LastLogin  `json:"lastLogin,omitempty"`
	DisabledOn    *time.Time `json:"disabledOn,omitempty"`
	// UUID v4
	DisabledBy    *string   `json:"disabledBy,omitempty"`
	LastUpdatedOn time.Time `json:"lastUpdatedOn,omitempty"`
	// UUID v4
	InviteID *string `json:"inviteID,omitempty"`
}

Identity Properties of an Identity. These users will under-go KYC checks thus all the information

type Invite 

type Invite struct {
	// UUID v4
	InviteID string `json:"inviteID,omitempty"`
	// UUID v4
	TenantID string `json:"tenantID,omitempty"`
	// Email Address
	Email string `json:"email,omitempty"`
	// UUID v4
	InvitedBy  string     `json:"invitedBy,omitempty"`
	InvitedOn  time.Time  `json:"invitedOn,omitempty"`
	RedeemedOn *time.Time `json:"redeemedOn,omitempty"`
	ExpiresOn  time.Time  `json:"expiresOn,omitempty"`
	DisabledOn *time.Time `json:"disabledOn,omitempty"`
	// UUID v4
	DisabledBy *string `json:"disabledBy,omitempty"`
}

Invite Describes an invite that was sent to a user to join.

type InvitesApiService 

type InvitesApiService service

InvitesApiService InvitesApi service

func (*InvitesApiService) DisableInvite 

func (a *InvitesApiService) DisableInvite(ctx _context.Context, inviteID string) (*_nethttp.Response, error)

DisableInvite Delete an invite that was sent and invalidate the token.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inviteID ID of the invite to delete

func (*InvitesApiService) ListInvites 

func (a *InvitesApiService) ListInvites(ctx _context.Context, localVarOptionals *ListInvitesOpts) ([]Invite, *_nethttp.Response, error)

ListInvites List outstanding invites

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ListInvitesOpts - Optional Parameters:
  • @param "OrgID" (optional.Interface of string) - Filter in only for specific Organization

@return []Invite

func (*InvitesApiService) SendInvite 

func (a *InvitesApiService) SendInvite(ctx _context.Context, sendInvite SendInvite) (Invite, *_nethttp.Response, error)

SendInvite Send an email invite to a new user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sendInvite

@return Invite

type LastLogin 

type LastLogin struct {
	// UUID v4
	CredentialId string    `json:"credentialId,omitempty"`
	On           time.Time `json:"on,omitempty"`
}

LastLogin Defines when and what credential was used for the last login

type ListIdentitiesOpts 

type ListIdentitiesOpts struct {
	OrgID optional.Interface
}

ListIdentitiesOpts Optional parameters for the method 'ListIdentities'

type ListInvitesOpts 

type ListInvitesOpts struct {
	OrgID optional.Interface
}

ListInvitesOpts Optional parameters for the method 'ListInvites'

type LoggedIn 

type LoggedIn struct {
	// JWT token that provides authentication of identity
	Jwt string `json:"jwt,omitempty"`
	// UUID v4
	CredentialID string `json:"credentialID,omitempty"`
	// UUID v4
	TenantID string `json:"tenantID,omitempty"`
	// UUID v4
	IdentityID string  `json:"identityID,omitempty"`
	FirstName  string  `json:"firstName,omitempty"`
	LastName   string  `json:"lastName,omitempty"`
	NickName   *string `json:"nickName,omitempty"`
}

LoggedIn User has logged in and is being given a token to proof identity

type Login 

type Login struct {
	// UUID v4
	CredentialID string `json:"credentialID,omitempty"`
	// UUID v4
	TenantID string `json:"tenantID,omitempty"`
}

Login User has authenticated with an OIDC now to verify the system can find them. This verifies theirs stored credentials for a user that match the arguments

type OfacSearch 

type OfacSearch struct {
	// SDN EntityID of the Entity
	EntityId string `json:"entityId,omitempty"`
	// Name of the SDN entity
	SdnName string `json:"sdnName,omitempty"`
	// SDN entity type
	SdnType string `json:"sdnType,omitempty"`
	// Percentage of similarity between the Customer name and this OFAC entity
	Match     float32   `json:"match,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

OfacSearch struct for OfacSearch

type Phone 

type Phone struct {
	// UUID v4
	IdentityID string `json:"identityID,omitempty"`
	// UUID v4
	PhoneID   string `json:"phoneID,omitempty"`
	Number    string `json:"number,omitempty"`
	Validated bool   `json:"validated,omitempty"`
	Type      string `json:"type,omitempty"`
}

Phone Phone number

type Register 

type Register struct {
	// UUID v4
	CredentialID string `json:"credentialID,omitempty"`
	// UUID v4
	TenantID   string    `json:"tenantID,omitempty"`
	InviteCode string    `json:"inviteCode,omitempty"`
	FirstName  string    `json:"firstName,omitempty"`
	MiddleName string    `json:"middleName,omitempty"`
	LastName   string    `json:"lastName,omitempty"`
	NickName   *string   `json:"nickName,omitempty"`
	Suffix     *string   `json:"suffix,omitempty"`
	BirthDate  time.Time `json:"birthDate,omitempty"`
	// Email Address
	Email     string            `json:"email,omitempty"`
	Phones    []RegisterPhone   `json:"phones,omitempty"`
	Addresses []RegisterAddress `json:"addresses,omitempty"`
}

Register Request to register a user in the system

func (Register) Validate added in v0.2.0 

func (a Register) Validate() error

type RegisterAddress 

type RegisterAddress struct {
	Type       string  `json:"type,omitempty"`
	Address1   string  `json:"address1,omitempty"`
	Address2   *string `json:"address2,omitempty"`
	City       string  `json:"city,omitempty"`
	State      string  `json:"state,omitempty"`
	PostalCode string  `json:"postalCode,omitempty"`
	Country    string  `json:"country,omitempty"`
}

RegisterAddress Address of the Identity

func (RegisterAddress) Validate added in v0.2.0 

func (a RegisterAddress) Validate() error

type RegisterAddressErrors added in v0.2.0 

type RegisterAddressErrors struct {
	// Descriptive reason for failing validation
	Type *string `json:"type,omitempty"`
	// Descriptive reason for failing validation
	Address1 *string `json:"address1,omitempty"`
	// Descriptive reason for failing validation
	Address2 *string `json:"address2,omitempty"`
	// Descriptive reason for failing validation
	City *string `json:"city,omitempty"`
	// Descriptive reason for failing validation
	State *string `json:"state,omitempty"`
	// Descriptive reason for failing validation
	PostalCode *string `json:"postalCode,omitempty"`
	// Descriptive reason for failing validation
	Country *string `json:"country,omitempty"`
}

RegisterAddressErrors Address of the Identity

type RegisterErrors added in v0.2.0 

type RegisterErrors struct {
	// Descriptive reason for failing validation
	FirstName *string `json:"firstName,omitempty"`
	// Descriptive reason for failing validation
	MiddleName *string `json:"middleName,omitempty"`
	// Descriptive reason for failing validation
	LastName *string `json:"lastName,omitempty"`
	// Descriptive reason for failing validation
	NickName *string `json:"nickName,omitempty"`
	// Descriptive reason for failing validation
	Suffix *string `json:"suffix,omitempty"`
	// Descriptive reason for failing validation
	BirthDate *string `json:"birthDate,omitempty"`
	// Descriptive reason for failing validation
	Email     *string                 `json:"email,omitempty"`
	Phones    []RegisterPhoneErrors   `json:"phones,omitempty"`
	Addresses []RegisterAddressErrors `json:"addresses,omitempty"`
}

RegisterErrors Request to register a user in the system

type RegisterPhone 

type RegisterPhone struct {
	Number string `json:"number,omitempty"`
	Type   string `json:"type,omitempty"`
}

RegisterPhone Phone number

func (RegisterPhone) Validate added in v0.2.0 

func (a RegisterPhone) Validate() error

type RegisterPhoneErrors added in v0.2.0 

type RegisterPhoneErrors struct {
	// Descriptive reason for failing validation
	Number *string `json:"number,omitempty"`
	// Descriptive reason for failing validation
	Type *string `json:"type,omitempty"`
}

RegisterPhoneErrors Phone number

type SendInvite 

type SendInvite struct {
	// Email Address
	Email string `json:"email,omitempty"`
}

SendInvite Describes an invite that was sent to a user to join.

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type UpdateAddress 

type UpdateAddress struct {
	// UUID v4
	AddressID  string  `json:"addressID,omitempty"`
	Type       string  `json:"type,omitempty"`
	Address1   string  `json:"address1,omitempty"`
	Address2   *string `json:"address2,omitempty"`
	City       string  `json:"city,omitempty"`
	PostalCode string  `json:"postalCode,omitempty"`
	State      string  `json:"state,omitempty"`
	Country    string  `json:"country,omitempty"`
	Validated  bool    `json:"validated,omitempty"`
}

UpdateAddress Address of the Identity

type UpdateIdentity 

type UpdateIdentity struct {
	FirstName  string          `json:"firstName"`
	MiddleName string          `json:"middleName,omitempty"`
	LastName   string          `json:"lastName"`
	NickName   *string         `json:"nickName,omitempty"`
	Suffix     *string         `json:"suffix,omitempty"`
	BirthDate  time.Time       `json:"birthDate,omitempty"`
	Status     string          `json:"status,omitempty"`
	Phones     []UpdatePhone   `json:"phones,omitempty"`
	Addresses  []UpdateAddress `json:"addresses,omitempty"`
}

UpdateIdentity Properties of an Identity. These users will under-go KYC checks thus all the information

type UpdatePhone 

type UpdatePhone struct {
	// UUID v4
	PhoneID   string `json:"phoneID,omitempty"`
	Number    string `json:"number,omitempty"`
	Validated bool   `json:"validated,omitempty"`
	Type      string `json:"type,omitempty"`
}

UpdatePhone Phone number

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.