enterprisemanagementv1

package
v0.72.0 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2024 License: Apache-2.0 Imports: 9 Imported by: 2

Documentation

Overview

Package enterprisemanagementv1 : Operations and models for the EnterpriseManagementV1 service

Index

Constants

View Source 
const DefaultServiceName = "enterprise_management"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://enterprise.cloud.ibm.com/v1"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.17.1 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAccount 

func UnmarshalAccount(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAccount unmarshals an instance of Account from the specified map of raw messages.

func UnmarshalAccountGroup 

func UnmarshalAccountGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAccountGroup unmarshals an instance of AccountGroup from the specified map of raw messages.

func UnmarshalCreateAccountGroupResponse 

func UnmarshalCreateAccountGroupResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateAccountGroupResponse unmarshals an instance of CreateAccountGroupResponse from the specified map of raw messages.

func UnmarshalCreateAccountRequestOptions added in v0.61.4 

func UnmarshalCreateAccountRequestOptions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateAccountRequestOptions unmarshals an instance of CreateAccountRequestOptions from the specified map of raw messages.

func UnmarshalCreateAccountRequestTraits added in v0.37.2 

func UnmarshalCreateAccountRequestTraits(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateAccountRequestTraits unmarshals an instance of CreateAccountRequestTraits from the specified map of raw messages.

func UnmarshalCreateAccountResponse 

func UnmarshalCreateAccountResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateAccountResponse unmarshals an instance of CreateAccountResponse from the specified map of raw messages.

func UnmarshalCreateEnterpriseResponse 

func UnmarshalCreateEnterpriseResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateEnterpriseResponse unmarshals an instance of CreateEnterpriseResponse from the specified map of raw messages.

func UnmarshalEnterprise 

func UnmarshalEnterprise(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEnterprise unmarshals an instance of Enterprise from the specified map of raw messages.

func UnmarshalListAccountGroupsResponse 

func UnmarshalListAccountGroupsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListAccountGroupsResponse unmarshals an instance of ListAccountGroupsResponse from the specified map of raw messages.

func UnmarshalListAccountsResponse 

func UnmarshalListAccountsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListAccountsResponse unmarshals an instance of ListAccountsResponse from the specified map of raw messages.

func UnmarshalListEnterprisesResponse 

func UnmarshalListEnterprisesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListEnterprisesResponse unmarshals an instance of ListEnterprisesResponse from the specified map of raw messages.

Types

type Account 

type Account struct {
	// The URL of the account.
	URL *string `json:"url,omitempty"`

	// The account ID.
	ID *string `json:"id,omitempty"`

	// The Cloud Resource Name (CRN) of the account.
	CRN *string `json:"crn,omitempty"`

	// The CRN of the parent of the account.
	Parent *string `json:"parent,omitempty"`

	// The enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// The enterprise ID that the account is a part of.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The path from the enterprise to this particular account.
	EnterprisePath *string `json:"enterprise_path,omitempty"`

	// The name of the account.
	Name *string `json:"name,omitempty"`

	// The state of the account.
	State *string `json:"state,omitempty"`

	// The IAM ID of the owner of the account.
	OwnerIamID *string `json:"owner_iam_id,omitempty"`

	// The type of account - whether it is free or paid.
	Paid *bool `json:"paid,omitempty"`

	// The email address of the owner of the account.
	OwnerEmail *string `json:"owner_email,omitempty"`

	// The flag to indicate whether the account is an enterprise account or not.
	IsEnterpriseAccount *bool `json:"is_enterprise_account,omitempty"`

	// The time stamp at which the account was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The IAM ID of the user or service that created the account.
	CreatedBy *string `json:"created_by,omitempty"`

	// The time stamp at which the account was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The IAM ID of the user or service that updated the account.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

Account : An account resource.

type AccountGroup 

type AccountGroup struct {
	// The URL of the account group.
	URL *string `json:"url,omitempty"`

	// The account group ID.
	ID *string `json:"id,omitempty"`

	// The Cloud Resource Name (CRN) of the account group.
	CRN *string `json:"crn,omitempty"`

	// The CRN of the parent of the account group.
	Parent *string `json:"parent,omitempty"`

	// The enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// The enterprise ID that the account group is a part of.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The path from the enterprise to this particular account group.
	EnterprisePath *string `json:"enterprise_path,omitempty"`

	// The name of the account group.
	Name *string `json:"name,omitempty"`

	// The state of the account group.
	State *string `json:"state,omitempty"`

	// The IAM ID of the primary contact of the account group.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// The email address of the primary contact of the account group.
	PrimaryContactEmail *string `json:"primary_contact_email,omitempty"`

	// The time stamp at which the account group was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The IAM ID of the user or service that created the account group.
	CreatedBy *string `json:"created_by,omitempty"`

	// The time stamp at which the account group was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The IAM ID of the user or service that updated the account group.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

AccountGroup : An account group resource.

type AccountGroupsPager added in v0.29.4 

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

AccountGroupsPager can be used to simplify the use of the "ListAccountGroups" method.

func (*AccountGroupsPager) GetAll added in v0.29.4 

func (pager *AccountGroupsPager) GetAll() (allItems []AccountGroup, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*AccountGroupsPager) GetAllWithContext added in v0.29.4 

func (pager *AccountGroupsPager) GetAllWithContext(ctx context.Context) (allItems []AccountGroup, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*AccountGroupsPager) GetNext added in v0.29.4 

func (pager *AccountGroupsPager) GetNext() (page []AccountGroup, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*AccountGroupsPager) GetNextWithContext added in v0.29.4 

func (pager *AccountGroupsPager) GetNextWithContext(ctx context.Context) (page []AccountGroup, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*AccountGroupsPager) HasNext added in v0.29.4 

func (pager *AccountGroupsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type AccountsPager added in v0.29.4 

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

AccountsPager can be used to simplify the use of the "ListAccounts" method.

func (*AccountsPager) GetAll added in v0.29.4 

func (pager *AccountsPager) GetAll() (allItems []Account, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*AccountsPager) GetAllWithContext added in v0.29.4 

func (pager *AccountsPager) GetAllWithContext(ctx context.Context) (allItems []Account, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*AccountsPager) GetNext added in v0.29.4 

func (pager *AccountsPager) GetNext() (page []Account, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*AccountsPager) GetNextWithContext added in v0.29.4 

func (pager *AccountsPager) GetNextWithContext(ctx context.Context) (page []Account, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*AccountsPager) HasNext added in v0.29.4 

func (pager *AccountsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type CreateAccountGroupOptions 

type CreateAccountGroupOptions struct {
	// The CRN of the parent under which the account group will be created. The parent can be an existing account group or
	// the enterprise itself.
	Parent *string `json:"parent" validate:"required"`

	// The name of the account group. This field must have 3 - 60 characters.
	Name *string `json:"name" validate:"required"`

	// The IAM ID of the primary contact for this account group, such as `IBMid-0123ABC`. The IAM ID must already exist.
	PrimaryContactIamID *string `json:"primary_contact_iam_id" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateAccountGroupOptions : The CreateAccountGroup options.

func (*CreateAccountGroupOptions) SetHeaders 

func (options *CreateAccountGroupOptions) SetHeaders(param map[string]string) *CreateAccountGroupOptions

SetHeaders : Allow user to set Headers

func (*CreateAccountGroupOptions) SetName 

func (_options *CreateAccountGroupOptions) SetName(name string) *CreateAccountGroupOptions

SetName : Allow user to set Name

func (*CreateAccountGroupOptions) SetParent 

func (_options *CreateAccountGroupOptions) SetParent(parent string) *CreateAccountGroupOptions

SetParent : Allow user to set Parent

func (*CreateAccountGroupOptions) SetPrimaryContactIamID 

func (_options *CreateAccountGroupOptions) SetPrimaryContactIamID(primaryContactIamID string) *CreateAccountGroupOptions

SetPrimaryContactIamID : Allow user to set PrimaryContactIamID

type CreateAccountGroupResponse 

type CreateAccountGroupResponse struct {
	// The ID of the account group entity that was created.
	AccountGroupID *string `json:"account_group_id,omitempty"`
}

CreateAccountGroupResponse : A newly-created account group.

type CreateAccountOptions 

type CreateAccountOptions struct {
	// The CRN of the parent under which the account will be created. The parent can be an existing account group or the
	// enterprise itself.
	Parent *string `json:"parent" validate:"required"`

	// The name of the account. This field must have 3 - 60 characters.
	Name *string `json:"name" validate:"required"`

	// The IAM ID of the account owner, such as `IBMid-0123ABC`. The IAM ID must already exist.
	OwnerIamID *string `json:"owner_iam_id" validate:"required"`

	// The traits object can be used to set properties on child accounts of an enterprise. You can pass a field to opt-out
	// of the default multi-factor authentication setting or enable enterprise-managed IAM when creating a child account in
	// the enterprise. This is an optional field.
	Traits *CreateAccountRequestTraits `json:"traits,omitempty"`

	// The options object can be used to set properties on child accounts of an enterprise. You can pass a field to to
	// create IAM service id with IAM api key when creating a child account in the enterprise. This is an optional field.
	Options *CreateAccountRequestOptions `json:"options,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateAccountOptions : The CreateAccount options.

func (*CreateAccountOptions) SetHeaders 

func (options *CreateAccountOptions) SetHeaders(param map[string]string) *CreateAccountOptions

SetHeaders : Allow user to set Headers

func (*CreateAccountOptions) SetName 

func (_options *CreateAccountOptions) SetName(name string) *CreateAccountOptions

SetName : Allow user to set Name

func (*CreateAccountOptions) SetOptions added in v0.61.4 

func (_options *CreateAccountOptions) SetOptions(options *CreateAccountRequestOptions) *CreateAccountOptions

SetOptions : Allow user to set Options

func (*CreateAccountOptions) SetOwnerIamID 

func (_options *CreateAccountOptions) SetOwnerIamID(ownerIamID string) *CreateAccountOptions

SetOwnerIamID : Allow user to set OwnerIamID

func (*CreateAccountOptions) SetParent 

func (_options *CreateAccountOptions) SetParent(parent string) *CreateAccountOptions

SetParent : Allow user to set Parent

func (*CreateAccountOptions) SetTraits added in v0.36.0 

func (_options *CreateAccountOptions) SetTraits(traits *CreateAccountRequestTraits) *CreateAccountOptions

SetTraits : Allow user to set Traits

type CreateAccountRequestOptions added in v0.61.4 

type CreateAccountRequestOptions struct {
	// By default create_iam_service_id_with_apikey_and_owner_policies is turned off for a newly created child account. You
	// can enable this property by passing 'true' in this boolean field. IAM service id has account owner IAM policies and
	// the API key associated with it can generate a token and setup resources in the account. This is an optional field.
	CreateIamServiceIDWithApikeyAndOwnerPolicies *bool `json:"create_iam_service_id_with_apikey_and_owner_policies,omitempty"`
}

CreateAccountRequestOptions : The options object can be used to set properties on child accounts of an enterprise. You can pass a field to to create IAM service id with IAM api key when creating a child account in the enterprise. This is an optional field.

type CreateAccountRequestTraits added in v0.37.2 

type CreateAccountRequestTraits struct {
	// By default MFA is set to `NONE_NO_ROPC` on a child account, which disables CLI logins with only a password. To opt
	// out, pass the traits object with the mfa field set to empty string. This is an optional field.
	Mfa *string `json:"mfa,omitempty"`

	// By default enterprise-managed IAM is turned off for a newly created child account. You can enable this property by
	// passing 'true' in this boolean field. Enabling enterprise-managed IAM allows the enterprise account to assign IAM
	// resources, like access groups, trusted profiles, and account settings, to the child account. This is an optional
	// field.
	EnterpriseIamManaged *bool `json:"enterprise_iam_managed,omitempty"`
}

CreateAccountRequestTraits : The traits object can be used to set properties on child accounts of an enterprise. You can pass a field to opt-out of the default multi-factor authentication setting or enable enterprise-managed IAM when creating a child account in the enterprise. This is an optional field.

type CreateAccountResponse 

type CreateAccountResponse struct {
	// The ID of the account entity that was created.
	AccountID *string `json:"account_id,omitempty"`

	// The iam_service_id of the account entity that was created.
	IamServiceID *string `json:"iam_service_id,omitempty"`

	// The iam_apikey_id of the account entity that was created.
	IamApikeyID *string `json:"iam_apikey_id,omitempty"`

	// The iam_apikey of the account entity with owner iam policies that was created.
	IamApikey *string `json:"iam_apikey,omitempty"`
}

CreateAccountResponse : A newly-created account.

type CreateEnterpriseOptions 

type CreateEnterpriseOptions struct {
	// The ID of the account that is used to create the enterprise.
	SourceAccountID *string `json:"source_account_id" validate:"required"`

	// The name of the enterprise. This field must have 3 - 60 characters.
	Name *string `json:"name" validate:"required"`

	// The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist.
	PrimaryContactIamID *string `json:"primary_contact_iam_id" validate:"required"`

	// A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`.
	Domain *string `json:"domain,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateEnterpriseOptions : The CreateEnterprise options.

func (*CreateEnterpriseOptions) SetDomain 

func (_options *CreateEnterpriseOptions) SetDomain(domain string) *CreateEnterpriseOptions

SetDomain : Allow user to set Domain

func (*CreateEnterpriseOptions) SetHeaders 

func (options *CreateEnterpriseOptions) SetHeaders(param map[string]string) *CreateEnterpriseOptions

SetHeaders : Allow user to set Headers

func (*CreateEnterpriseOptions) SetName 

func (_options *CreateEnterpriseOptions) SetName(name string) *CreateEnterpriseOptions

SetName : Allow user to set Name

func (*CreateEnterpriseOptions) SetPrimaryContactIamID 

func (_options *CreateEnterpriseOptions) SetPrimaryContactIamID(primaryContactIamID string) *CreateEnterpriseOptions

SetPrimaryContactIamID : Allow user to set PrimaryContactIamID

func (*CreateEnterpriseOptions) SetSourceAccountID 

func (_options *CreateEnterpriseOptions) SetSourceAccountID(sourceAccountID string) *CreateEnterpriseOptions

SetSourceAccountID : Allow user to set SourceAccountID

type CreateEnterpriseResponse 

type CreateEnterpriseResponse struct {
	// The ID of the enterprise entity that was created. This entity is the root of the hierarchy.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The ID of the enterprise account that was created. The enterprise account is used to manage billing and access to
	// the enterprise management.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`
}

CreateEnterpriseResponse : The response from calling create enterprise.

type DeleteAccountGroupOptions added in v0.36.0 

type DeleteAccountGroupOptions struct {
	// The ID of the account group to retrieve.
	AccountGroupID *string `json:"account_group_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAccountGroupOptions : The DeleteAccountGroup options.

func (*DeleteAccountGroupOptions) SetAccountGroupID added in v0.36.0 

func (_options *DeleteAccountGroupOptions) SetAccountGroupID(accountGroupID string) *DeleteAccountGroupOptions

SetAccountGroupID : Allow user to set AccountGroupID

func (*DeleteAccountGroupOptions) SetHeaders added in v0.36.0 

func (options *DeleteAccountGroupOptions) SetHeaders(param map[string]string) *DeleteAccountGroupOptions

SetHeaders : Allow user to set Headers

type DeleteAccountOptions added in v0.36.0 

type DeleteAccountOptions struct {
	// The ID of the target account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAccountOptions : The DeleteAccount options.

func (*DeleteAccountOptions) SetAccountID added in v0.36.0 

func (_options *DeleteAccountOptions) SetAccountID(accountID string) *DeleteAccountOptions

SetAccountID : Allow user to set AccountID

func (*DeleteAccountOptions) SetHeaders added in v0.36.0 

func (options *DeleteAccountOptions) SetHeaders(param map[string]string) *DeleteAccountOptions

SetHeaders : Allow user to set Headers

type Enterprise 

type Enterprise struct {
	// The URL of the enterprise.
	URL *string `json:"url,omitempty"`

	// The enterprise ID.
	ID *string `json:"id,omitempty"`

	// The enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// The Cloud Resource Name (CRN) of the enterprise.
	CRN *string `json:"crn,omitempty"`

	// The name of the enterprise.
	Name *string `json:"name,omitempty"`

	// The domain of the enterprise.
	Domain *string `json:"domain,omitempty"`

	// The state of the enterprise.
	State *string `json:"state,omitempty"`

	// The IAM ID of the primary contact of the enterprise, such as `IBMid-0123ABC`.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// The email of the primary contact of the enterprise.
	PrimaryContactEmail *string `json:"primary_contact_email,omitempty"`

	// The ID of the account that is used to create the enterprise.
	SourceAccountID *string `json:"source_account_id,omitempty"`

	// The time stamp at which the enterprise was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The IAM ID of the user or service that created the enterprise.
	CreatedBy *string `json:"created_by,omitempty"`

	// The time stamp at which the enterprise was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The IAM ID of the user or service that updated the enterprise.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

Enterprise : An enterprise resource.

type EnterpriseManagementV1 

type EnterpriseManagementV1 struct {
	Service *core.BaseService
}

EnterpriseManagementV1 : The Enterprise Management API enables you to create and manage an enterprise, account groups, and accounts within the enterprise.

API Version: 1.0

func NewEnterpriseManagementV1 

func NewEnterpriseManagementV1(options *EnterpriseManagementV1Options) (service *EnterpriseManagementV1, err error)

NewEnterpriseManagementV1 : constructs an instance of EnterpriseManagementV1 with passed in options.

func NewEnterpriseManagementV1UsingExternalConfig 

func NewEnterpriseManagementV1UsingExternalConfig(options *EnterpriseManagementV1Options) (enterpriseManagement *EnterpriseManagementV1, err error)

NewEnterpriseManagementV1UsingExternalConfig : constructs an instance of EnterpriseManagementV1 with passed in options and external configuration.

func (*EnterpriseManagementV1) Clone added in v0.17.1 

func (enterpriseManagement *EnterpriseManagementV1) Clone() *EnterpriseManagementV1

Clone makes a copy of "enterpriseManagement" suitable for processing requests.

func (*EnterpriseManagementV1) CreateAccount 

func (enterpriseManagement *EnterpriseManagementV1) CreateAccount(createAccountOptions *CreateAccountOptions) (result *CreateAccountResponse, response *core.DetailedResponse, err error)

CreateAccount : Create a new account in an enterprise Create a new account as a part of an existing enterprise. The API creates an account entity under the parent that is specified in the payload of the request. The request also takes in the name and the owner of this new account. The owner must have a valid IBMid that's registered with IBM Cloud, but they don't need to be a user in the enterprise account.

func (*EnterpriseManagementV1) CreateAccountGroup 

func (enterpriseManagement *EnterpriseManagementV1) CreateAccountGroup(createAccountGroupOptions *CreateAccountGroupOptions) (result *CreateAccountGroupResponse, response *core.DetailedResponse, err error)

CreateAccountGroup : Create an account group Create a new account group, which can be used to group together multiple accounts. To create an account group, you must have an existing enterprise. The API creates an account group entity under the parent that is specified in the payload of the request. The request also takes in the name and the primary contact of this new account group.

func (*EnterpriseManagementV1) CreateAccountGroupWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) CreateAccountGroupWithContext(ctx context.Context, createAccountGroupOptions *CreateAccountGroupOptions) (result *CreateAccountGroupResponse, response *core.DetailedResponse, err error)

CreateAccountGroupWithContext is an alternate form of the CreateAccountGroup method which supports a Context parameter

func (*EnterpriseManagementV1) CreateAccountWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) CreateAccountWithContext(ctx context.Context, createAccountOptions *CreateAccountOptions) (result *CreateAccountResponse, response *core.DetailedResponse, err error)

CreateAccountWithContext is an alternate form of the CreateAccount method which supports a Context parameter

func (*EnterpriseManagementV1) CreateEnterprise 

func (enterpriseManagement *EnterpriseManagementV1) CreateEnterprise(createEnterpriseOptions *CreateEnterpriseOptions) (result *CreateEnterpriseResponse, response *core.DetailedResponse, err error)

CreateEnterprise : Create an enterprise Create a new enterprise, which you can use to centrally manage multiple accounts. To create an enterprise, you must have an active Subscription account. <br/><br/>The API creates an enterprise entity, which is the root of the enterprise hierarchy. It also creates a new enterprise account that is used to manage the enterprise. All subscriptions, support entitlements, credits, and discounts from the source subscription account are migrated to the enterprise account, and the source account becomes a child account in the hierarchy. The user that you assign as the enterprise primary contact is also assigned as the owner of the enterprise account.

func (*EnterpriseManagementV1) CreateEnterpriseWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) CreateEnterpriseWithContext(ctx context.Context, createEnterpriseOptions *CreateEnterpriseOptions) (result *CreateEnterpriseResponse, response *core.DetailedResponse, err error)

CreateEnterpriseWithContext is an alternate form of the CreateEnterprise method which supports a Context parameter

func (*EnterpriseManagementV1) DeleteAccount added in v0.36.0 

func (enterpriseManagement *EnterpriseManagementV1) DeleteAccount(deleteAccountOptions *DeleteAccountOptions) (response *core.DetailedResponse, err error)

DeleteAccount : Remove an account from its enterprise Remove an account from the enterprise its currently in. After an account is removed, it will be canceled and cannot be reactivated.

func (*EnterpriseManagementV1) DeleteAccountGroup added in v0.36.0 

func (enterpriseManagement *EnterpriseManagementV1) DeleteAccountGroup(deleteAccountGroupOptions *DeleteAccountGroupOptions) (response *core.DetailedResponse, err error)

DeleteAccountGroup : Delete an account group from the enterprise Delete an existing account group from the enterprise. You can't delete an account group that has child account groups, the delete request will fail. This API doesn't perform a recursive delete on the child account groups, it only deletes the current account group.

func (*EnterpriseManagementV1) DeleteAccountGroupWithContext added in v0.36.0 

func (enterpriseManagement *EnterpriseManagementV1) DeleteAccountGroupWithContext(ctx context.Context, deleteAccountGroupOptions *DeleteAccountGroupOptions) (response *core.DetailedResponse, err error)

DeleteAccountGroupWithContext is an alternate form of the DeleteAccountGroup method which supports a Context parameter

func (*EnterpriseManagementV1) DeleteAccountWithContext added in v0.36.0 

func (enterpriseManagement *EnterpriseManagementV1) DeleteAccountWithContext(ctx context.Context, deleteAccountOptions *DeleteAccountOptions) (response *core.DetailedResponse, err error)

DeleteAccountWithContext is an alternate form of the DeleteAccount method which supports a Context parameter

func (*EnterpriseManagementV1) DisableRetries added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*EnterpriseManagementV1) EnableRetries added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*EnterpriseManagementV1) GetAccount 

func (enterpriseManagement *EnterpriseManagementV1) GetAccount(getAccountOptions *GetAccountOptions) (result *Account, response *core.DetailedResponse, err error)

GetAccount : Get account by ID Retrieve an account by the `account_id` parameter. All data related to the account is returned only if the caller has access to retrieve the account.

func (*EnterpriseManagementV1) GetAccountGroup 

func (enterpriseManagement *EnterpriseManagementV1) GetAccountGroup(getAccountGroupOptions *GetAccountGroupOptions) (result *AccountGroup, response *core.DetailedResponse, err error)

GetAccountGroup : Get account group by ID Retrieve an account by the `account_group_id` parameter. All data related to the account group is returned only if the caller has access to retrieve the account group.

func (*EnterpriseManagementV1) GetAccountGroupWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) GetAccountGroupWithContext(ctx context.Context, getAccountGroupOptions *GetAccountGroupOptions) (result *AccountGroup, response *core.DetailedResponse, err error)

GetAccountGroupWithContext is an alternate form of the GetAccountGroup method which supports a Context parameter

func (*EnterpriseManagementV1) GetAccountWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) GetAccountWithContext(ctx context.Context, getAccountOptions *GetAccountOptions) (result *Account, response *core.DetailedResponse, err error)

GetAccountWithContext is an alternate form of the GetAccount method which supports a Context parameter

func (*EnterpriseManagementV1) GetEnableGzipCompression added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*EnterpriseManagementV1) GetEnterprise 

func (enterpriseManagement *EnterpriseManagementV1) GetEnterprise(getEnterpriseOptions *GetEnterpriseOptions) (result *Enterprise, response *core.DetailedResponse, err error)

GetEnterprise : Get enterprise by ID Retrieve an enterprise by the `enterprise_id` parameter. All data related to the enterprise is returned only if the caller has access to retrieve the enterprise.

func (*EnterpriseManagementV1) GetEnterpriseWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) GetEnterpriseWithContext(ctx context.Context, getEnterpriseOptions *GetEnterpriseOptions) (result *Enterprise, response *core.DetailedResponse, err error)

GetEnterpriseWithContext is an alternate form of the GetEnterprise method which supports a Context parameter

func (*EnterpriseManagementV1) GetServiceURL added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*EnterpriseManagementV1) ImportAccountToEnterprise 

func (enterpriseManagement *EnterpriseManagementV1) ImportAccountToEnterprise(importAccountToEnterpriseOptions *ImportAccountToEnterpriseOptions) (response *core.DetailedResponse, err error)

ImportAccountToEnterprise : Import an account into an enterprise Import an existing stand-alone account into an enterprise. The existing account can be any type: trial (`TRIAL`), Lite (`STANDARD`), Pay-As-You-Go (`PAYG`), or Subscription (`SUBSCRIPTION`). In the case of a `SUBSCRIPTION` account, the credits, promotional offers, and discounts are migrated to the billing unit of the enterprise. For a billable account (`PAYG` or `SUBSCRIPTION`), the country and currency code of the existing account and the billing unit of the enterprise must match. The API returns a `202` response and performs asynchronous operations to import the account into the enterprise. <br/></br>For more information about impacts to the account, see [Adding accounts to an enterprise](https://{DomainName}/docs/account?topic=account-enterprise-add).

func (*EnterpriseManagementV1) ImportAccountToEnterpriseWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) ImportAccountToEnterpriseWithContext(ctx context.Context, importAccountToEnterpriseOptions *ImportAccountToEnterpriseOptions) (response *core.DetailedResponse, err error)

ImportAccountToEnterpriseWithContext is an alternate form of the ImportAccountToEnterprise method which supports a Context parameter

func (*EnterpriseManagementV1) ListAccountGroups 

func (enterpriseManagement *EnterpriseManagementV1) ListAccountGroups(listAccountGroupsOptions *ListAccountGroupsOptions) (result *ListAccountGroupsResponse, response *core.DetailedResponse, err error)

ListAccountGroups : List account groups Retrieve all account groups based on the values that are passed in the query parameters. If no query parameter is passed, all of the account groups in the enterprise for which the calling identity has access are returned. <br/><br/>You can use pagination parameters to filter the results. The `limit` field can be used to limit the number of results that are displayed for this method.<br/><br/>This method ensures that only the account groups that the user has access to are returned. Access can be controlled either through a policy on a specific account group, or account-level platform services access roles, such as Administrator, Editor, Operator, or Viewer. When you call the method with the `enterprise_id`, `parent_account_group_id` or `parent` query parameter, all of the account groups that are immediate children of this entity are returned. Authentication is performed on all account groups before they are returned to the user to ensure that only those account groups are returned to which the calling identity has access.

func (*EnterpriseManagementV1) ListAccountGroupsWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) ListAccountGroupsWithContext(ctx context.Context, listAccountGroupsOptions *ListAccountGroupsOptions) (result *ListAccountGroupsResponse, response *core.DetailedResponse, err error)

ListAccountGroupsWithContext is an alternate form of the ListAccountGroups method which supports a Context parameter

func (*EnterpriseManagementV1) ListAccounts 

func (enterpriseManagement *EnterpriseManagementV1) ListAccounts(listAccountsOptions *ListAccountsOptions) (result *ListAccountsResponse, response *core.DetailedResponse, err error)

ListAccounts : List accounts Retrieve all accounts based on the values that are passed in the query parameters. If no query parameter is passed, all of the accounts in the enterprise for which the calling identity has access are returned. <br/><br/>You can use pagination parameters to filter the results. The `limit` field can be used to limit the number of results that are displayed for this method.<br/><br/>This method ensures that only the accounts that the user has access to are returned. Access can be controlled either through a policy on a specific account, or account-level platform services access roles, such as Administrator, Editor, Operator, or Viewer. When you call the method with the `enterprise_id`, `account_group_id` or `parent` query parameter, all of the accounts that are immediate children of this entity are returned. Authentication is performed on all the accounts before they are returned to the user to ensure that only those accounts are returned to which the calling identity has access to.

func (*EnterpriseManagementV1) ListAccountsWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) ListAccountsWithContext(ctx context.Context, listAccountsOptions *ListAccountsOptions) (result *ListAccountsResponse, response *core.DetailedResponse, err error)

ListAccountsWithContext is an alternate form of the ListAccounts method which supports a Context parameter

func (*EnterpriseManagementV1) ListEnterprises 

func (enterpriseManagement *EnterpriseManagementV1) ListEnterprises(listEnterprisesOptions *ListEnterprisesOptions) (result *ListEnterprisesResponse, response *core.DetailedResponse, err error)

ListEnterprises : List enterprises Retrieve all enterprises for a given ID by passing the IDs on query parameters. If no ID is passed, the enterprises for which the calling identity is the primary contact are returned. You can use pagination parameters to filter the results. <br/><br/>This method ensures that only the enterprises that the user has access to are returned. Access can be controlled either through a policy on a specific enterprise, or account-level platform services access roles, such as Administrator, Editor, Operator, or Viewer. When you call the method with the `enterprise_account_id` or `account_id` query parameter, the account ID in the token is compared with that in the query parameter. If these account IDs match, authentication isn't performed and the enterprise information is returned. If the account IDs don't match, authentication is performed and only then is the enterprise information returned in the response.

func (*EnterpriseManagementV1) ListEnterprisesWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) ListEnterprisesWithContext(ctx context.Context, listEnterprisesOptions *ListEnterprisesOptions) (result *ListEnterprisesResponse, response *core.DetailedResponse, err error)

ListEnterprisesWithContext is an alternate form of the ListEnterprises method which supports a Context parameter

func (*EnterpriseManagementV1) NewAccountGroupsPager added in v0.29.4 

func (enterpriseManagement *EnterpriseManagementV1) NewAccountGroupsPager(options *ListAccountGroupsOptions) (pager *AccountGroupsPager, err error)

NewAccountGroupsPager returns a new AccountGroupsPager instance.

func (*EnterpriseManagementV1) NewAccountsPager added in v0.29.4 

func (enterpriseManagement *EnterpriseManagementV1) NewAccountsPager(options *ListAccountsOptions) (pager *AccountsPager, err error)

NewAccountsPager returns a new AccountsPager instance.

func (*EnterpriseManagementV1) NewCreateAccountGroupOptions 

func (*EnterpriseManagementV1) NewCreateAccountGroupOptions(parent string, name string, primaryContactIamID string) *CreateAccountGroupOptions

NewCreateAccountGroupOptions : Instantiate CreateAccountGroupOptions

func (*EnterpriseManagementV1) NewCreateAccountOptions 

func (*EnterpriseManagementV1) NewCreateAccountOptions(parent string, name string, ownerIamID string) *CreateAccountOptions

NewCreateAccountOptions : Instantiate CreateAccountOptions

func (*EnterpriseManagementV1) NewCreateEnterpriseOptions 

func (*EnterpriseManagementV1) NewCreateEnterpriseOptions(sourceAccountID string, name string, primaryContactIamID string) *CreateEnterpriseOptions

NewCreateEnterpriseOptions : Instantiate CreateEnterpriseOptions

func (*EnterpriseManagementV1) NewDeleteAccountGroupOptions added in v0.36.0 

func (*EnterpriseManagementV1) NewDeleteAccountGroupOptions(accountGroupID string) *DeleteAccountGroupOptions

NewDeleteAccountGroupOptions : Instantiate DeleteAccountGroupOptions

func (*EnterpriseManagementV1) NewDeleteAccountOptions added in v0.36.0 

func (*EnterpriseManagementV1) NewDeleteAccountOptions(accountID string) *DeleteAccountOptions

NewDeleteAccountOptions : Instantiate DeleteAccountOptions

func (*EnterpriseManagementV1) NewEnterprisesPager added in v0.29.4 

func (enterpriseManagement *EnterpriseManagementV1) NewEnterprisesPager(options *ListEnterprisesOptions) (pager *EnterprisesPager, err error)

NewEnterprisesPager returns a new EnterprisesPager instance.

func (*EnterpriseManagementV1) NewGetAccountGroupOptions 

func (*EnterpriseManagementV1) NewGetAccountGroupOptions(accountGroupID string) *GetAccountGroupOptions

NewGetAccountGroupOptions : Instantiate GetAccountGroupOptions

func (*EnterpriseManagementV1) NewGetAccountOptions 

func (*EnterpriseManagementV1) NewGetAccountOptions(accountID string) *GetAccountOptions

NewGetAccountOptions : Instantiate GetAccountOptions

func (*EnterpriseManagementV1) NewGetEnterpriseOptions 

func (*EnterpriseManagementV1) NewGetEnterpriseOptions(enterpriseID string) *GetEnterpriseOptions

NewGetEnterpriseOptions : Instantiate GetEnterpriseOptions

func (*EnterpriseManagementV1) NewImportAccountToEnterpriseOptions 

func (*EnterpriseManagementV1) NewImportAccountToEnterpriseOptions(enterpriseID string, accountID string) *ImportAccountToEnterpriseOptions

NewImportAccountToEnterpriseOptions : Instantiate ImportAccountToEnterpriseOptions

func (*EnterpriseManagementV1) NewListAccountGroupsOptions 

func (*EnterpriseManagementV1) NewListAccountGroupsOptions() *ListAccountGroupsOptions

NewListAccountGroupsOptions : Instantiate ListAccountGroupsOptions

func (*EnterpriseManagementV1) NewListAccountsOptions 

func (*EnterpriseManagementV1) NewListAccountsOptions() *ListAccountsOptions

NewListAccountsOptions : Instantiate ListAccountsOptions

func (*EnterpriseManagementV1) NewListEnterprisesOptions 

func (*EnterpriseManagementV1) NewListEnterprisesOptions() *ListEnterprisesOptions

NewListEnterprisesOptions : Instantiate ListEnterprisesOptions

func (*EnterpriseManagementV1) NewUpdateAccountGroupOptions 

func (*EnterpriseManagementV1) NewUpdateAccountGroupOptions(accountGroupID string) *UpdateAccountGroupOptions

NewUpdateAccountGroupOptions : Instantiate UpdateAccountGroupOptions

func (*EnterpriseManagementV1) NewUpdateAccountOptions 

func (*EnterpriseManagementV1) NewUpdateAccountOptions(accountID string, parent string) *UpdateAccountOptions

NewUpdateAccountOptions : Instantiate UpdateAccountOptions

func (*EnterpriseManagementV1) NewUpdateEnterpriseOptions 

func (*EnterpriseManagementV1) NewUpdateEnterpriseOptions(enterpriseID string) *UpdateEnterpriseOptions

NewUpdateEnterpriseOptions : Instantiate UpdateEnterpriseOptions

func (*EnterpriseManagementV1) SetDefaultHeaders added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*EnterpriseManagementV1) SetEnableGzipCompression added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*EnterpriseManagementV1) SetServiceURL 

func (enterpriseManagement *EnterpriseManagementV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*EnterpriseManagementV1) UpdateAccount 

func (enterpriseManagement *EnterpriseManagementV1) UpdateAccount(updateAccountOptions *UpdateAccountOptions) (response *core.DetailedResponse, err error)

UpdateAccount : Move an account within the enterprise Move an account to a different parent within the same enterprise.

func (*EnterpriseManagementV1) UpdateAccountGroup 

func (enterpriseManagement *EnterpriseManagementV1) UpdateAccountGroup(updateAccountGroupOptions *UpdateAccountGroupOptions) (response *core.DetailedResponse, err error)

UpdateAccountGroup : Update an account group Update the name or IAM ID of the primary contact for an existing account group. The new primary contact must already be a user in the enterprise account.

func (*EnterpriseManagementV1) UpdateAccountGroupWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) UpdateAccountGroupWithContext(ctx context.Context, updateAccountGroupOptions *UpdateAccountGroupOptions) (response *core.DetailedResponse, err error)

UpdateAccountGroupWithContext is an alternate form of the UpdateAccountGroup method which supports a Context parameter

func (*EnterpriseManagementV1) UpdateAccountWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) UpdateAccountWithContext(ctx context.Context, updateAccountOptions *UpdateAccountOptions) (response *core.DetailedResponse, err error)

UpdateAccountWithContext is an alternate form of the UpdateAccount method which supports a Context parameter

func (*EnterpriseManagementV1) UpdateEnterprise 

func (enterpriseManagement *EnterpriseManagementV1) UpdateEnterprise(updateEnterpriseOptions *UpdateEnterpriseOptions) (response *core.DetailedResponse, err error)

UpdateEnterprise : Update an enterprise Update the name, domain, or IAM ID of the primary contact for an existing enterprise. The new primary contact must already be a user in the enterprise account.

func (*EnterpriseManagementV1) UpdateEnterpriseWithContext added in v0.12.2 

func (enterpriseManagement *EnterpriseManagementV1) UpdateEnterpriseWithContext(ctx context.Context, updateEnterpriseOptions *UpdateEnterpriseOptions) (response *core.DetailedResponse, err error)

UpdateEnterpriseWithContext is an alternate form of the UpdateEnterprise method which supports a Context parameter

type EnterpriseManagementV1Options 

type EnterpriseManagementV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

EnterpriseManagementV1Options : Service options

type EnterprisesPager added in v0.29.4 

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

EnterprisesPager can be used to simplify the use of the "ListEnterprises" method.

func (*EnterprisesPager) GetAll added in v0.29.4 

func (pager *EnterprisesPager) GetAll() (allItems []Enterprise, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*EnterprisesPager) GetAllWithContext added in v0.29.4 

func (pager *EnterprisesPager) GetAllWithContext(ctx context.Context) (allItems []Enterprise, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*EnterprisesPager) GetNext added in v0.29.4 

func (pager *EnterprisesPager) GetNext() (page []Enterprise, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*EnterprisesPager) GetNextWithContext added in v0.29.4 

func (pager *EnterprisesPager) GetNextWithContext(ctx context.Context) (page []Enterprise, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*EnterprisesPager) HasNext added in v0.29.4 

func (pager *EnterprisesPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type GetAccountGroupOptions 

type GetAccountGroupOptions struct {
	// The ID of the account group to retrieve.
	AccountGroupID *string `json:"account_group_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAccountGroupOptions : The GetAccountGroup options.

func (*GetAccountGroupOptions) SetAccountGroupID 

func (_options *GetAccountGroupOptions) SetAccountGroupID(accountGroupID string) *GetAccountGroupOptions

SetAccountGroupID : Allow user to set AccountGroupID

func (*GetAccountGroupOptions) SetHeaders 

func (options *GetAccountGroupOptions) SetHeaders(param map[string]string) *GetAccountGroupOptions

SetHeaders : Allow user to set Headers

type GetAccountOptions 

type GetAccountOptions struct {
	// The ID of the target account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAccountOptions : The GetAccount options.

func (*GetAccountOptions) SetAccountID 

func (_options *GetAccountOptions) SetAccountID(accountID string) *GetAccountOptions

SetAccountID : Allow user to set AccountID

func (*GetAccountOptions) SetHeaders 

func (options *GetAccountOptions) SetHeaders(param map[string]string) *GetAccountOptions

SetHeaders : Allow user to set Headers

type GetEnterpriseOptions 

type GetEnterpriseOptions struct {
	// The ID of the enterprise to retrieve.
	EnterpriseID *string `json:"enterprise_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetEnterpriseOptions : The GetEnterprise options.

func (*GetEnterpriseOptions) SetEnterpriseID 

func (_options *GetEnterpriseOptions) SetEnterpriseID(enterpriseID string) *GetEnterpriseOptions

SetEnterpriseID : Allow user to set EnterpriseID

func (*GetEnterpriseOptions) SetHeaders 

func (options *GetEnterpriseOptions) SetHeaders(param map[string]string) *GetEnterpriseOptions

SetHeaders : Allow user to set Headers

type ImportAccountToEnterpriseOptions 

type ImportAccountToEnterpriseOptions struct {
	// The ID of the enterprise to import the stand-alone account into.
	EnterpriseID *string `json:"enterprise_id" validate:"required,ne="`

	// The ID of the existing stand-alone account to be imported.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The CRN of the expected parent of the imported account. The parent is the enterprise or account group that the
	// account is added to.
	Parent *string `json:"parent,omitempty"`

	// The ID of the [billing unit](/apidocs/enterprise-apis/billing-unit) to use for billing this account in the
	// enterprise.
	BillingUnitID *string `json:"billing_unit_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ImportAccountToEnterpriseOptions : The ImportAccountToEnterprise options.

func (*ImportAccountToEnterpriseOptions) SetAccountID 

func (_options *ImportAccountToEnterpriseOptions) SetAccountID(accountID string) *ImportAccountToEnterpriseOptions

SetAccountID : Allow user to set AccountID

func (*ImportAccountToEnterpriseOptions) SetBillingUnitID 

func (_options *ImportAccountToEnterpriseOptions) SetBillingUnitID(billingUnitID string) *ImportAccountToEnterpriseOptions

SetBillingUnitID : Allow user to set BillingUnitID

func (*ImportAccountToEnterpriseOptions) SetEnterpriseID 

func (_options *ImportAccountToEnterpriseOptions) SetEnterpriseID(enterpriseID string) *ImportAccountToEnterpriseOptions

SetEnterpriseID : Allow user to set EnterpriseID

func (*ImportAccountToEnterpriseOptions) SetHeaders 

func (options *ImportAccountToEnterpriseOptions) SetHeaders(param map[string]string) *ImportAccountToEnterpriseOptions

SetHeaders : Allow user to set Headers

func (*ImportAccountToEnterpriseOptions) SetParent 

func (_options *ImportAccountToEnterpriseOptions) SetParent(parent string) *ImportAccountToEnterpriseOptions

SetParent : Allow user to set Parent

type ListAccountGroupsOptions 

type ListAccountGroupsOptions struct {
	// Get account groups that are either immediate children or are a part of the hierarchy for a given enterprise ID.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// Get account groups that are either immediate children or are a part of the hierarchy for a given account group ID.
	ParentAccountGroupID *string `json:"parent_account_group_id,omitempty"`

	// The first item to be returned in the page of results. This value can be obtained from the next_url property from the
	// previous call of the operation. If not specified, then the first page of results is returned.
	NextDocid *string `json:"next_docid,omitempty"`

	// Get account groups that are either immediate children or are a part of the hierarchy for a given parent CRN.
	Parent *string `json:"parent,omitempty"`

	// Return results up to this limit. Valid values are between `0` and `100`.
	Limit *int64 `json:"limit,omitempty"`

	// Include the deleted account groups from an enterprise when used in conjunction with other query parameters.
	IncludeDeleted *bool `json:"include_deleted,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAccountGroupsOptions : The ListAccountGroups options.

func (*ListAccountGroupsOptions) SetEnterpriseID 

func (_options *ListAccountGroupsOptions) SetEnterpriseID(enterpriseID string) *ListAccountGroupsOptions

SetEnterpriseID : Allow user to set EnterpriseID

func (*ListAccountGroupsOptions) SetHeaders 

func (options *ListAccountGroupsOptions) SetHeaders(param map[string]string) *ListAccountGroupsOptions

SetHeaders : Allow user to set Headers

func (*ListAccountGroupsOptions) SetIncludeDeleted added in v0.36.0 

func (_options *ListAccountGroupsOptions) SetIncludeDeleted(includeDeleted bool) *ListAccountGroupsOptions

SetIncludeDeleted : Allow user to set IncludeDeleted

func (*ListAccountGroupsOptions) SetLimit 

func (_options *ListAccountGroupsOptions) SetLimit(limit int64) *ListAccountGroupsOptions

SetLimit : Allow user to set Limit

func (*ListAccountGroupsOptions) SetNextDocid added in v0.18.6 

func (_options *ListAccountGroupsOptions) SetNextDocid(nextDocid string) *ListAccountGroupsOptions

SetNextDocid : Allow user to set NextDocid

func (*ListAccountGroupsOptions) SetParent 

func (_options *ListAccountGroupsOptions) SetParent(parent string) *ListAccountGroupsOptions

SetParent : Allow user to set Parent

func (*ListAccountGroupsOptions) SetParentAccountGroupID 

func (_options *ListAccountGroupsOptions) SetParentAccountGroupID(parentAccountGroupID string) *ListAccountGroupsOptions

SetParentAccountGroupID : Allow user to set ParentAccountGroupID

type ListAccountGroupsResponse 

type ListAccountGroupsResponse struct {
	// The number of enterprises returned from calling list account groups.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// A string that represents the link to the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// A list of account groups.
	Resources []AccountGroup `json:"resources,omitempty"`
}

ListAccountGroupsResponse : The list_account_groups operation response.

func (*ListAccountGroupsResponse) GetNextNextDocid added in v0.29.4 

func (resp *ListAccountGroupsResponse) GetNextNextDocid() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ListAccountsOptions 

type ListAccountsOptions struct {
	// Get accounts that are either immediate children or are a part of the hierarchy for a given enterprise ID.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// Get accounts that are either immediate children or are a part of the hierarchy for a given account group ID.
	AccountGroupID *string `json:"account_group_id,omitempty"`

	// The first item to be returned in the page of results. This value can be obtained from the next_url property from the
	// previous call of the operation. If not specified, then the first page of results is returned.
	NextDocid *string `json:"next_docid,omitempty"`

	// Get accounts that are either immediate children or are a part of the hierarchy for a given parent CRN.
	Parent *string `json:"parent,omitempty"`

	// Return results up to this limit. Valid values are between `0` and `100`.
	Limit *int64 `json:"limit,omitempty"`

	// Include the deleted accounts from an enterprise when used in conjunction with enterprise_id.
	IncludeDeleted *bool `json:"include_deleted,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAccountsOptions : The ListAccounts options.

func (*ListAccountsOptions) SetAccountGroupID 

func (_options *ListAccountsOptions) SetAccountGroupID(accountGroupID string) *ListAccountsOptions

SetAccountGroupID : Allow user to set AccountGroupID

func (*ListAccountsOptions) SetEnterpriseID 

func (_options *ListAccountsOptions) SetEnterpriseID(enterpriseID string) *ListAccountsOptions

SetEnterpriseID : Allow user to set EnterpriseID

func (*ListAccountsOptions) SetHeaders 

func (options *ListAccountsOptions) SetHeaders(param map[string]string) *ListAccountsOptions

SetHeaders : Allow user to set Headers

func (*ListAccountsOptions) SetIncludeDeleted added in v0.36.0 

func (_options *ListAccountsOptions) SetIncludeDeleted(includeDeleted bool) *ListAccountsOptions

SetIncludeDeleted : Allow user to set IncludeDeleted

func (*ListAccountsOptions) SetLimit 

func (_options *ListAccountsOptions) SetLimit(limit int64) *ListAccountsOptions

SetLimit : Allow user to set Limit

func (*ListAccountsOptions) SetNextDocid added in v0.18.6 

func (_options *ListAccountsOptions) SetNextDocid(nextDocid string) *ListAccountsOptions

SetNextDocid : Allow user to set NextDocid

func (*ListAccountsOptions) SetParent 

func (_options *ListAccountsOptions) SetParent(parent string) *ListAccountsOptions

SetParent : Allow user to set Parent

type ListAccountsResponse 

type ListAccountsResponse struct {
	// The number of enterprises returned from calling list accounts.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// A string that represents the link to the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// A list of accounts.
	Resources []Account `json:"resources,omitempty"`
}

ListAccountsResponse : The list_accounts operation response.

func (*ListAccountsResponse) GetNextNextDocid added in v0.29.4 

func (resp *ListAccountsResponse) GetNextNextDocid() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ListEnterprisesOptions 

type ListEnterprisesOptions struct {
	// Get enterprises for a given enterprise account ID.
	EnterpriseAccountID *string `json:"enterprise_account_id,omitempty"`

	// Get enterprises for a given account group ID.
	AccountGroupID *string `json:"account_group_id,omitempty"`

	// Get enterprises for a given account ID.
	AccountID *string `json:"account_id,omitempty"`

	// The first item to be returned in the page of results. This value can be obtained from the next_url property from the
	// previous call of the operation. If not specified, then the first page of results is returned.
	NextDocid *string `json:"next_docid,omitempty"`

	// Return results up to this limit. Valid values are between `0` and `100`.
	Limit *int64 `json:"limit,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListEnterprisesOptions : The ListEnterprises options.

func (*ListEnterprisesOptions) SetAccountGroupID 

func (_options *ListEnterprisesOptions) SetAccountGroupID(accountGroupID string) *ListEnterprisesOptions

SetAccountGroupID : Allow user to set AccountGroupID

func (*ListEnterprisesOptions) SetAccountID 

func (_options *ListEnterprisesOptions) SetAccountID(accountID string) *ListEnterprisesOptions

SetAccountID : Allow user to set AccountID

func (*ListEnterprisesOptions) SetEnterpriseAccountID 

func (_options *ListEnterprisesOptions) SetEnterpriseAccountID(enterpriseAccountID string) *ListEnterprisesOptions

SetEnterpriseAccountID : Allow user to set EnterpriseAccountID

func (*ListEnterprisesOptions) SetHeaders 

func (options *ListEnterprisesOptions) SetHeaders(param map[string]string) *ListEnterprisesOptions

SetHeaders : Allow user to set Headers

func (*ListEnterprisesOptions) SetLimit 

func (_options *ListEnterprisesOptions) SetLimit(limit int64) *ListEnterprisesOptions

SetLimit : Allow user to set Limit

func (*ListEnterprisesOptions) SetNextDocid added in v0.18.6 

func (_options *ListEnterprisesOptions) SetNextDocid(nextDocid string) *ListEnterprisesOptions

SetNextDocid : Allow user to set NextDocid

type ListEnterprisesResponse 

type ListEnterprisesResponse struct {
	// The number of enterprises returned from calling list enterprise.
	RowsCount *int64 `json:"rows_count,omitempty"`

	// A string that represents the link to the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// A list of enterprise objects.
	Resources []Enterprise `json:"resources,omitempty"`
}

ListEnterprisesResponse : The response from calling list enterprises.

func (*ListEnterprisesResponse) GetNextNextDocid added in v0.29.4 

func (resp *ListEnterprisesResponse) GetNextNextDocid() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type UpdateAccountGroupOptions 

type UpdateAccountGroupOptions struct {
	// The ID of the account group to retrieve.
	AccountGroupID *string `json:"account_group_id" validate:"required,ne="`

	// The new name of the account group. This field must have 3 - 60 characters.
	Name *string `json:"name,omitempty"`

	// The IAM ID of the user to be the new primary contact for the account group.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateAccountGroupOptions : The UpdateAccountGroup options.

func (*UpdateAccountGroupOptions) SetAccountGroupID 

func (_options *UpdateAccountGroupOptions) SetAccountGroupID(accountGroupID string) *UpdateAccountGroupOptions

SetAccountGroupID : Allow user to set AccountGroupID

func (*UpdateAccountGroupOptions) SetHeaders 

func (options *UpdateAccountGroupOptions) SetHeaders(param map[string]string) *UpdateAccountGroupOptions

SetHeaders : Allow user to set Headers

func (*UpdateAccountGroupOptions) SetName 

func (_options *UpdateAccountGroupOptions) SetName(name string) *UpdateAccountGroupOptions

SetName : Allow user to set Name

func (*UpdateAccountGroupOptions) SetPrimaryContactIamID 

func (_options *UpdateAccountGroupOptions) SetPrimaryContactIamID(primaryContactIamID string) *UpdateAccountGroupOptions

SetPrimaryContactIamID : Allow user to set PrimaryContactIamID

type UpdateAccountOptions 

type UpdateAccountOptions struct {
	// The ID of the target account.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The CRN of the new parent within the enterprise.
	Parent *string `json:"parent" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateAccountOptions : The UpdateAccount options.

func (*UpdateAccountOptions) SetAccountID 

func (_options *UpdateAccountOptions) SetAccountID(accountID string) *UpdateAccountOptions

SetAccountID : Allow user to set AccountID

func (*UpdateAccountOptions) SetHeaders 

func (options *UpdateAccountOptions) SetHeaders(param map[string]string) *UpdateAccountOptions

SetHeaders : Allow user to set Headers

func (*UpdateAccountOptions) SetParent 

func (_options *UpdateAccountOptions) SetParent(parent string) *UpdateAccountOptions

SetParent : Allow user to set Parent

type UpdateEnterpriseOptions 

type UpdateEnterpriseOptions struct {
	// The ID of the enterprise to retrieve.
	EnterpriseID *string `json:"enterprise_id" validate:"required,ne="`

	// The new name of the enterprise. This field must have 3 - 60 characters.
	Name *string `json:"name,omitempty"`

	// The new domain of the enterprise. This field has a limit of 60 characters.
	Domain *string `json:"domain,omitempty"`

	// The IAM ID of the user to be the new primary contact for the enterprise.
	PrimaryContactIamID *string `json:"primary_contact_iam_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateEnterpriseOptions : The UpdateEnterprise options.

func (*UpdateEnterpriseOptions) SetDomain 

func (_options *UpdateEnterpriseOptions) SetDomain(domain string) *UpdateEnterpriseOptions

SetDomain : Allow user to set Domain

func (*UpdateEnterpriseOptions) SetEnterpriseID 

func (_options *UpdateEnterpriseOptions) SetEnterpriseID(enterpriseID string) *UpdateEnterpriseOptions

SetEnterpriseID : Allow user to set EnterpriseID

func (*UpdateEnterpriseOptions) SetHeaders 

func (options *UpdateEnterpriseOptions) SetHeaders(param map[string]string) *UpdateEnterpriseOptions

SetHeaders : Allow user to set Headers

func (*UpdateEnterpriseOptions) SetName 

func (_options *UpdateEnterpriseOptions) SetName(name string) *UpdateEnterpriseOptions

SetName : Allow user to set Name

func (*UpdateEnterpriseOptions) SetPrimaryContactIamID 

func (_options *UpdateEnterpriseOptions) SetPrimaryContactIamID(primaryContactIamID string) *UpdateEnterpriseOptions

SetPrimaryContactIamID : Allow user to set PrimaryContactIamID

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.