Documentation
¶
Index ¶
- type Error
- type InviteBody
- type InviteInfo
- type InviteInfoErrors
- type InviteInfoErrorsItems
- type InviteInfoStatus
- type Invites
- type Service
- func (s *Service) CreateInvite(inviteBody InviteBody, resp ...*http.Response) (*InviteInfo, error)
- func (s *Service) DeleteInvite(inviteId string, resp ...*http.Response) error
- func (s *Service) GetInvite(inviteId string, resp ...*http.Response) (*InviteInfo, error)
- func (s *Service) GetTenant(tenantName string, resp ...*http.Response) (*TenantInfo, error)
- func (s *Service) ListInvites(resp ...*http.Response) (*Invites, error)
- func (s *Service) ListTenants(resp ...*http.Response) (*Tenants, error)
- func (s *Service) UpdateInvite(inviteId string, updateInviteBody UpdateInviteBody, resp ...*http.Response) (*InviteInfo, error)
- type Servicer
- type ServicerGenerated
- type TenantInfo
- type Tenants
- type UpdateInviteBody
- type UpdateInviteBodyAction
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type InviteBody ¶
type InviteInfo ¶
type InviteInfo struct {
Comment string `json:"comment"`
CreatedAt string `json:"createdAt"`
CreatedBy string `json:"createdBy"`
Email string `json:"email"`
Errors InviteInfoErrors `json:"errors"`
ExpiresAt string `json:"expiresAt"`
Groups []string `json:"groups"`
InviteID string `json:"inviteID"`
Status InviteInfoStatus `json:"status"`
Tenant string `json:"tenant"`
UpdatedAt string `json:"updatedAt"`
UpdatedBy string `json:"updatedBy"`
}
type InviteInfoErrors ¶
type InviteInfoErrors []InviteInfoErrorsItems
type InviteInfoErrorsItems ¶
type InviteInfoStatus ¶
type InviteInfoStatus string
const ( InviteInfoStatusCreated InviteInfoStatus = "created" InviteInfoStatusInvited InviteInfoStatus = "invited" InviteInfoStatusAccepted InviteInfoStatus = "accepted" InviteInfoStatusRejected InviteInfoStatus = "rejected" InviteInfoStatusExpired InviteInfoStatus = "expired" InviteInfoStatusFailed InviteInfoStatus = "failed" InviteInfoStatusInvalid InviteInfoStatus = "invalid" )
List of InviteInfoStatus
type Invites ¶
type Invites []InviteInfo
type Service ¶
type Service services.BaseService
func NewService ¶
NewService creates a new provisioner service client from the given Config
func (*Service) CreateInvite ¶
func (s *Service) CreateInvite(inviteBody InviteBody, resp ...*http.Response) (*InviteInfo, error)
CreateInvite - provisioner service endpoint Creates an invitation for a person to join the tenant using their email address. Parameters:
inviteBody resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
func (*Service) DeleteInvite ¶
DeleteInvite - provisioner service endpoint Removes an invitation in the given tenant. Parameters:
inviteId resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
func (*Service) GetInvite ¶
GetInvite - provisioner service endpoint Returns an invitation in the given tenant. Parameters:
inviteId resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
func (*Service) GetTenant ¶
GetTenant - provisioner service endpoint Returns a specific tenant. Parameters:
tenantName resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
func (*Service) ListInvites ¶
ListInvites - provisioner service endpoint Returns a list of invitations in a given tenant. Parameters:
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
func (*Service) ListTenants ¶
ListTenants - provisioner service endpoint Returns all tenants that the user can read. Parameters:
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
func (*Service) UpdateInvite ¶
func (s *Service) UpdateInvite(inviteId string, updateInviteBody UpdateInviteBody, resp ...*http.Response) (*InviteInfo, error)
UpdateInvite - provisioner service endpoint Modifies an invitation in the given tenant. Parameters:
inviteId updateInviteBody resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
type Servicer ¶
type Servicer interface {
//interfaces that are auto-generated in interface_generated.go
ServicerGenerated
}
Servicer represents the interface for implementing all endpoints for this service
type ServicerGenerated ¶ added in v1.10.0
type ServicerGenerated interface {
/*
CreateInvite - provisioner service endpoint
Creates an invitation for a person to join the tenant using their email address.
Parameters:
inviteBody
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
*/
CreateInvite(inviteBody InviteBody, resp ...*http.Response) (*InviteInfo, error)
/*
DeleteInvite - provisioner service endpoint
Removes an invitation in the given tenant.
Parameters:
inviteId
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
*/
DeleteInvite(inviteId string, resp ...*http.Response) error
/*
GetInvite - provisioner service endpoint
Returns an invitation in the given tenant.
Parameters:
inviteId
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
*/
GetInvite(inviteId string, resp ...*http.Response) (*InviteInfo, error)
/*
GetTenant - provisioner service endpoint
Returns a specific tenant.
Parameters:
tenantName
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
*/
GetTenant(tenantName string, resp ...*http.Response) (*TenantInfo, error)
/*
ListInvites - provisioner service endpoint
Returns a list of invitations in a given tenant.
Parameters:
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
*/
ListInvites(resp ...*http.Response) (*Invites, error)
/*
ListTenants - provisioner service endpoint
Returns all tenants that the user can read.
Parameters:
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
*/
ListTenants(resp ...*http.Response) (*Tenants, error)
/*
UpdateInvite - provisioner service endpoint
Modifies an invitation in the given tenant.
Parameters:
inviteId
updateInviteBody
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
*/
UpdateInvite(inviteId string, updateInviteBody UpdateInviteBody, resp ...*http.Response) (*InviteInfo, error)
}
ServicerGenerated represents the interface for implementing all endpoints for this service
type TenantInfo ¶
type Tenants ¶
type Tenants []TenantInfo
type UpdateInviteBody ¶
type UpdateInviteBody struct {
Action UpdateInviteBodyAction `json:"action"`
}
type UpdateInviteBodyAction ¶
type UpdateInviteBodyAction string
const ( UpdateInviteBodyActionAccept UpdateInviteBodyAction = "accept" UpdateInviteBodyActionReject UpdateInviteBodyAction = "reject" UpdateInviteBodyActionResend UpdateInviteBodyAction = "resend" )
List of UpdateInviteBodyAction