xsuaa_authz

package

v1.3.0 Latest Latest Go to latest Published: May 7, 2024 License: Apache-2.0 Imports: 0 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 ¶

* Authorization * * Provides functions to administrate the Authorization and Trust Management service (XSUAA) of SAP BTP, Cloud Foundry environment. You can manage service instances of the Authorization and Trust Management service. You can also manage roles, role templates, and role collections of your subaccount. * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type App ¶

type App struct {
	// The application ID is the xsappname plus the identifier, which consists of an exclamation mark (!), an identifier for the plan underwhich the application is deployed, and an index number.
	Appid                  string               `json:"appid,omitempty"`
	Attributes             []AppAttribute       `json:"attributes,omitempty"`
	Authorities            []string             `json:"authorities,omitempty"`
	Description            string               `json:"description,omitempty"`
	ForeignScopeReferences []string             `json:"foreign-scope-references,omitempty"`
	MasterAppId            *string              `json:"masterAppId,omitempty"`
	Oauth2Configuration    *OAuth2Configuration `json:"oauth2-configuration,omitempty"`
	OrgId                  string               `json:"orgId,omitempty"`
	PlanId                 string               `json:"planId,omitempty"`
	PlanName               string               `json:"planName,omitempty"`
	RoleTemplates          []RoleTemplate       `json:"role-templates,omitempty"`
	Scopes                 []Scope              `json:"scopes,omitempty"`
	Serviceinstanceid      string               `json:"serviceinstanceid,omitempty"`
	SpaceId                *string              `json:"spaceId,omitempty"`
	TenantMode             string               `json:"tenant-mode,omitempty"`
	UserName               *string              `json:"userName,omitempty"`
	// The name of the application as defined in the application security descriptor xs-security.json. The name has a maximum length of 128 characters. Only the following characters are allowed: alphanumeric characters (aA-zZ) and (0-9), hyphen (-), underscore (_), forward slash (/), and backslash (\\).
	Xsappname string `json:"xsappname,omitempty"`
}

type AppAttribute ¶

type AppAttribute struct {
	Description   string `json:"description,omitempty"`
	Name          string `json:"name,omitempty"`
	ValueRequired bool   `json:"valueRequired,omitempty"`
	ValueType     string `json:"valueType,omitempty"`
}

type AttributeReference ¶

type AttributeReference struct {
	DefaultValues []string `json:"default-values,omitempty"`
	Description   string   `json:"description,omitempty"`
	Name          string   `json:"name,omitempty"`
	ValueRequired bool     `json:"valueRequired,omitempty"`
	ValueType     string   `json:"valueType,omitempty"`
}

type CloneSubscriptionDetails ¶

type CloneSubscriptionDetails struct {
	// Only relevant for reuse instances. The identifier for the following service instance.
	Id string `json:"id,omitempty"`
	// The application ID is the xsappname plus the identifier, which consists of an exclamation mark (!), an identifier for the plan underwhich the application is deployed, and an index number. The following and broker instances are identified by the clone- and broker- prefixes.
	Appid string `json:"appid,omitempty"`
	// Tenant ID of your subaccount. The zoneId parameter is the same ID and can be used interchangably with tenant ID.
	TenantId string `json:"tenantId,omitempty"`
}

type GroupReference ¶

type GroupReference struct {
	DEPRECTAED string `json:"DEPRECTAED,omitempty"`
}

The array groupReferences is deprecated and only provided to maintain backward compatibility. Please use the array samlAttrAssignment instead.

type IdentityProviderMapping ¶

type IdentityProviderMapping struct {
	// The name of the attribute that you want to add.
	AttributeName string `json:"attributeName,omitempty"`
	// The value of the attribute that you want to add.
	AttributeValue string `json:"attributeValue,omitempty"`
	// The operator value that matches the attribute name to its value.
	Operator string `json:"operator,omitempty"`
	// The name of the role collection.
	RoleCollectionName string `json:"roleCollectionName,omitempty"`
}

type OAuth2Configuration ¶

type OAuth2Configuration struct {
	Allowedproviders     []string `json:"allowedproviders,omitempty"`
	Autoapprove          bool     `json:"autoapprove,omitempty"`
	GrantTypes           []string `json:"grant-types,omitempty"`
	RedirectUris         []string `json:"redirect-uris,omitempty"`
	RefreshTokenValidity int32    `json:"refresh-token-validity,omitempty"`
	SystemAttributes     []string `json:"system-attributes,omitempty"`
	TokenValidity        int32    `json:"token-validity,omitempty"`
}

type Role ¶

type Role struct {
	AppDescription string          `json:"appDescription,omitempty"`
	AppName        string          `json:"appName,omitempty"`
	AttributeList  []RoleAttribute `json:"attributeList,omitempty"`
	Description    string          `json:"description,omitempty"`
	IsReadOnly     bool            `json:"isReadOnly,omitempty"`
	// The name has a maximum length of 64 characters. Only the following characters are allowed: alphanumeric characters (aA-zZ) and (0-9), underscore (_), period (.), and hyphen (-).
	Name                     string                    `json:"name,omitempty"`
	RoleCollectionReferences []RoleCollectionReference `json:"roleCollectionReferences,omitempty"`
	RoleTemplateAppId        string                    `json:"roleTemplateAppId,omitempty"`
	// The name has a maximum length of 64 characters. Only the following characters are allowed: alphanumeric characters (aA-zZ) and (0-9), underscore (_), period (.), and hyphen (-).
	RoleTemplateName string  `json:"roleTemplateName,omitempty"`
	Scopes           []Scope `json:"scopes,omitempty"`
}

type RoleAttribute ¶

type RoleAttribute struct {
	// The name has a maximum length of 64 characters. Only the following characters are allowed: alphanumeric characters (aA-zZ) and (0-9) and underscore (_).
	AttributeName        string   `json:"attributeName,omitempty"`
	AttributeValueOrigin string   `json:"attributeValueOrigin,omitempty"`
	AttributeValues      []string `json:"attributeValues,omitempty"`
	Description          string   `json:"description,omitempty"`
	ValueRequired        bool     `json:"valueRequired,omitempty"`
}

type RoleCollection ¶

type RoleCollection struct {
	// The name has a maximum length of 64 characters.
	Name string `json:"name,omitempty"`
	// The description has a maximum length of 1000 characters.
	Description        string               `json:"description,omitempty"`
	GroupReferences    []GroupReference     `json:"groupReferences,omitempty"`
	RoleReferences     []RoleReference      `json:"roleReferences,omitempty"`
	UserReferences     []UserReference      `json:"userReferences,omitempty"`
	SamlAttrAssignment []SamlAttrAssignment `json:"samlAttrAssignment,omitempty"`
	IsReadOnly         bool                 `json:"isReadOnly,omitempty"`
}

type RoleCollectionAttribute ¶

type RoleCollectionAttribute struct {
	ComparisonOperator         string `json:"comparisonOperator,omitempty"`
	RoleCollectionIdentityZone string `json:"roleCollectionIdentityZone,omitempty"`
	RoleCollectionName         string `json:"roleCollectionName,omitempty"`
	// This parameter is deprecated.
	SamlAttrName string `json:"samlAttrName,omitempty"`
	// The name of the attribute parameter.
	AttributeName string `json:"attributeName,omitempty"`
	// This parameter is deprecated.
	SamlAttributeValue string `json:"samlAttributeValue,omitempty"`
	// The value of the attribute.
	AttributeValue string `json:"attributeValue,omitempty"`
	SamlEntityId   string `json:"samlEntityId,omitempty"`
}

type RoleCollectionDescription ¶

type RoleCollectionDescription struct {
	// The description has a maximum length of 1000 characters.
	Description string `json:"description,omitempty"`
}

type RoleCollectionReference ¶

type RoleCollectionReference struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
}

type RoleReference ¶

type RoleReference struct {
	RoleTemplateAppId string `json:"roleTemplateAppId,omitempty"`
	// The name has a maximum length of 64 characters. Only the following characters are allowed: alphanumeric characters (aA-zZ) and (0-9), underscore (_), period (.), and hyphen (-).
	RoleTemplateName string `json:"roleTemplateName,omitempty"`
	Description      string `json:"description,omitempty"`
	Name             string `json:"name,omitempty"`
}

type RoleTemplate ¶

type RoleTemplate struct {
	AppDescription string `json:"appDescription,omitempty"`
	// The application ID is the xsappname plus the identifier, which consists of an exclamation mark (!), an identifier for the plan underwhich the application is deployed, and an index number.
	AppId               string               `json:"appId,omitempty"`
	AppName             string               `json:"appName,omitempty"`
	AttributeReferences []AttributeReference `json:"attribute-references,omitempty"`
	DefaultRoleName     string               `json:"default-role-name,omitempty"`
	Description         string               `json:"description,omitempty"`
	// The name has a maximum length of 64 characters. Only the following characters are allowed: alphanumeric characters (aA-zZ) and (0-9) and underscore (_).
	Name            string   `json:"name,omitempty"`
	RoleReferences  []Role   `json:"role-references,omitempty"`
	ScopeReferences []string `json:"scope-references,omitempty"`
	Version         string   `json:"version,omitempty"`
}

type RoleUpdate ¶

type RoleUpdate struct {
	AttributeList []RoleAttribute `json:"attributeList,omitempty"`
	// The description has a maximum length of 1000 characters.
	Description string `json:"description,omitempty"`
}

type SamlAttrAssignment ¶

type SamlAttrAssignment struct {
	RoleCollectionIdentityZone string `json:"roleCollectionIdentityZone,omitempty"`
	RoleCollectionName         string `json:"roleCollectionName,omitempty"`
	// This parameter is deprecated.
	SamlAttrName string `json:"samlAttrName,omitempty"`
	// The name of the attribute parameter.
	AttributeName string `json:"attributeName,omitempty"`
	// This parameter is deprecated.
	SamlAttributeValue string `json:"samlAttributeValue,omitempty"`
	// The value of the attribute.
	AttributeValue string `json:"attributeValue,omitempty"`
	// The operator value that matches the attribute name to its value.
	ComparisonOperator string `json:"comparisonOperator,omitempty"`
	SamlEntityId       string `json:"samlEntityId,omitempty"`
}

type Scope ¶

type Scope struct {
	CustomGrantAsAuthorityToApps []string `json:"custom-grant-as-authority-to-apps,omitempty"`
	CustomGrantedApps            []string `json:"custom-granted-apps,omitempty"`
	Description                  string   `json:"description,omitempty"`
	GrantAsAuthorityToApps       []string `json:"grant-as-authority-to-apps,omitempty"`
	GrantedApps                  []string `json:"granted-apps,omitempty"`
	// The name of the application and scope as defined in the application security descriptor xs-security.json. The name has a maximum length of 193 characters, including the fully qualified application name. The fully qualified scope name starts with the application ID followed by an optional number of components and finally the scope, each separated by a period (.). For example: service-manager!b105.entitlement.notify. Only the following characters are allowed: alphanumeric characters (aA-zZ) and (0-9), hyphen (-), underscore (_), forward slash (/), backslash (\\), and colon (:).
	Name string `json:"name,omitempty"`
}

type SubscriptionDetails ¶

type SubscriptionDetails struct {
	// The identifier for the subscription to the application.
	Id string `json:"id,omitempty"`
	// The application ID is the xsappname plus the identifier, which consists of an exclamation mark (!), an identifier for the plan underwhich the application is deployed, and an index number.
	Appid string `json:"appid,omitempty"`
	// Tenant ID of your subaccount. The zoneId parameter is the same ID and can be used interchangably with tenant ID.
	TenantId string `json:"tenantId,omitempty"`
}

type Subscriptions ¶

type Subscriptions struct {
	// Only relevant for reuse instances. Total number of following instances of your broker service instance. The service only returns this array if the service instance uses the broker plan.
	CloneCount int32 `json:"cloneCount,omitempty"`
	// An array of subscriptions to your multitenant application for this tenant. The service only returns this array if you set the listSubscriptions query paramter to true.
	Subscriptions []SubscriptionDetails `json:"subscriptions,omitempty"`
	// The number of subscriptions to your multitenant application for this tenant.
	SubscriptionCountForTenant int32 `json:"subscriptionCountForTenant,omitempty"`
	// Only relevant for reuse instances. An array of following instances of your broker service instance. The service only returns this array if you set the listCloneSubscriptions query paramter to true and the service instance uses the broker plan.
	CloneSubscriptions []CloneSubscriptionDetails `json:"cloneSubscriptions,omitempty"`
	// Total number of refrences to the broker service instance.
	ReferenceCount int32 `json:"referenceCount,omitempty"`
	// Only relevant for reuse instances. Total number of subscriptions to following service instances.
	CloneSubscriptionCount int32 `json:"cloneSubscriptionCount,omitempty"`
	// Total number of subscriptions to your multitenant application.
	SubscriptionCount int32 `json:"subscriptionCount,omitempty"`
}

type UserReference ¶

type UserReference struct {
	Id         string `json:"id,omitempty"`
	Username   string `json:"username,omitempty"`
	ZoneId     string `json:"zoneId,omitempty"`
	Email      string `json:"email,omitempty"`
	GivenName  string `json:"givenName,omitempty"`
	FamilyName string `json:"familyName,omitempty"`
	Origin     string `json:"origin,omitempty"`

	// TODO additional fields not mentioned in the swagger file
	Verified                   bool     `json:"verified,omitempty"`
	LegacyVerificationBehavior bool     `json:"legacyVerificationBehavior,omitempty"`
	PasswordChangeRequired     bool     `json:"passwordChangeRequired,omitempty"`
	Version                    int32    `json:"version,omitempty"`
	Active                     bool     `json:"active,omitempty"`
	RoleCollections            []string `json:"roleCollections,omitempty"`
}

Source Files ¶

View all Source files

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

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type App ¶

type AppAttribute ¶

type AttributeReference ¶

type CloneSubscriptionDetails ¶

type GroupReference ¶

type IdentityProviderMapping ¶

type OAuth2Configuration ¶

type Role ¶

type RoleAttribute ¶

type RoleCollection ¶

type RoleCollectionAttribute ¶

type RoleCollectionDescription ¶

type RoleCollectionReference ¶

type RoleReference ¶

type RoleTemplate ¶

type RoleUpdate ¶

type SamlAttrAssignment ¶

type Scope ¶

type SubscriptionDetails ¶

type Subscriptions ¶

type UserReference ¶

Source Files ¶