Documentation
¶
Index ¶
- Constants
- type AccessToken
- type AccessTokenRequest
- type AuthCodeRequest
- type AuthCodeRequestBody
- type AuthorizationCode
- func (m *AuthorizationCode) ClientID() manifold.ID
- func (m *AuthorizationCode) ClientSecret() OAuthClientSecret
- func (m *AuthorizationCode) GrantType() string
- func (m AuthorizationCode) MarshalJSON() ([]byte, error)
- func (m *AuthorizationCode) SetClientID(val manifold.ID)
- func (m *AuthorizationCode) SetClientSecret(val OAuthClientSecret)
- func (m *AuthorizationCode) SetGrantType(val string)
- func (m *AuthorizationCode) UnmarshalJSON(raw []byte) error
- func (m *AuthorizationCode) Validate(formats strfmt.Registry) error
- type CallbackResponse
- type ClientCredentials
- func (m *ClientCredentials) ClientID() manifold.ID
- func (m *ClientCredentials) ClientSecret() OAuthClientSecret
- func (m *ClientCredentials) GrantType() string
- func (m ClientCredentials) MarshalJSON() ([]byte, error)
- func (m *ClientCredentials) SetClientID(val manifold.ID)
- func (m *ClientCredentials) SetClientSecret(val OAuthClientSecret)
- func (m *ClientCredentials) SetGrantType(val string)
- func (m *ClientCredentials) UnmarshalJSON(raw []byte) error
- func (m *ClientCredentials) Validate(formats strfmt.Registry) error
- type Code
- type FeatureMap
- type Identity
- type OAuthClientSecret
- type OAuthCredentialCreateRequest
- type OAuthCredentialCreateResponse
- type OAuthCredentialGetResponse
- type Product
- type ProductAO1Target
- type Profile
- type RegionSlug
- type Resource
- type User
- type UserAO1Target
Constants ¶
const ( // CallbackResponseStateDone captures enum value "done" CallbackResponseStateDone string = "done" // CallbackResponseStateError captures enum value "error" CallbackResponseStateError string = "error" )
const ( // AccessTokenTokenTypeBearer captures enum value "bearer" AccessTokenTokenTypeBearer string = "bearer" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessToken ¶
type AccessToken struct {
// access token
// Required: true
// Max Length: 295
AccessToken *string `json:"access_token"`
// expires in
// Required: true
ExpiresIn *int64 `json:"expires_in"`
// token type
// Required: true
TokenType *string `json:"token_type"`
}
AccessToken A granted access token used for performing requests on behalf o a user or provider against the Manifold Connector API.
swagger:model AccessToken
type AccessTokenRequest ¶
type AccessTokenRequest interface {
runtime.Validatable
// client id
ClientID() manifold.ID
SetClientID(manifold.ID)
// client secret
ClientSecret() OAuthClientSecret
SetClientSecret(OAuthClientSecret)
// grant type
// Required: true
GrantType() string
SetGrantType(string)
}
AccessTokenRequest HTTP Request Body of an Access Token swagger:discriminator AccessTokenRequest grant_type
func UnmarshalAccessTokenRequest ¶
func UnmarshalAccessTokenRequest(reader io.Reader, consumer runtime.Consumer) (AccessTokenRequest, error)
UnmarshalAccessTokenRequest unmarshals polymorphic AccessTokenRequest
func UnmarshalAccessTokenRequestSlice ¶
func UnmarshalAccessTokenRequestSlice(reader io.Reader, consumer runtime.Consumer) ([]AccessTokenRequest, error)
UnmarshalAccessTokenRequestSlice unmarshals polymorphic slices of AccessTokenRequest
type AuthCodeRequest ¶
type AuthCodeRequest struct {
// body
// Required: true
Body *AuthCodeRequestBody `json:"body"`
}
AuthCodeRequest HTTP Request Body of an Auth Code swagger:model AuthCodeRequest
type AuthCodeRequestBody ¶
type AuthCodeRequestBody struct {
// resource id
// Required: true
ResourceID manifold.ID `json:"resource_id"`
}
AuthCodeRequestBody auth code request body swagger:model AuthCodeRequestBody
type AuthorizationCode ¶
type AuthorizationCode struct {
// code
// Required: true
Code Code `json:"code"`
// contains filtered or unexported fields
}
AuthorizationCode authorization code swagger:model authorization_code
func (*AuthorizationCode) ClientID ¶
func (m *AuthorizationCode) ClientID() manifold.ID
func (*AuthorizationCode) ClientSecret ¶
func (m *AuthorizationCode) ClientSecret() OAuthClientSecret
func (*AuthorizationCode) GrantType ¶
func (m *AuthorizationCode) GrantType() string
func (AuthorizationCode) MarshalJSON ¶
func (m AuthorizationCode) MarshalJSON() ([]byte, error)
MarshalJSON marshals this polymorphic type to a JSON structure
func (*AuthorizationCode) SetClientID ¶
func (m *AuthorizationCode) SetClientID(val manifold.ID)
func (*AuthorizationCode) SetClientSecret ¶
func (m *AuthorizationCode) SetClientSecret(val OAuthClientSecret)
func (*AuthorizationCode) SetGrantType ¶
func (m *AuthorizationCode) SetGrantType(val string)
func (*AuthorizationCode) UnmarshalJSON ¶
func (m *AuthorizationCode) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this polymorphic type from a JSON structure
type CallbackResponse ¶
type CallbackResponse struct {
// credentials
Credentials map[string]string `json:"credentials,omitempty"`
// message
// Required: true
// Max Length: 256
// Min Length: 3
Message *string `json:"message"`
// state
// Required: true
State *string `json:"state"`
}
CallbackResponse A callback sent from a provider to complete an asynchronous request.
Credentials can only be specified *if* the callback corresponds with a credential provisioning request.
swagger:model CallbackResponse
type ClientCredentials ¶
type ClientCredentials struct {
// contains filtered or unexported fields
}
ClientCredentials client credentials swagger:model client_credentials
func (*ClientCredentials) ClientID ¶
func (m *ClientCredentials) ClientID() manifold.ID
func (*ClientCredentials) ClientSecret ¶
func (m *ClientCredentials) ClientSecret() OAuthClientSecret
func (*ClientCredentials) GrantType ¶
func (m *ClientCredentials) GrantType() string
func (ClientCredentials) MarshalJSON ¶
func (m ClientCredentials) MarshalJSON() ([]byte, error)
MarshalJSON marshals this polymorphic type to a JSON structure
func (*ClientCredentials) SetClientID ¶
func (m *ClientCredentials) SetClientID(val manifold.ID)
func (*ClientCredentials) SetClientSecret ¶
func (m *ClientCredentials) SetClientSecret(val OAuthClientSecret)
func (*ClientCredentials) SetGrantType ¶
func (m *ClientCredentials) SetGrantType(val string)
func (*ClientCredentials) UnmarshalJSON ¶
func (m *ClientCredentials) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this polymorphic type from a JSON structure
type Code ¶
type Code string
Code An authorization code used by a provider in exchange for a scoped Access Token.
swagger:model Code
type FeatureMap ¶ added in v0.13.0
type FeatureMap map[string]interface{}
FeatureMap A map of feature labels to selected values for customizable features swagger:model FeatureMap
type Identity ¶
type Identity interface {
runtime.Validatable
// type
// Required: true
Type() string
SetType(string)
}
Identity The underlying actor represented by the current Access Token. swagger:discriminator Identity type
func UnmarshalIdentity ¶
UnmarshalIdentity unmarshals polymorphic Identity
type OAuthClientSecret ¶
type OAuthClientSecret string
OAuthClientSecret Client Secret portion of the OAuth Credentials used for accessing the Manifold Connector API. A client secret is a 32byte base64 encoded value.
This value must be kept a secret.
swagger:model OAuthClientSecret
type OAuthCredentialCreateRequest ¶
type OAuthCredentialCreateRequest struct {
// A human readable description of this credential pair.
//
// Required: true
// Max Length: 256
// Min Length: 3
Description *string `json:"description"`
// product id
// Required: true
ProductID manifold.ID `json:"product_id"`
}
OAuthCredentialCreateRequest o auth credential create request swagger:model OAuthCredentialCreateRequest
type OAuthCredentialCreateResponse ¶
type OAuthCredentialCreateResponse struct {
// secret
// Required: true
Secret OAuthClientSecret `json:"secret"`
OAuthCredentialGetResponse
}
OAuthCredentialCreateResponse o auth credential create response swagger:model OAuthCredentialCreateResponse
func (OAuthCredentialCreateResponse) MarshalJSON ¶
func (m OAuthCredentialCreateResponse) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*OAuthCredentialCreateResponse) UnmarshalJSON ¶
func (m *OAuthCredentialCreateResponse) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type OAuthCredentialGetResponse ¶
type OAuthCredentialGetResponse struct {
// created at
// Required: true
CreatedAt *strfmt.DateTime `json:"created_at"`
// expires at
ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`
// id
// Required: true
ID manifold.ID `json:"id"`
// updated at
// Required: true
UpdatedAt *strfmt.DateTime `json:"updated_at"`
OAuthCredentialCreateRequest
}
OAuthCredentialGetResponse o auth credential get response swagger:model OAuthCredentialGetResponse
func (OAuthCredentialGetResponse) MarshalJSON ¶
func (m OAuthCredentialGetResponse) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*OAuthCredentialGetResponse) UnmarshalJSON ¶
func (m *OAuthCredentialGetResponse) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Product ¶
type Product struct {
// target
// Required: true
Target *ProductAO1Target `json:"target"`
}
Product product swagger:model product
func (Product) MarshalJSON ¶
MarshalJSON marshals this polymorphic type to a JSON structure
func (*Product) UnmarshalJSON ¶
UnmarshalJSON unmarshals this polymorphic type from a JSON structure
type ProductAO1Target ¶
type ProductAO1Target struct {
// label
// Required: true
Label manifold.Label `json:"label"`
// name
// Required: true
Name manifold.Name `json:"name"`
}
ProductAO1Target product a o1 target swagger:model ProductAO1Target
type Profile ¶
type Profile struct {
// email
// Required: true
Email manifold.Email `json:"email"`
// name
// Required: true
Name manifold.Name `json:"name"`
}
Profile A view of a Manifold User.
Do not store any of this data, instead query Manifold for the most up to date information.
swagger:model Profile
type RegionSlug ¶
type RegionSlug string
RegionSlug Combination of the cloud platform and location to provision this resource within.
swagger:model RegionSlug
type Resource ¶
type Resource struct {
// created at
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// features
Features FeatureMap `json:"features,omitempty"`
// id
ID manifold.ID `json:"id,omitempty"`
// label
Label manifold.Label `json:"label,omitempty"`
// This field has been deprecated in favor of label
Name manifold.Name `json:"name,omitempty"`
// plan
Plan manifold.Label `json:"plan,omitempty"`
// product
Product manifold.Label `json:"product,omitempty"`
// region
Region RegionSlug `json:"region,omitempty"`
// updated at
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}
Resource A view of a Resource provisioned through Manifold.
Do not store any of this data, instead query Manifold for the most up to date information.
swagger:model Resource
type User ¶
type User struct {
// target
// Required: true
Target *UserAO1Target `json:"target"`
}
User user swagger:model user
func (User) MarshalJSON ¶
MarshalJSON marshals this polymorphic type to a JSON structure
func (*User) UnmarshalJSON ¶
UnmarshalJSON unmarshals this polymorphic type from a JSON structure
Source Files
¶
- access_token.go
- access_token_request.go
- auth_code_request.go
- authorization_code.go
- callback_response.go
- client_credentials.go
- code.go
- feature_map.go
- identity.go
- o_auth_client_secret.go
- o_auth_credential_create_request.go
- o_auth_credential_create_response.go
- o_auth_credential_get_response.go
- product.go
- profile.go
- region_slug.go
- resource.go
- user.go