saas_manager_service

package

v1.3.0 Latest Latest Go to latest Published: May 7, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SAP/terraform-provider-btp

Links

Open Source Insights

Documentation ¶

Overview ¶

* SaaS Provisioning Service * * The SAP SaaS Provisioning service provides REST APIs that are responsible for the registration and provisioning of multitenant applications and services. Use the APIs in this service to perform various operations related to your multitenant applications and services. For example, to get application registration details, subscribe a tenant to your application, unsubscribe a tenant from your application, retrieve all your application subscriptions, update subscription dependencies, and to get subscription job information. 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 ApplicationSubscriptionRequestPayload
type ApplicationSubscriptionsResponseObject
type CreateSubscriptionRequestPayload
type CreateSubscriptionRequestPayloadRequestEntity
type DependenciesResponseObject
type EntitledApplicationsErrorResponseObject
type EntitledApplicationsResponseCollection
type EntitledApplicationsResponseObject
type JobErrorResponseObject
type JobParameter
type JobStateResponseObject
type JobStatusResponseObject
type LabelAssignmentRequestPayload
type LabelAssignmentRequestPayloadRequestEntity
type LabelsResponseObject
type RegistrationDetailsResponseObject
type ResponseEntity
type SaasAsyncSubscriptionRequestPayload
type SaasAsyncSubscriptionRequestPayloadRequestEntity
type SaasSubscriptionPlanDto
type SubscriptionAssignmentResponseObject
type SubscriptionInfoResponseObject
type SubscriptionsListResponseObjectApplicationSubscriptionsResponseObject
type Time
- func (t *Time) Time() time.Time
- func (t *Time) UnmarshalJSON(b []byte) error
type Timestamp
type UpdateApplicationDependenciesRequestPayload
type UpdateSubscriptionRequestPayload

Constants ¶

View Source

const (
	StateInProcess              string = "IN_PROCESS"
	StateNotSubscribed          string = "NOT_SUBSCRIBED"
	StateSubscribed             string = "SUBSCRIBED"
	StateSubscribeFailed        string = "SUBSCRIBE_FAILED"
	StateUnsubscribeFailed      string = "UNSUBSCRIBE_FAILED"
	StateUpdateFailed           string = "UPDATE_FAILED"
	StateUpdateParametersFailed string = "UPDATE_PARAMETERS_FAILED"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ApplicationSubscriptionRequestPayload ¶

type ApplicationSubscriptionRequestPayload struct {
	// Additional subscription parameters determined by the application provider.
	SubscriptionParams *interface{} `json:"subscriptionParams,omitempty"`
}

type ApplicationSubscriptionsResponseObject ¶

type ApplicationSubscriptionsResponseObject struct {
	// Specifies the ability to use the service plan of the subscribed application. The actual amount has no bearing on the maximum consumption limit of the application.
	Amount int64 `json:"amount,omitempty"`
	// The unique registration name of the deployed multitenant application, as defined by the app developer.
	AppName string `json:"appName,omitempty"`
	// The date and time the subscription was last modified. Dates and times are in UTC format.
	ChangedOn string `json:"changedOn,omitempty"`
	// A subscription code for the application.
	Code string `json:"code,omitempty"`
	// Tenant ID of the global account or subaccount of the consumer that has subscribed to the multitenant application.
	ConsumerTenantId string `json:"consumerTenantId,omitempty"`
	// The date and time the subscription was created. Dates and times are in UTC format.
	CreatedOn string `json:"createdOn,omitempty"`
	// Any reuse services used or required by a subscribed application and its services.
	Dependencies []DependenciesResponseObject `json:"dependencies,omitempty"`
	// Error description for the following statuses: SUBSCRIBE_FAILED, UNSUBSCRIBE_FAILED, UPDATE_FAILED.
	Error_ string `json:"error,omitempty"`
	// ID of the associated global account.
	GlobalAccountId string `json:"globalAccountId,omitempty"`
	// Whether the consumer tenant is active. This field is returned only if one of the following query parameters was used during the API call: tenantId, subaccountId
	IsConsumerTenantActive bool `json:"isConsumerTenantActive,omitempty"`
	// The license type of the associated global account.
	LicenseType string `json:"licenseType,omitempty"`
	// The ID of the multitenant application that is registered to the SAP SaaS Provisioning registry.
	ServiceInstanceId string `json:"serviceInstanceId,omitempty"`
	// State of the subscriptions. Possible states: IN_PROCESS, SUBSCRIBED, SUBSCRIBE_FAILED, UNSUBSCRIBE_FAILED, UPDATE_FAILED.
	State string `json:"state,omitempty"`
	// ID of the associated subaccount.
	SubaccountId string `json:"subaccountId,omitempty"`
	// Consumer Subdomain
	Subdomain string `json:"subdomain,omitempty"`
	// Application URL
	Url string `json:"url,omitempty"`
}

type CreateSubscriptionRequestPayload ¶

type CreateSubscriptionRequestPayload struct {
	// The name of the subscription plan to a multitenant application
	PlanName string `json:"planName,omitempty"`
	// Additional subscription parameters determined by the application provider.
	SubscriptionParams *interface{} `json:"subscriptionParams,omitempty"`
}

type CreateSubscriptionRequestPayloadRequestEntity ¶

type CreateSubscriptionRequestPayloadRequestEntity struct {
	// The name of the subscription plan to a multitenant application
	PlanName string `json:"planName,omitempty"`
	// Additional subscription parameters determined by the application provider.
	SubscriptionParams *interface{} `json:"subscriptionParams,omitempty"`
}

type DependenciesResponseObject ¶

type DependenciesResponseObject struct {
	// The unique registration name of the linked dependency application.
	AppName string `json:"appName,omitempty"`
	// The list of relevant dependencies and their descriptions.
	Dependencies []DependenciesResponseObject `json:"dependencies,omitempty"`
	// In case there are errors during dependencies' assignments, the descriptions are shown here.
	Error_ string `json:"error,omitempty"`
	// The xsappname configured in the security descriptor file used to create the XSUAA instance.
	Xsappname string `json:"xsappname,omitempty"`
}

type EntitledApplicationsErrorResponseObject ¶

type EntitledApplicationsErrorResponseObject struct {
	// A response object that contains details about the error an app provider returns to the subscriber. It contains the error code, a user-friendly, customer-oriented error message, technical details about the error, and more.
	AppError string `json:"appError,omitempty"`
	// The message that describes the error that occurred during the subscription.
	ErrorMessage string `json:"errorMessage,omitempty"`
}

type EntitledApplicationsResponseCollection ¶

type EntitledApplicationsResponseCollection struct {
	// The response  list of all the multitenant applications to which a specified subaccount is entitled to subscribe.
	Applications []EntitledApplicationsResponseObject `json:"applications,omitempty"`
}

type EntitledApplicationsResponseObject ¶

type EntitledApplicationsResponseObject struct {
	// The list of features specific to this plan.
	AdditionalPlanFeatures []string `json:"additionalPlanFeatures,omitempty"`
	// The ID returned by XSUAA after the app provider has performed a bind of the multitenant application to a XSUAA service instance.
	AppId string `json:"appId,omitempty"`
	// The unique registration name of the deployed multitenant application as defined by the app developer.
	AppName string `json:"appName,omitempty"`
	// The application coordinates provided in metadata for customer-facing UIs.
	ApplicationCoordinates *interface{} `json:"applicationCoordinates,omitempty"`
	// The authentication provider of the multitenant application. * XSUAA is the SAP Authorization and Trust Management service that defines scopes and permissions for users as tenants at the global account level. * IAS is Identity Authentication Service that defines scopes and permissions for users in zones (common data isolation systems across systems, SaaS tenants, and services).
	AuthenticationProvider string `json:"authenticationProvider,omitempty"`
	// The state of the automation solution.
	AutomationState string `json:"automationState,omitempty"`
	// The message that describes the automation solution state.
	AutomationStateMessage string `json:"automationStateMessage,omitempty"`
	// The technical name of the category defined by the app developer to which the multitenant application is grouped in customer-facing UIs.
	Category string `json:"category,omitempty"`
	// The display name of the category for customer-facing UIs.
	CategoryDisplayName string `json:"categoryDisplayName,omitempty"`
	// The commercial name of the deployed multitenant application as defined by the app developer.
	CommercialAppName string `json:"commercialAppName,omitempty"`
	// The date the subscription was created. Dates and times are in UTC format.
	CreatedDate Time `json:"createdDate,omitempty"`
	// Whether the application was developed by a customer. If not, then the application is developed by the cloud operator, such as SAP.
	CustomerDeveloped bool `json:"customerDeveloped,omitempty"`
	// The description of the multitenant application for customer-facing UIs.
	Description string `json:"description,omitempty"`
	// The display name of the application for customer-facing UIs.
	DisplayName string `json:"displayName,omitempty"`
	// Name of the formations solution associated with the multitenant application.
	FormationSolutionName string `json:"formationSolutionName,omitempty"`
	// ID of the associated global account.
	GlobalAccountId string `json:"globalAccountId,omitempty"`
	// The icon of the multitenant application for customer-facing UIs.
	IconBase64 string `json:"iconBase64,omitempty"`
	// The application's incident-tracking component provided in metadata for customer-facing UIs.
	IncidentTrackingComponent string `json:"incidentTrackingComponent,omitempty"`
	// User-defined labels that are assigned as key-value pairs in a JSON array to the multitenant application subscription.  Example: {   \"Cost Center\": [\"19700626\"],   \"Department\": [\"Sales\"],   \"Contacts\": [\"name1@example.com\",\"name2@example.com\"],   \"EMEA\":[] }
	Labels map[string][]string `json:"labels,omitempty"`
	// JSON schema that describes the metadata that the consumer provide when subscribing to the application.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// The date the subscription was last modified. Dates and times are in UTC format.
	ModifiedDate Time `json:"modifiedDate,omitempty"`
	// JSON schema that describes the parameters that the consumer must provide when subscribing to the application.
	ParamsSchema map[string]interface{} `json:"paramsSchema,omitempty"`
	// The description of the plan for customer-facing UIs.
	PlanDescription string `json:"planDescription,omitempty"`
	// The plan name of the application to which the consumer has subscribed.
	PlanName string `json:"planName,omitempty"`
	// ID of the landscape-specific environment.
	PlatformEntityId string `json:"platformEntityId,omitempty"`
	// Total amount the subscribed subaccount is entitled to consume.
	Quota int32 `json:"quota,omitempty"`
	// The short description of the multitenant application for customer-facing UIs.
	ShortDescription string `json:"shortDescription,omitempty"`
	// The subscription state of the subaccount regarding the multitenant application.
	State string `json:"state,omitempty"`
	// The ID of the subaccount which is subscribed to the multitenant application.
	SubscribedSubaccountId string `json:"subscribedSubaccountId,omitempty"`
	// The ID of the tenant which is subscribed to a multitenant application.
	SubscribedTenantId string                                   `json:"subscribedTenantId,omitempty"`
	SubscriptionError  *EntitledApplicationsErrorResponseObject `json:"subscriptionError,omitempty"`
	// Technical ID generated by XSUAA for a multitenant application when a consumer subscribes to the application.
	SubscriptionGUID string `json:"subscriptionGUID,omitempty"`
	// URL for app users to launch the subscribed application.
	SubscriptionUrl string `json:"subscriptionUrl,omitempty"`
	// Specifies whether a consumer, whose subaccount is subscribed to the application, can change its subscriptions parameters.
	SupportsParametersUpdates bool `json:"supportsParametersUpdates,omitempty"`
	// Specifies if a consumer, whose subaccount is subscribed to the application, can change the subscription to a different plan that is available for this application and subaccount.
	SupportsPlanUpdates bool `json:"supportsPlanUpdates,omitempty"`
	// Tenant ID of the application provider.
	TenantId string `json:"tenantId,omitempty"`
}

type JobErrorResponseObject ¶

type JobErrorResponseObject struct {
	// Description of the error.
	Error_ string `json:"error,omitempty"`
	// The runtime exception for the error.
	Exception string `json:"exception,omitempty"`
	// The message associated with the current error.
	Message string `json:"message,omitempty"`
	// Path of the exception received from the server.
	Paths string `json:"paths,omitempty"`
	// Error status code.
	Status    int32      `json:"status,omitempty"`
	Timestamp *Timestamp `json:"timestamp,omitempty"`
}

type JobParameter ¶

type JobParameter struct {
	Identifying bool         `json:"identifying,omitempty"`
	Type_       string       `json:"type,omitempty"`
	Value       *interface{} `json:"value,omitempty"`
}

type JobStateResponseObject ¶

type JobStateResponseObject struct {
	// The service instance ID of the SAP SaaS Provisioning service (saas-registry) that the application is using.
	CreatedBy string                  `json:"createdBy,omitempty"`
	Error_    *JobErrorResponseObject `json:"error,omitempty"`
	// ID of the corresponding job.
	Id string `json:"id,omitempty"`
	// The current state of the corresponding job. Possible values: * <b>CREATED:</b> Job processing has created. * <b>STARTED:</b> Job processing has started. * <b>SUCCEEDED:</b> The job has completed. * <b>FAILED:</b> The job failed and did not complete. * <b>RETRY:</b> Subscription has timed out and job processing is pending a retry.
	State string `json:"state,omitempty"`
}

type JobStatusResponseObject ¶

type JobStatusResponseObject struct {
	// A description of the exit status of a job when it ends.
	Description string                  `json:"description"`
	JobParams   map[string]JobParameter `json:"jobParams,omitempty"`
	// The current state of the job.  * <b>IN_PROGRESS:</b> The job is being executed. * <b>COMPLETED:</b> The job has completed. * <b>FAILED:</b> The job failed and did not complete. The job can be restarted.
	Status string `json:"status"`
}

type LabelAssignmentRequestPayload ¶

type LabelAssignmentRequestPayload struct {
	// Labels as key-value pairs in JSON format. An entity is allowed up to 10 labels. The key of each label is mandatory and is limited to 63 characters. Standard labels can have any name (key) that you define, with only a single optional value assigned per key. To define a special type of label, called tags, specify the key with the name 'tags' and associate up to 10 values per tag in the array. The key 'tags' (in any casing variation) can only be used once per entity. Note that label values (not keys) are case-sensitive -- be careful not to create duplicate variants of the same value with a different casing (example: \"myValue\" and \"MyValue\"). For example: { \"Cost Center\":\"2624061970\" \"Department\":\"Sales\" \"tags\": [\"Green\", \"Pharma\", \"Audited\"] }
	Labels map[string][]string `json:"labels,omitempty"`
}

Labels as key-value pairs to assign, update, or remove from an entity.

type LabelAssignmentRequestPayloadRequestEntity ¶

type LabelAssignmentRequestPayloadRequestEntity struct {
	// Labels as key-value pairs in JSON format. An entity is allowed up to 10 labels. The key of each label is mandatory and is limited to 63 characters. Standard labels can have any name (key) that you define, with only a single optional value assigned per key. To define a special type of label, called tags, specify the key with the name 'tags' and associate up to 10 values per tag in the array. The key 'tags' (in any casing variation) can only be used once per entity. Note that label values (not keys) are case-sensitive -- be careful not to create duplicate variants of the same value with a different casing (example: \"myValue\" and \"MyValue\"). For example: { \"Cost Center\":\"2624061970\" \"Department\":\"Sales\" \"tags\": [\"Green\", \"Pharma\", \"Audited\"] }
	Labels map[string][]string `json:"labels,omitempty"`
}

Labels as key-value pairs to assign, update, or remove from an entity.

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 RegistrationDetailsResponseObject ¶

type RegistrationDetailsResponseObject struct {
	// The ID returned by an xsuaa service instance after the app provider has connected the multitenant application to an xsuaa service instance.
	AppId string `json:"appId,omitempty"`
	// The unique registration name of the deployed multitenant application as defined by the app developer.
	AppName string `json:"appName,omitempty"`
	// The plan used to register the multitenant application or reusable service. <b>- saasApplication:</b> Registered entity is a multitenant application. <b>- saasService:</b> Registered entity is a reuse service.
	AppType string `json:"appType,omitempty"`
	// Any callback URLs that the multitenant application exposes.
	AppUrls string `json:"appUrls,omitempty"`
	// Name of the cloud automation solution associated with the multitenant application.
	AutomationSolutionName string `json:"automationSolutionName,omitempty"`
	// The category to which the application is grouped in the Subscriptions page in the cockpit. If left empty, it gets assigned to the default category.
	Category string `json:"category,omitempty"`
	// The unique commercial registration name of the deployed multitenant application as defined by the app developer.
	CommercialAppName string `json:"commercialAppName,omitempty"`
	// The description of the multitenant application for customer-facing UIs.
	Description string `json:"description,omitempty"`
	// The display name of the application for customer-facing UIs.
	DisplayName string `json:"displayName,omitempty"`
	// A flag to determine wheater to fail subscription when automation solution fails or not.
	FailSubscriptionOnAutomationFailure bool `json:"failSubscriptionOnAutomationFailure,omitempty"`
	// Name of the formations solution associated with the multitenant application.
	FormationSolutionName string `json:"formationSolutionName,omitempty"`
	// ID of the global account associated with the multitenant application.
	GlobalAccountId string `json:"globalAccountId,omitempty"`
	// Error message to return when automation solution fails.
	MessageOnAutomationFailure string `json:"messageOnAutomationFailure,omitempty"`
	// The unique ID of the Cloud Foundry org where the app provider has deployed and registered the multitenant application.
	OrganizationGuid string `json:"organizationGuid,omitempty"`
	// JSON schema that describes the parameters that the consumer must provide when subscribing to the application.
	ParamsSchema map[string]interface{} `json:"paramsSchema,omitempty"`
	// Whether the parameters are transferred to the application’s dependencies.
	PropagateParams bool `json:"propagateParams,omitempty"`
	// The unique ID of the tenant that provides the multitenant application.
	ProviderTenantId string `json:"providerTenantId,omitempty"`
	// The ID of the multitenant application that is registered to the SAP SaaS Provisioning service registry.
	ServiceInstanceId string `json:"serviceInstanceId,omitempty"`
	// The unique ID of the Cloud Foundry space where the app provider has deployed and registered the multitenant application.
	SpaceGuid string `json:"spaceGuid,omitempty"`
	// The xsappname configured in the security descriptor file used to create the xsuaa service instance for the multitenant application.
	Xsappname string `json:"xsappname,omitempty"`
}

type ResponseEntity ¶

type ResponseEntity struct {
	Body            *interface{} `json:"body,omitempty"`
	StatusCode      string       `json:"statusCode,omitempty"`
	StatusCodeValue int32        `json:"statusCodeValue,omitempty"`
}

type SaasAsyncSubscriptionRequestPayload ¶

type SaasAsyncSubscriptionRequestPayload struct {
	// Additional details accompanying the subscription process. Relates mostly to the cases when the subscription process status is FAILED.
	Message string `json:"message,omitempty"`
	// Status of the subscription job.
	Status string `json:"status,omitempty"`
	// The URL the multitenant application is exposing for a subscription.
	SubscriptionUrl string `json:"subscriptionUrl,omitempty"`
}

type SaasAsyncSubscriptionRequestPayloadRequestEntity ¶

type SaasAsyncSubscriptionRequestPayloadRequestEntity struct {
	// Additional details accompanying the subscription process. Relates mostly to the cases when the subscription process status is FAILED.
	Message string `json:"message,omitempty"`
	// Status of the subscription job.
	Status string `json:"status,omitempty"`
	// The URL the multitenant application is exposing for a subscription.
	SubscriptionUrl string `json:"subscriptionUrl,omitempty"`
}

type SaasSubscriptionPlanDto ¶

type SaasSubscriptionPlanDto struct {
	PlanName string `json:"planName,omitempty"`
}

type SubscriptionAssignmentResponseObject ¶

type SubscriptionAssignmentResponseObject struct {
	JobId string `json:"jobId,omitempty"`
}

type SubscriptionInfoResponseObject ¶

type SubscriptionInfoResponseObject struct {
	// The list of plans that were used to subscribe to the multitenant application.
	CurrentlyUsedPlans []SaasSubscriptionPlanDto `json:"currentlyUsedPlans,omitempty"`
}

type SubscriptionsListResponseObjectApplicationSubscriptionsResponseObject ¶

type SubscriptionsListResponseObjectApplicationSubscriptionsResponseObject struct {
	// Whether there are more pages.
	MorePages bool `json:"morePages,omitempty"`
	// The current page number.
	Page int32 `json:"page,omitempty"`
	// The list of the requested app subscriptions.
	Subscriptions []ApplicationSubscriptionsResponseObject `json:"subscriptions,omitempty"`
	// Total numbers of results.
	Total int64 `json:"total,omitempty"`
	// Total numbers of pages.
	TotalPages int32 `json:"totalPages,omitempty"`
}

type Time ¶

type Time time.Time

func (*Time) Time ¶

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

func (*Time) UnmarshalJSON ¶

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

type Timestamp ¶

type Timestamp struct {
	Date           int32 `json:"date,omitempty"`
	Day            int32 `json:"day,omitempty"`
	Hours          int32 `json:"hours,omitempty"`
	Minutes        int32 `json:"minutes,omitempty"`
	Month          int32 `json:"month,omitempty"`
	Nanos          int32 `json:"nanos,omitempty"`
	Seconds        int32 `json:"seconds,omitempty"`
	Time           int64 `json:"time,omitempty"`
	TimezoneOffset int32 `json:"timezoneOffset,omitempty"`
	Year           int32 `json:"year,omitempty"`
}

type UpdateApplicationDependenciesRequestPayload ¶

type UpdateApplicationDependenciesRequestPayload struct {
	// A JSON object with key-value pairs. Values can further be JSON objects. (nested structure)
	AppProviderCustomProperties *interface{} `json:"appProviderCustomProperties,omitempty"`
}

Custom properties of the application its provider is updating to be passed to its dependent services.

type UpdateSubscriptionRequestPayload ¶

type UpdateSubscriptionRequestPayload struct {
	// The new plan of the multitenant application to update in the existing subscription.
	PlanName string `json:"planName,omitempty"`
	// Additional subscription parameters determined by the application provider.
	SubscriptionParams *interface{} `json:"subscriptionParams,omitempty"`
}

Source Files ¶

View all Source files

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