cis

package

v1.7.0 Latest Latest Go to latest Published: Sep 25, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SAP/terraform-provider-btp

Links

Open Source Insights

Documentation ¶

Overview ¶

* Entitlements Service * * The Entitlements service provides REST APIs that manage the assignments of entitlements and quotas to subaccounts and directories. Entitlements and their quota are automatically assigned to the global account when a customer order is fulfilled. Use the APIs in this service to manage the distribution of this global quota to your directories and subaccounts. NOTE: These APIs are relevant only for cloud management tools feature set B. For details and information about whether this applies to your global account, see [Cloud Management Tools - Feature Set Overview](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/caf4e4e23aef4666ad8f125af393dfb2.html). See also: * [Authorization](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/3670474a58c24ac2b082e76cbbd9dc19.html) * [Rate Limiting](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/77b217b3f57a45b987eb7fbc3305ce1e.html) * [Error Response Format](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/77fef2fb104b4b1795e2e6cee790e8b8.html) * [Asynchronous Jobs](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/0a0a6ab0ad114d72a6611c1c6b21683e.html) * * API version: 1.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Accounts Service * * The Accounts service provides REST APIs that are responsible for the management of global accounts, and the creation and management of directories, subaccounts, and their custom properties/tags. Global accounts represent a business entity and contain contract information, including customer details and purchased entitlements. The global account is the context for billing each customer. Use the subaccount APIs to structure your global account according to your organization's and project's requirements regarding members, authorizations, and quotas. This service also provides you with APIs for creating and managing directories. While the use of directories is optional, they allow you to further organize and manage your subaccounts according to your specific technical and business needs. The service also lets you manage the custom properties/tags that you associate with your directories and subaccounts. NOTE: These APIs are relevant only for cloud management tools feature set B. For details and information about whether this applies to your global account, see [Cloud Management Tools - Feature Set Overview](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/caf4e4e23aef4666ad8f125af393dfb2.html). See also: * [Authorization](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/3670474a58c24ac2b082e76cbbd9dc19.html) * [Rate Limiting](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/77b217b3f57a45b987eb7fbc3305ce1e.html) * [Error Response Format](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/77fef2fb104b4b1795e2e6cee790e8b8.html) * [Asynchronous Jobs](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/latest/en-US/0a0a6ab0ad114d72a6611c1c6b21683e.html) * * API version: 1.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Constants
type DataCenterResponseCollection
type DataCenterResponseObject
type DirectoryResponseObject
type GlobalAccountResponseObject
type LabelsResponseObject
type PropertyResponseObject
type ResponseCollectionSubaccountResponseObject
type ServiceManagementBindingResponseObject
type SubaccountResponseObject
type Time
- func (t *Time) Time() time.Time
- func (t *Time) UnmarshalJSON(b []byte) (err error)

Constants ¶

View Source

const (
	// The CRUD operation or series of operations completed successfully.
	StateOK                          string = "OK"
	StateCanceled                    string = "CANCELED"
	StateCreating                    string = "CREATING"
	StateCreationFailed              string = "CREATION_FAILED"
	StateDeleting                    string = "DELETING"
	StateDeletionFailed              string = "DELETION_FAILED"
	StateMigrating                   string = "MIGRATING"
	StateMigrationFailed             string = "MIGRATION_FAILED"
	StateMigrated                    string = "MIGRATED"
	StateMoveFailed                  string = "MOVE_FAILED"
	StateMoveToOtherGaFailed         string = "MOVE_TO_OTHER_GA_FAILED"
	StateMoving                      string = "MOVING"
	StateMovingToOtherGa             string = "MOVING_TO_OTHER_GA"
	StatePendingReview               string = "PENDING_REVIEW"
	StateProcessing                  string = "PROCESSING"
	StateProcessingFailed            string = "PROCESSING_FAILED"
	StateRollbackMigrationProcessing string = "ROLLBACK_MIGRATION_PROCESSING"
	StateStarted                     string = "STARTED"
	StateSuspensionFailed            string = "SUSPENSION_FAILED"
	StateUpdateAccountTypeFailed     string = "UPDATE_ACCOUNT_TYPE_FAILED"
	StateUpdateDirectoryTypeFailed   string = "UPDATE_DIRECTORY_TYPE_FAILED"
	StateUpdateFailed                string = "UPDATE_FAILED"
	StateUpdating                    string = "UPDATING"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DataCenterResponseCollection ¶

type DataCenterResponseCollection struct {
	// Contains information about the available data centers for a specified global account.
	Datacenters []DataCenterResponseObject `json:"datacenters,omitempty"`
}

type DataCenterResponseObject ¶

type DataCenterResponseObject struct {
	// Descriptive name of the data center for customer-facing UIs.
	DisplayName string `json:"displayName,omitempty"`
	// The domain of the data center
	Domain string `json:"domain,omitempty"`
	// The environment that the data center supports. For example: Kubernetes, Cloud Foundry.
	Environment string `json:"environment,omitempty"`
	// The infrastructure provider for the data center. Valid values: * <b>AWS:</b> Amazon Web Services. * <b>GCP:</b> Google Cloud Platform. * <b>AZURE:</b> Microsoft Azure. * <b>SAP:</b> SAP BTP (Neo). * <b>ALI:</b> Alibaba Cloud. * <b>IBM:</b> IBM Cloud.
	IaasProvider string `json:"iaasProvider,omitempty"`
	// Technical name of the data center. Must be unique within the cloud deployment.
	Name string `json:"name,omitempty"`
	// Provisioning service URL.
	ProvisioningServiceUrl string `json:"provisioningServiceUrl,omitempty"`
	// The region in which the data center is located.
	Region string `json:"region,omitempty"`
	// Saas-Registry service URL.
	SaasRegistryServiceUrl string `json:"saasRegistryServiceUrl,omitempty"`
	// Whether the specified datacenter supports trial accounts.
	SupportsTrial bool `json:"supportsTrial,omitempty"`
}

type DirectoryResponseObject ¶

type DirectoryResponseObject struct {
	// The response object containing information about the directories.
	Children []DirectoryResponseObject `json:"children,omitempty"`
	// The status of the customer contract and its associated root global account. * <b>ACTIVE:</b> The customer contract and its associated global account is currently active. * <b>PENDING_TERMINATION:</b> A termination process has been triggered for a customer contract (the customer contract has expired, or a customer has given notification that they wish to terminate their contract), and the global account is currently in the validation period. The customer can still access their global account until the end of the validation period. * <b>SUSPENDED:</b> For enterprise accounts, specifies that the customer's global account is currently in the grace period of the termination process. Access to the global account by the customer is blocked. No data is deleted until the deletion date is reached at the end of the grace period. For trial accounts, specifies that the account is suspended, and the account owner has not yet extended the trial period.
	ContractStatus string `json:"contractStatus,omitempty"`
	// Details of the user that created the directory.
	CreatedBy string `json:"createdBy,omitempty"`
	// The date the directory was created. Dates and times are in UTC format.
	CreatedDate Time `json:"createdDate"`
	// (Deprecated) Contains information about the labels assigned to a specified directory. This field supports only single values per key and is now replaced by the string array \"labels\", which supports multiple values per key. The \"customProperties\" field returns only the first value of any label key that has multiple values assigned to it.
	CustomProperties []PropertyResponseObject `json:"customProperties,omitempty"`
	// A description of the directory.
	Description string `json:"description"`
	// The features that are enabled for the directory. Valid values: - DEFAULT: (Mandatory) All directories have the following basic feature enabled. (1) Group and filter subaccounts for reports and filters, (2) monitor usage and costs on a directory level (costs only available for contracts that use the consumption-based commercial model), and (3) set custom properties and tags to the directory for identification and reporting purposes. - ENTITLEMENTS: (Optional) Allows the assignment of a quota for services and applications to the directory from the global account quota for distribution to the subaccounts under this directory.  - AUTHORIZATIONS: (Optional) Allows the assignment of users as administrators or viewers of this directory. You must apply this feature in combination with the ENTITLEMENTS feature. <br/><b>Valid values:</b>  [DEFAULT] [DEFAULT,ENTITLEMENTS] [DEFAULT,ENTITLEMENTS,AUTHORIZATIONS]<br/>
	DirectoryFeatures []string `json:"directoryFeatures"`
	// The display name of the directory.
	DisplayName string `json:"displayName"`
	// The current state of the directory. * <b>STARTED:</b> CRUD operation on an entity has started. * <b>CREATING:</b> Creating entity operation is in progress. * <b>UPDATING:</b> Updating entity operation is in progress. * <b>MOVING:</b> Moving entity operation is in progress. * <b>PROCESSING:</b> A series of operations related to the entity is in progress. * <b>DELETING:</b> Deleting entity operation is in progress. * <b>OK:</b> The CRUD operation or series of operations completed successfully. * <b>PENDING REVIEW:</b> The processing operation has been stopped for reviewing and can be restarted by the operator. * <b>CANCELLED:</b> The operation or processing was canceled by the operator. * <b>CREATION_FAILED:</b> The creation operation failed, and the entity was not created or was created but cannot be used. * <b>UPDATE_FAILED:</b> The update operation failed, and the entity was not updated. * <b>PROCESSING_FAILED:</b> The processing operations failed. * <b>DELETION_FAILED:</b> The delete operation failed, and the entity was not deleted. * <b>MOVE_FAILED:</b> Entity could not be moved to a different location. * <b>MIGRATING:</b> Migrating entity from NEO to CF.
	EntityState string `json:"entityState,omitempty"`
	// The GUID of the directory's global account entity.
	GlobalAccountGUID string `json:"globalAccountGUID"`
	// The unique ID of the directory.
	Guid string `json:"guid"`
	// Contains information about the labels assigned to a specified global account. Labels are represented in a JSON array of key-value pairs; each key has up to 10 corresponding values. This field replaces the deprecated \"customProperties\" field, which supports only single values per key.
	Labels map[string][]string `json:"labels,omitempty"`
	// The date the directory was last modified. Dates and times are in UTC format.
	ModifiedDate Time `json:"modifiedDate,omitempty"`
	// The GUID of the directory's parent entity. Typically this is the global account.
	ParentGUID string `json:"parentGUID"`
	// Information about the state.
	StateMessage string `json:"stateMessage,omitempty"`
	// The subaccounts contained in the directory.
	Subaccounts []SubaccountResponseObject `json:"subaccounts,omitempty"`
	// Applies only to directories that have the user authorization management feature enabled. The subdomain becomes part of the path used to access the authorization tenant of the directory. Unique within the defined region.
	Subdomain string `json:"subdomain,omitempty"`
}

type GlobalAccountResponseObject ¶

type GlobalAccountResponseObject struct {
	// Specifies if global account is backward-compliant for EU access.
	BackwardCompliantEU bool `json:"backwardCompliantEU,omitempty"`
	// The list of directories associated with the specified global account.
	Children []DirectoryResponseObject `json:"children,omitempty"`
	// The type of the commercial contract that was signed.
	CommercialModel string `json:"commercialModel"`
	// Whether the customer of the global account pays only for services that they actually use (consumption-based) or pay for subscribed services at a fixed cost irrespective of consumption (subscription-based). * <b>TRUE:</b> Consumption-based commercial model. * <b>FALSE:</b> Subscription-based commercial model.
	ConsumptionBased bool `json:"consumptionBased"`
	// The status of the customer contract and its associated root global account. * <b>ACTIVE:</b> The customer contract and its associated global account is currently active. * <b>PENDING_TERMINATION:</b> A termination process has been triggered for a customer contract (the customer contract has expired, or a customer has given notification that they wish to terminate their contract), and the global account is currently in the validation period. The customer can still access their global account until the end of the validation period. * <b>SUSPENDED:</b> For enterprise accounts, specifies that the customer's global account is currently in the grace period of the termination process. Access to the global account by the customer is blocked. No data is deleted until the deletion date is reached at the end of the grace period. For trial accounts, specifies that the account is suspended, and the account owner has not yet extended the trial period.
	ContractStatus string `json:"contractStatus,omitempty"`
	// The number of the cost center that is charged for the creation and usage of the global account. This is a duplicate property used for backward compatibility; the cost center is also stored in costObjectId. This property must be null if the global account is tied to an internal order or Work Breakdown Structure element.
	CostCenter string `json:"costCenter,omitempty"`
	// The number or code of the cost center, internal order, or Work Breakdown Structure element that is charged for the creation and usage of the global account. The type of the cost object must be configured in costObjectType.
	CostObjectId string `json:"costObjectId,omitempty"`
	// The type of accounting assignment object that is associated with the global account owner and used to charge for the creation and usage of the global account. Support types: COST_CENTER, INTERNAL_ORDER, WBS_ELEMENT. The number or code of the specified cost object is defined in costObjectId. For a cost object of type 'cost center', the value is also configured in costCenter for backward compatibility purposes.
	CostObjectType string `json:"costObjectType,omitempty"`
	// The date the global account was created. Dates and times are in UTC format.
	CreatedDate Time `json:"createdDate"`
	// The ID of the customer as registered in the CRM system.
	CrmCustomerId string `json:"crmCustomerId,omitempty"`
	// The ID of the customer tenant as registered in the CRM system.
	CrmTenantId string `json:"crmTenantId,omitempty"`
	// (Deprecated) Contains information about the labels assigned to a specified directory. This field supports only single values per key and is now replaced by the string array \"labels\", which supports multiple values per key. The \"customProperties\" field returns only the first value of any label key that has multiple values assigned to it.
	CustomProperties []PropertyResponseObject `json:"customProperties,omitempty"`
	// A description of the global account.
	Description string `json:"description"`
	// The display name of the global account.
	DisplayName string `json:"displayName"`
	// The current state of the global account. * <b>STARTED:</b> CRUD operation on an entity has started. * <b>CREATING:</b> Creating entity operation is in progress. * <b>UPDATING:</b> Updating entity operation is in progress. * <b>MOVING:</b> Moving entity operation is in progress. * <b>PROCESSING:</b> A series of operations related to the entity is in progress. * <b>DELETING:</b> Deleting entity operation is in progress. * <b>OK:</b> The CRUD operation or series of operations completed successfully. * <b>PENDING REVIEW:</b> The processing operation has been stopped for reviewing and can be restarted by the operator. * <b>CANCELLED:</b> The operation or processing was canceled by the operator. * <b>CREATION_FAILED:</b> The creation operation failed, and the entity was not created or was created but cannot be used. * <b>UPDATE_FAILED:</b> The update operation failed, and the entity was not updated. * <b>PROCESSING_FAILED:</b> The processing operations failed. * <b>DELETION_FAILED:</b> The delete operation failed, and the entity was not deleted. * <b>MOVE_FAILED:</b> Entity could not be moved to a different location. * <b>MIGRATING:</b> Migrating entity from NEO to CF.
	EntityState string `json:"entityState,omitempty"`
	// The planned date that the global account expires. This is the same date as the Contract End Date, unless a manual adjustment has been made to the actual expiration date of the global account. Typically, this property is automatically populated only when a formal termination order is received from the CRM system. From a customer perspective, this date marks the start of the grace period, which is typically 30 days before the actual deletion of the account.
	ExpiryDate Time `json:"expiryDate,omitempty"`
	// The geographic locations from where the global account can be accessed. * <b>STANDARD:</b> The global account can be accessed from any geographic location. * <b>EU_ACCESS:</b> The global account can be accessed only within locations in the EU.
	GeoAccess string `json:"geoAccess"`
	// The GUID of the directory's global account entity.
	GlobalAccountGUID string `json:"globalAccountGUID"`
	// The unique ID of the global account.
	Guid string `json:"guid"`
	// Contains information about the labels assigned to a specified global account. Labels are represented in a JSON array of key-value pairs; each key has up to 10 corresponding values. This field replaces the deprecated \"customProperties\" field, which supports only single values per key.
	Labels map[string][]string `json:"labels,omitempty"`
	// The type of license for the global account. The license type affects the scope of functions of the account. * <b>DEVELOPER:</b> For internal developer global accounts on Staging or Canary landscapes. * <b>CUSTOMER:</b> For customer global accounts. * <b>PARTNER:</b> For partner global accounts. * <b>INTERNAL_DEV:</b> For internal global accounts on the Dev landscape. * <b>INTERNAL_PROD:</b> For internal global accounts on the Live landscape. * <b>TRIAL:</b> For customer trial accounts.
	LicenseType string `json:"licenseType"`
	// The date the global account was last modified. Dates and times are in UTC format.
	ModifiedDate Time `json:"modifiedDate,omitempty"`
	// The origin of the account. * <b>ORDER:</b> Created by the Order Processing API or Submit Order wizard. * <b>OPERATOR:</b> Created by the Global Account wizard. * <b>REGION_SETUP:</b> Created automatically as part of the region setup.
	Origin string `json:"origin,omitempty"`
	// The GUID of the global account's parent entity. Typically this is the global account.
	ParentGUID string `json:"parentGUID"`
	// The Type of the global account's parent entity.
	ParentType string `json:"parentType"`
	// The date that an expired contract was renewed. Dates and times are in UTC format.
	RenewalDate Time `json:"renewalDate,omitempty"`
	// For internal accounts, the service for which the global account was created.
	ServiceId string `json:"serviceId,omitempty"`
	// Information about the state.
	StateMessage string `json:"stateMessage,omitempty"`
	// The subaccounts contained in the global account.
	Subaccounts []SubaccountResponseObject `json:"subaccounts,omitempty"`
	// Relevant only for entities that require authorization (e.g. global account). The subdomain that becomes part of the path used to access the authorization tenant of the global account. Unique within the defined region.
	Subdomain string `json:"subdomain,omitempty"`
	// Specifies the current stage of the termination notifications sequence. * <b>PENDING_FIRST_NOTIFICATION:</b> A notification has not yet been sent to the global account owner informing them of the expired contract or termination request. * <b>FIRST_NOTIFICATION_PROCESSED:</b> A first notification has been sent to the global account owner informing them of the expired contract, and the termination date when the global account will be closed. * <b>SECOND_NOTIFICATION_PROCESSED:</b> A follow-up notification has been sent to the global account owner.  Your mail server must be configured so that termination notifications can be sent by the Core Commercialization Foundation service.
	TerminationNotificationStatus string `json:"terminationNotificationStatus,omitempty"`
	// For internal accounts, the intended purpose of the global account. Possible purposes: * <b>Development:</b> For development of a service. * <b>Testing:</b> For testing development. * <b>Demo:</b> For creating demos. * <b>Production:</b> For delivering a service in a production landscape.
	UseFor string `json:"useFor,omitempty"`
}

type LabelsResponseObject ¶

type LabelsResponseObject struct {
	// User-defined labels that are assigned as key-value pairs in a JSON array to the entity.  Example: {    \"Cost Center\": [\"19700626\"],    \"Department\": [\"Sales\"],    \"Contacts\": [\"name1@example.com\",\"name2@example.com\"],    \"EMEA\":[] }
	Labels map[string][]string `json:"labels,omitempty"`
}

Labels assigned as key-value pairs to the entity.

type PropertyResponseObject ¶

type PropertyResponseObject struct {
	// The unique ID for the corresponding entity.
	AccountGUID string `json:"accountGUID,omitempty"`
	// The name for the label.
	Key string `json:"key"`
	// The value for the corresponding label key.
	Value string `json:"value"`
}

type ResponseCollectionSubaccountResponseObject ¶

type ResponseCollectionSubaccountResponseObject struct {
	Value []SubaccountResponseObject `json:"value,omitempty"`
}

type ServiceManagementBindingResponseObject ¶

type ServiceManagementBindingResponseObject struct {
	// A public identifier of the app.
	Clientid string `json:"clientid"`
	// Secret known only to the app and the authorization server.
	Clientsecret string `json:"clientsecret"`
	// The URL of Service Management APIs to access with the obtained token.
	SmUrl string `json:"sm_url"`
	// The URL to authentication server to get a token to authenticate with Service Management using the obtained client ID and secret.
	Url string `json:"url"`
	// The name of the xsapp used to get the access token.
	Xsappname string `json:"xsappname"`
}

OAuth 2.0 Client Credentials Grant Type to obtain an access token to use the Service Management APIs in a subaccount context.

type SubaccountResponseObject ¶

type SubaccountResponseObject struct {
	// Whether the subaccount can use beta services and applications.
	BetaEnabled bool `json:"betaEnabled"`
	// Details of the user that created the subaccount.
	CreatedBy string `json:"createdBy,omitempty"`
	// The date the subaccount was created. Dates and times are in UTC format.
	CreatedDate Time `json:"createdDate"`
	// (Deprecated) Contains information about the labels assigned to a specified subaccount. This field supports only single values per key and is now replaced by the string array \"labels\", which supports multiple values per key. The \"customProperties\" field returns only the first value of any label key that has multiple values assigned to it.
	CustomProperties []PropertyResponseObject `json:"customProperties,omitempty"`
	// A description of the subaccount for customer-facing UIs.
	Description string `json:"description"`
	// A descriptive name of the subaccount for customer-facing UIs.
	DisplayName string `json:"displayName"`
	// The unique ID of the subaccount's global account.
	GlobalAccountGUID string `json:"globalAccountGUID"`
	// Unique ID of the subaccount.
	Guid string `json:"guid"`
	// Contains information about the labels assigned to a specified subaccount. Labels are represented in a JSON array of key-value pairs; each key has up to 10 corresponding values. This field replaces the deprecated \"customProperties\" field, which supports only single values per key.
	Labels map[string][]string `json:"labels,omitempty"`
	// The date the subaccount was last modified. Dates and times are in UTC format.
	ModifiedDate Time `json:"modifiedDate,omitempty"`
	// The features of parent entity of the subaccount.
	ParentFeatures []string `json:"parentFeatures"`
	// The GUID of the subaccount’s parent entity. If the subaccount is located directly in the global account (not in a directory), then this is the GUID of the global account.
	ParentGUID string `json:"parentGUID"`
	//The type of the parent entity.
	ParentType string `json:"parentType"`
	// The region in which the subaccount was created.
	Region string `json:"region"`
	// The current state of the subaccount.
	State string `json:"state"`
	// Information about the state of the subaccount.
	StateMessage string `json:"stateMessage,omitempty"`
	// The subdomain that becomes part of the path used to access the authorization tenant of the subaccount. Must be unique within the defined region. Use only letters (a-z), digits (0-9), and hyphens (not at the start or end). Maximum length is 63 characters. Cannot be changed after the subaccount has been created.
	Subdomain string `json:"subdomain"`
	// The technical name of the subaccount. Refers to: (1) the platform-based account name for Neo subaccounts, or (2) the account identifier (tenant ID) in XSUAA for multi-environment subaccounts.
	TechnicalName string `json:"technicalName"`
	// Whether the subaccount is used for production purposes. This flag can help your cloud operator to take appropriate action when handling incidents that are related to mission-critical accounts in production systems. Do not apply for subaccounts that are used for non-production purposes, such as development, testing, and demos. Applying this setting this does not modify the subaccount. * <b>UNSET:</b> Global account or subaccount admin has not set the production-relevancy flag. Default value. * <b>NOT_USED_FOR_PRODUCTION:</b> Subaccount is not used for production purposes. * <b>USED_FOR_PRODUCTION:</b> Subaccount is used for production purposes.
	UsedForProduction string `json:"usedForProduction"`
}

type Time ¶

type Time time.Time

func (*Time) Time ¶

func (t *Time) Time() time.Time

func (*Time) UnmarshalJSON ¶

func (t *Time) UnmarshalJSON(b []byte) (err error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL