memberships

package
v2.3.0 Latest Latest
Warning

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

 Go to latest Published: Jun 18, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA added in v2.2.0 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType added in v2.2.0 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus added in v2.3.0 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type MemberParam added in v2.1.0 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Membership 

type Membership struct {
	// Membership identifier tag.
	ID      string           `json:"id"`
	Account accounts.Account `json:"account"`
	// Enterprise only. Indicates whether or not API access is enabled specifically for
	// this user on a given account.
	APIAccessEnabled bool `json:"api_access_enabled,nullable"`
	// All access permissions for the user at the account.
	Permissions MembershipPermissions `json:"permissions"`
	// List of role names for the user at the account.
	Roles []string `json:"roles"`
	// Status of this membership.
	Status MembershipStatus `json:"status"`
	JSON   membershipJSON   `json:"-"`
}

func (*Membership) UnmarshalJSON 

func (r *Membership) UnmarshalJSON(data []byte) (err error)

type MembershipDeleteResponse 

type MembershipDeleteResponse struct {
	// Membership identifier tag.
	ID   string                       `json:"id"`
	JSON membershipDeleteResponseJSON `json:"-"`
}

func (*MembershipDeleteResponse) UnmarshalJSON 

func (r *MembershipDeleteResponse) UnmarshalJSON(data []byte) (err error)

type MembershipDeleteResponseEnvelope 

type MembershipDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success MembershipDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  MembershipDeleteResponse                `json:"result"`
	JSON    membershipDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*MembershipDeleteResponseEnvelope) UnmarshalJSON 

func (r *MembershipDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type MembershipDeleteResponseEnvelopeSuccess 

type MembershipDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	MembershipDeleteResponseEnvelopeSuccessTrue MembershipDeleteResponseEnvelopeSuccess = true
)

func (MembershipDeleteResponseEnvelopeSuccess) IsKnown 

func (r MembershipDeleteResponseEnvelopeSuccess) IsKnown() bool

type MembershipGetResponse added in v2.3.0 

type MembershipGetResponse struct {
	// Membership identifier tag.
	ID      string           `json:"id"`
	Account accounts.Account `json:"account"`
	// Enterprise only. Indicates whether or not API access is enabled specifically for
	// this user on a given account.
	APIAccessEnabled bool `json:"api_access_enabled,nullable"`
	// All access permissions for the user at the account.
	Permissions MembershipGetResponsePermissions `json:"permissions"`
	// Access policy for the membership
	Policies []MembershipGetResponsePolicy `json:"policies"`
	// List of role names for the user at the account.
	Roles []string `json:"roles"`
	// Status of this membership.
	Status MembershipGetResponseStatus `json:"status"`
	JSON   membershipGetResponseJSON   `json:"-"`
}

func (*MembershipGetResponse) UnmarshalJSON added in v2.3.0 

func (r *MembershipGetResponse) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponseEnvelope 

type MembershipGetResponseEnvelope struct {
	Result MembershipGetResponse             `json:"result"`
	JSON   membershipGetResponseEnvelopeJSON `json:"-"`
}

func (*MembershipGetResponseEnvelope) UnmarshalJSON 

func (r *MembershipGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponsePermissions added in v2.3.0 

type MembershipGetResponsePermissions struct {
	Analytics    shared.PermissionGrant               `json:"analytics"`
	Billing      shared.PermissionGrant               `json:"billing"`
	CachePurge   shared.PermissionGrant               `json:"cache_purge"`
	DNS          shared.PermissionGrant               `json:"dns"`
	DNSRecords   shared.PermissionGrant               `json:"dns_records"`
	LB           shared.PermissionGrant               `json:"lb"`
	Logs         shared.PermissionGrant               `json:"logs"`
	Organization shared.PermissionGrant               `json:"organization"`
	SSL          shared.PermissionGrant               `json:"ssl"`
	WAF          shared.PermissionGrant               `json:"waf"`
	ZoneSettings shared.PermissionGrant               `json:"zone_settings"`
	Zones        shared.PermissionGrant               `json:"zones"`
	JSON         membershipGetResponsePermissionsJSON `json:"-"`
}

All access permissions for the user at the account.

func (*MembershipGetResponsePermissions) UnmarshalJSON added in v2.3.0 

func (r *MembershipGetResponsePermissions) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponsePoliciesAccess added in v2.3.0 

type MembershipGetResponsePoliciesAccess string

Allow or deny operations against the resources. 

const (
	MembershipGetResponsePoliciesAccessAllow MembershipGetResponsePoliciesAccess = "allow"
	MembershipGetResponsePoliciesAccessDeny  MembershipGetResponsePoliciesAccess = "deny"
)

func (MembershipGetResponsePoliciesAccess) IsKnown added in v2.3.0 

func (r MembershipGetResponsePoliciesAccess) IsKnown() bool

type MembershipGetResponsePoliciesPermissionGroup added in v2.3.0 

type MembershipGetResponsePoliciesPermissionGroup struct {
	// Identifier of the group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta interface{} `json:"meta"`
	// Name of the group.
	Name string                                           `json:"name"`
	JSON membershipGetResponsePoliciesPermissionGroupJSON `json:"-"`
}

A named group of permissions that map to a group of operations against resources.

func (*MembershipGetResponsePoliciesPermissionGroup) UnmarshalJSON added in v2.3.0 

func (r *MembershipGetResponsePoliciesPermissionGroup) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponsePoliciesResourceGroup added in v2.3.0 

type MembershipGetResponsePoliciesResourceGroup struct {
	// Identifier of the group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []MembershipGetResponsePoliciesResourceGroupsScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta interface{} `json:"meta"`
	// Name of the resource group.
	Name string                                         `json:"name"`
	JSON membershipGetResponsePoliciesResourceGroupJSON `json:"-"`
}

A group of scoped resources.

func (*MembershipGetResponsePoliciesResourceGroup) UnmarshalJSON added in v2.3.0 

func (r *MembershipGetResponsePoliciesResourceGroup) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponsePoliciesResourceGroupsScope added in v2.3.0 

type MembershipGetResponsePoliciesResourceGroupsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []MembershipGetResponsePoliciesResourceGroupsScopeObject `json:"objects,required"`
	JSON    membershipGetResponsePoliciesResourceGroupsScopeJSON     `json:"-"`
}

A scope is a combination of scope objects which provides additional context.

func (*MembershipGetResponsePoliciesResourceGroupsScope) UnmarshalJSON added in v2.3.0 

func (r *MembershipGetResponsePoliciesResourceGroupsScope) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponsePoliciesResourceGroupsScopeObject added in v2.3.0 

type MembershipGetResponsePoliciesResourceGroupsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                                     `json:"key,required"`
	JSON membershipGetResponsePoliciesResourceGroupsScopeObjectJSON `json:"-"`
}

A scope object represents any resource that can have actions applied against invite.

func (*MembershipGetResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON added in v2.3.0 

func (r *MembershipGetResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponsePolicy added in v2.3.0 

type MembershipGetResponsePolicy struct {
	// Policy identifier.
	ID string `json:"id"`
	// Allow or deny operations against the resources.
	Access MembershipGetResponsePoliciesAccess `json:"access"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups []MembershipGetResponsePoliciesPermissionGroup `json:"permission_groups"`
	// A list of resource groups that the policy applies to.
	ResourceGroups []MembershipGetResponsePoliciesResourceGroup `json:"resource_groups"`
	JSON           membershipGetResponsePolicyJSON              `json:"-"`
}

func (*MembershipGetResponsePolicy) UnmarshalJSON added in v2.3.0 

func (r *MembershipGetResponsePolicy) UnmarshalJSON(data []byte) (err error)

type MembershipGetResponseStatus added in v2.3.0 

type MembershipGetResponseStatus string

Status of this membership. 

const (
	MembershipGetResponseStatusAccepted MembershipGetResponseStatus = "accepted"
	MembershipGetResponseStatusPending  MembershipGetResponseStatus = "pending"
	MembershipGetResponseStatusRejected MembershipGetResponseStatus = "rejected"
)

func (MembershipGetResponseStatus) IsKnown added in v2.3.0 

func (r MembershipGetResponseStatus) IsKnown() bool

type MembershipListParams 

type MembershipListParams struct {
	Account param.Field[MembershipListParamsAccount] `query:"account"`
	// Direction to order memberships.
	Direction param.Field[MembershipListParamsDirection] `query:"direction"`
	// Account name
	Name param.Field[string] `query:"name"`
	// Field to order memberships by.
	Order param.Field[MembershipListParamsOrder] `query:"order"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of memberships per page.
	PerPage param.Field[float64] `query:"per_page"`
	// Status of this membership.
	Status param.Field[MembershipListParamsStatus] `query:"status"`
}

func (MembershipListParams) URLQuery 

func (r MembershipListParams) URLQuery() (v url.Values)

URLQuery serializes MembershipListParams's query parameters as `url.Values`.

type MembershipListParamsAccount 

type MembershipListParamsAccount struct {
	// Account name
	Name param.Field[string] `query:"name"`
}

func (MembershipListParamsAccount) URLQuery 

func (r MembershipListParamsAccount) URLQuery() (v url.Values)

URLQuery serializes MembershipListParamsAccount's query parameters as `url.Values`.

type MembershipListParamsDirection 

type MembershipListParamsDirection string

Direction to order memberships. 

const (
	MembershipListParamsDirectionAsc  MembershipListParamsDirection = "asc"
	MembershipListParamsDirectionDesc MembershipListParamsDirection = "desc"
)

func (MembershipListParamsDirection) IsKnown 

func (r MembershipListParamsDirection) IsKnown() bool

type MembershipListParamsOrder 

type MembershipListParamsOrder string

Field to order memberships by. 

const (
	MembershipListParamsOrderID          MembershipListParamsOrder = "id"
	MembershipListParamsOrderAccountName MembershipListParamsOrder = "account.name"
	MembershipListParamsOrderStatus      MembershipListParamsOrder = "status"
)

func (MembershipListParamsOrder) IsKnown 

func (r MembershipListParamsOrder) IsKnown() bool

type MembershipListParamsStatus 

type MembershipListParamsStatus string

Status of this membership. 

const (
	MembershipListParamsStatusAccepted MembershipListParamsStatus = "accepted"
	MembershipListParamsStatusPending  MembershipListParamsStatus = "pending"
	MembershipListParamsStatusRejected MembershipListParamsStatus = "rejected"
)

func (MembershipListParamsStatus) IsKnown 

func (r MembershipListParamsStatus) IsKnown() bool

type MembershipPermissions 

type MembershipPermissions struct {
	Analytics    shared.PermissionGrant    `json:"analytics"`
	Billing      shared.PermissionGrant    `json:"billing"`
	CachePurge   shared.PermissionGrant    `json:"cache_purge"`
	DNS          shared.PermissionGrant    `json:"dns"`
	DNSRecords   shared.PermissionGrant    `json:"dns_records"`
	LB           shared.PermissionGrant    `json:"lb"`
	Logs         shared.PermissionGrant    `json:"logs"`
	Organization shared.PermissionGrant    `json:"organization"`
	SSL          shared.PermissionGrant    `json:"ssl"`
	WAF          shared.PermissionGrant    `json:"waf"`
	ZoneSettings shared.PermissionGrant    `json:"zone_settings"`
	Zones        shared.PermissionGrant    `json:"zones"`
	JSON         membershipPermissionsJSON `json:"-"`
}

All access permissions for the user at the account.

func (*MembershipPermissions) UnmarshalJSON 

func (r *MembershipPermissions) UnmarshalJSON(data []byte) (err error)

type MembershipService 

type MembershipService struct {
	Options []option.RequestOption
}

MembershipService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewMembershipService method instead.

func NewMembershipService 

func NewMembershipService(opts ...option.RequestOption) (r *MembershipService)

NewMembershipService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*MembershipService) Delete 

func (r *MembershipService) Delete(ctx context.Context, membershipID string, opts ...option.RequestOption) (res *MembershipDeleteResponse, err error)

Remove the associated member from an account.

func (*MembershipService) Get 

func (r *MembershipService) Get(ctx context.Context, membershipID string, opts ...option.RequestOption) (res *MembershipGetResponse, err error)

Get a specific membership.

func (*MembershipService) List 

func (r *MembershipService) List(ctx context.Context, query MembershipListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[Membership], err error)

List memberships of accounts the user can access.

func (*MembershipService) ListAutoPaging 

func (r *MembershipService) ListAutoPaging(ctx context.Context, query MembershipListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[Membership]

List memberships of accounts the user can access.

func (*MembershipService) Update 

func (r *MembershipService) Update(ctx context.Context, membershipID string, body MembershipUpdateParams, opts ...option.RequestOption) (res *MembershipUpdateResponse, err error)

Accept or reject this account invitation.

type MembershipStatus 

type MembershipStatus string

Status of this membership. 

const (
	MembershipStatusAccepted MembershipStatus = "accepted"
	MembershipStatusPending  MembershipStatus = "pending"
	MembershipStatusRejected MembershipStatus = "rejected"
)

func (MembershipStatus) IsKnown 

func (r MembershipStatus) IsKnown() bool

type MembershipUpdateParams 

type MembershipUpdateParams struct {
	// Whether to accept or reject this account invitation.
	Status param.Field[MembershipUpdateParamsStatus] `json:"status,required"`
}

func (MembershipUpdateParams) MarshalJSON 

func (r MembershipUpdateParams) MarshalJSON() (data []byte, err error)

type MembershipUpdateParamsStatus 

type MembershipUpdateParamsStatus string

Whether to accept or reject this account invitation. 

const (
	MembershipUpdateParamsStatusAccepted MembershipUpdateParamsStatus = "accepted"
	MembershipUpdateParamsStatusRejected MembershipUpdateParamsStatus = "rejected"
)

func (MembershipUpdateParamsStatus) IsKnown 

func (r MembershipUpdateParamsStatus) IsKnown() bool

type MembershipUpdateResponse added in v2.3.0 

type MembershipUpdateResponse struct {
	// Membership identifier tag.
	ID      string           `json:"id"`
	Account accounts.Account `json:"account"`
	// Enterprise only. Indicates whether or not API access is enabled specifically for
	// this user on a given account.
	APIAccessEnabled bool `json:"api_access_enabled,nullable"`
	// All access permissions for the user at the account.
	Permissions MembershipUpdateResponsePermissions `json:"permissions"`
	// Access policy for the membership
	Policies []MembershipUpdateResponsePolicy `json:"policies"`
	// List of role names for the user at the account.
	Roles []string `json:"roles"`
	// Status of this membership.
	Status MembershipUpdateResponseStatus `json:"status"`
	JSON   membershipUpdateResponseJSON   `json:"-"`
}

func (*MembershipUpdateResponse) UnmarshalJSON added in v2.3.0 

func (r *MembershipUpdateResponse) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponseEnvelope 

type MembershipUpdateResponseEnvelope struct {
	Result MembershipUpdateResponse             `json:"result"`
	JSON   membershipUpdateResponseEnvelopeJSON `json:"-"`
}

func (*MembershipUpdateResponseEnvelope) UnmarshalJSON 

func (r *MembershipUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponsePermissions added in v2.3.0 

type MembershipUpdateResponsePermissions struct {
	Analytics    shared.PermissionGrant                  `json:"analytics"`
	Billing      shared.PermissionGrant                  `json:"billing"`
	CachePurge   shared.PermissionGrant                  `json:"cache_purge"`
	DNS          shared.PermissionGrant                  `json:"dns"`
	DNSRecords   shared.PermissionGrant                  `json:"dns_records"`
	LB           shared.PermissionGrant                  `json:"lb"`
	Logs         shared.PermissionGrant                  `json:"logs"`
	Organization shared.PermissionGrant                  `json:"organization"`
	SSL          shared.PermissionGrant                  `json:"ssl"`
	WAF          shared.PermissionGrant                  `json:"waf"`
	ZoneSettings shared.PermissionGrant                  `json:"zone_settings"`
	Zones        shared.PermissionGrant                  `json:"zones"`
	JSON         membershipUpdateResponsePermissionsJSON `json:"-"`
}

All access permissions for the user at the account.

func (*MembershipUpdateResponsePermissions) UnmarshalJSON added in v2.3.0 

func (r *MembershipUpdateResponsePermissions) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponsePoliciesAccess added in v2.3.0 

type MembershipUpdateResponsePoliciesAccess string

Allow or deny operations against the resources. 

const (
	MembershipUpdateResponsePoliciesAccessAllow MembershipUpdateResponsePoliciesAccess = "allow"
	MembershipUpdateResponsePoliciesAccessDeny  MembershipUpdateResponsePoliciesAccess = "deny"
)

func (MembershipUpdateResponsePoliciesAccess) IsKnown added in v2.3.0 

func (r MembershipUpdateResponsePoliciesAccess) IsKnown() bool

type MembershipUpdateResponsePoliciesPermissionGroup added in v2.3.0 

type MembershipUpdateResponsePoliciesPermissionGroup struct {
	// Identifier of the group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta interface{} `json:"meta"`
	// Name of the group.
	Name string                                              `json:"name"`
	JSON membershipUpdateResponsePoliciesPermissionGroupJSON `json:"-"`
}

A named group of permissions that map to a group of operations against resources.

func (*MembershipUpdateResponsePoliciesPermissionGroup) UnmarshalJSON added in v2.3.0 

func (r *MembershipUpdateResponsePoliciesPermissionGroup) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponsePoliciesResourceGroup added in v2.3.0 

type MembershipUpdateResponsePoliciesResourceGroup struct {
	// Identifier of the group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []MembershipUpdateResponsePoliciesResourceGroupsScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta interface{} `json:"meta"`
	// Name of the resource group.
	Name string                                            `json:"name"`
	JSON membershipUpdateResponsePoliciesResourceGroupJSON `json:"-"`
}

A group of scoped resources.

func (*MembershipUpdateResponsePoliciesResourceGroup) UnmarshalJSON added in v2.3.0 

func (r *MembershipUpdateResponsePoliciesResourceGroup) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponsePoliciesResourceGroupsScope added in v2.3.0 

type MembershipUpdateResponsePoliciesResourceGroupsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []MembershipUpdateResponsePoliciesResourceGroupsScopeObject `json:"objects,required"`
	JSON    membershipUpdateResponsePoliciesResourceGroupsScopeJSON     `json:"-"`
}

A scope is a combination of scope objects which provides additional context.

func (*MembershipUpdateResponsePoliciesResourceGroupsScope) UnmarshalJSON added in v2.3.0 

func (r *MembershipUpdateResponsePoliciesResourceGroupsScope) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponsePoliciesResourceGroupsScopeObject added in v2.3.0 

type MembershipUpdateResponsePoliciesResourceGroupsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                                        `json:"key,required"`
	JSON membershipUpdateResponsePoliciesResourceGroupsScopeObjectJSON `json:"-"`
}

A scope object represents any resource that can have actions applied against invite.

func (*MembershipUpdateResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON added in v2.3.0 

func (r *MembershipUpdateResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponsePolicy added in v2.3.0 

type MembershipUpdateResponsePolicy struct {
	// Policy identifier.
	ID string `json:"id"`
	// Allow or deny operations against the resources.
	Access MembershipUpdateResponsePoliciesAccess `json:"access"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups []MembershipUpdateResponsePoliciesPermissionGroup `json:"permission_groups"`
	// A list of resource groups that the policy applies to.
	ResourceGroups []MembershipUpdateResponsePoliciesResourceGroup `json:"resource_groups"`
	JSON           membershipUpdateResponsePolicyJSON              `json:"-"`
}

func (*MembershipUpdateResponsePolicy) UnmarshalJSON added in v2.3.0 

func (r *MembershipUpdateResponsePolicy) UnmarshalJSON(data []byte) (err error)

type MembershipUpdateResponseStatus added in v2.3.0 

type MembershipUpdateResponseStatus string

Status of this membership. 

const (
	MembershipUpdateResponseStatusAccepted MembershipUpdateResponseStatus = "accepted"
	MembershipUpdateResponseStatusPending  MembershipUpdateResponseStatus = "pending"
	MembershipUpdateResponseStatusRejected MembershipUpdateResponseStatus = "rejected"
)

func (MembershipUpdateResponseStatus) IsKnown added in v2.3.0 

func (r MembershipUpdateResponseStatus) IsKnown() bool

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type SortDirection added in v2.2.0 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

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.