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 CredentialRotationRequest
- type Identity
- type OAuthClientSecret
- type OAuthCredentialCreateRequest
- type OAuthCredentialCreateResponse
- type OAuthCredentialGetResponse
- type Product
- type ProductAO1Target
- type Profile
- type Project
- type Provider
- type ProviderAO1Target
- type RegionSlug
- type Resource
- type ResourceCredentials
- type ResourceMeasure
- type ResourceMeasureFeature
- type ResourceMeasureFeatureValue
- type ResourceMeasures
- type ResourceMeasuresBody
- type ResourceMeasuresUsage
- type ResourceMeasuresUsages
- type Team
- type User
- type UserAO1Target
- type UserRole
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 CredentialRotationRequest ¶ added in v0.15.0
type CredentialRotationRequest struct {
// credential id
// Required: true
CredentialID manifold.ID `json:"credential_id"`
// reason
// Required: true
// Max Length: 256
// Min Length: 3
Reason *string `json:"reason"`
// resource id
// Required: true
ResourceID manifold.ID `json:"resource_id"`
}
CredentialRotationRequest The information on the credential rotation to perform.
swagger:model CredentialRotationRequest
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 identifier to scope the credential to a single product.
//
ProductID *manifold.ID `json:"product_id,omitempty"`
// **ALPHA** Provider identifier to scope the credential to
// all products of a provider.
//
ProviderID *manifold.ID `json:"provider_id,omitempty"`
}
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"`
// id
ID manifold.ID `json:"id,omitempty"`
// name
// Required: true
Name manifold.Name `json:"name"`
// role
Role UserRole `json:"role,omitempty"`
}
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 Project ¶ added in v0.14.0
type Project struct {
// description
// Max Length: 1000
// Min Length: 1
Description string `json:"description,omitempty"`
// id
ID manifold.ID `json:"id,omitempty"`
// label
Label manifold.Label `json:"label,omitempty"`
// name
Name manifold.Name `json:"name,omitempty"`
// resources
Resources []*Resource `json:"resources"`
}
Project project swagger:model Project
type Provider ¶ added in v0.15.2
type Provider struct {
// target
// Required: true
Target *ProviderAO1Target `json:"target"`
}
Provider provider swagger:model provider
func (Provider) MarshalJSON ¶ added in v0.15.2
MarshalJSON marshals this polymorphic type to a JSON structure
func (*Provider) UnmarshalJSON ¶ added in v0.15.2
UnmarshalJSON unmarshals this polymorphic type from a JSON structure
type ProviderAO1Target ¶ added in v0.15.2
type ProviderAO1Target struct {
// label
// Required: true
Label manifold.Label `json:"label"`
// name
// Required: true
Name manifold.Name `json:"name"`
}
ProviderAO1Target provider a o1 target swagger:model ProviderAO1Target
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 manifold.FeatureMap `json:"features,omitempty"`
// id
ID manifold.ID `json:"id,omitempty"`
// label
Label manifold.Label `json:"label,omitempty"`
// This field is 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 ResourceCredentials ¶ added in v0.14.0
type ResourceCredentials struct {
// created on
// Required: true
CreatedOn *strfmt.DateTime `json:"created_on"`
// Map of configuration variable aliases to original names
CustomNames map[string]string `json:"custom_names,omitempty"`
// Map of configuration variable names to values, names
// must IEEE 1003.1 - 2001 Standard (checked in code).
//
// Required: true
Keys map[string]string `json:"keys"`
}
ResourceCredentials resource credentials swagger:model ResourceCredentials
type ResourceMeasure ¶ added in v0.14.0
type ResourceMeasure struct {
// feature
// Required: true
Feature *ResourceMeasureFeature `json:"feature"`
// feature value
// Required: true
FeatureValue *ResourceMeasureFeatureValue `json:"feature_value"`
// max
Max *int64 `json:"max,omitempty"`
// suffix
Suffix *string `json:"suffix,omitempty"`
// usage
// Required: true
Usage int64 `json:"usage"`
}
ResourceMeasure resource measure swagger:model ResourceMeasure
type ResourceMeasureFeature ¶ added in v0.14.0
type ResourceMeasureFeature struct {
// label
Label manifold.Label `json:"label,omitempty"`
// name
Name manifold.Name `json:"name,omitempty"`
}
ResourceMeasureFeature resource measure feature swagger:model ResourceMeasureFeature
type ResourceMeasureFeatureValue ¶ added in v0.14.0
type ResourceMeasureFeatureValue struct {
// A machine readable unique label, which is url safe.
// Pattern: ^[a-z0-9][a-z0-9-_\.]{1,128}$
Label string `json:"label,omitempty"`
// name
Name manifold.Name `json:"name,omitempty"`
}
ResourceMeasureFeatureValue resource measure feature value swagger:model ResourceMeasureFeatureValue
type ResourceMeasures ¶ added in v0.14.0
type ResourceMeasures struct {
// body
// Required: true
Body *ResourceMeasuresBody `json:"body"`
}
ResourceMeasures resource measures swagger:model ResourceMeasures
type ResourceMeasuresBody ¶ added in v0.14.0
type ResourceMeasuresBody struct {
// measures
// Required: true
Measures map[string]int64 `json:"measures"`
// period end
// Required: true
PeriodEnd *strfmt.DateTime `json:"period_end"`
// period start
// Required: true
PeriodStart *strfmt.DateTime `json:"period_start"`
// resource id
// Required: true
ResourceID manifold.ID `json:"resource_id"`
}
ResourceMeasuresBody resource measures body swagger:model ResourceMeasuresBody
type ResourceMeasuresUsage ¶ added in v0.14.0
type ResourceMeasuresUsage struct {
// measures
Measures []*ResourceMeasure `json:"measures"`
// period end
PeriodEnd strfmt.DateTime `json:"period_end,omitempty"`
// period start
PeriodStart strfmt.DateTime `json:"period_start,omitempty"`
// updated at
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}
ResourceMeasuresUsage resource measures usage swagger:model ResourceMeasuresUsage
type ResourceMeasuresUsages ¶ added in v0.14.0
type ResourceMeasuresUsages []*ResourceMeasuresUsage
ResourceMeasuresUsages resource measures usages swagger:model ResourceMeasuresUsages
type Team ¶ added in v0.14.0
type Team struct {
// id
ID manifold.ID `json:"id,omitempty"`
// label
Label manifold.Label `json:"label,omitempty"`
// name
Name manifold.Name `json:"name,omitempty"`
// projects
Projects []*Project `json:"projects"`
// resources
Resources []*Resource `json:"resources"`
// user role
UserRole UserRole `json:"user_role,omitempty"`
}
Team team swagger:model Team
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
type UserAO1Target ¶
type UserAO1Target struct {
// email
// Required: true
Email manifold.Email `json:"email"`
// id
ID manifold.ID `json:"id,omitempty"`
// name
// Required: true
Name manifold.Name `json:"name"`
// projects
Projects []*Project `json:"projects"`
// resources
Resources []*Resource `json:"resources"`
// teams
Teams []*Team `json:"teams"`
}
UserAO1Target user a o1 target swagger:model UserAO1Target
Source Files
¶
- access_token.go
- access_token_request.go
- auth_code_request.go
- authorization_code.go
- callback_response.go
- client_credentials.go
- code.go
- credential_rotation_request.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
- project.go
- provider.go
- region_slug.go
- resource.go
- resource_credentials.go
- resource_measure.go
- resource_measures.go
- resource_measures_body.go
- resource_measures_usage.go
- resource_measures_usages.go
- team.go
- user.go
- user_role.go