xsuaa_settings

Documentation

Index

• type Binding
• type LinksSettings
• type SamlConfigSettingsResp
• type SamlKey
• type TenantSettingsResp
• type TokenPolicySettingsResp

Types

type Binding

type Binding struct {

	// app Id
	// Example: product-list!t1000
	AppID string `json:"appId,omitempty"`

	// binding Id
	// Example: 3a3a9aa2-bf44-4cd3-904a-b22d13a17fa4
	BindingID string `json:"bindingId,omitempty"`

	// credential type
	// Enum: [instance-secret binding-secret X.509]
	CredentialType string `json:"credentialType,omitempty"`

	// service Id
	// Example: a53672a7-7f94-48e8-bd24-0099b822abd7
	ServiceID string `json:"serviceId,omitempty"`

	// tenant Id
	// Example: 4a3a6a53-ae93-4450-ba12-4becb1c345ab
	TenantID string `json:"tenantId,omitempty"`
}

Binding binding

type LinksSettings

type LinksSettings struct {

	// Overrides the home page of the service and issues a redirect to this URL when the browser requests `/` or `/home`.
	HomeRedirect string `json:"homeRedirect,omitempty"`
}

LinksSettings LinksSettings

swagger:model LinksSettings

type SamlConfigSettingsResp

type SamlConfigSettingsResp struct {

	// The ID of the key to be used for signing metadata and assertions.
	// Example: default-saml-key-99999
	ActiveKeyID string `json:"activeKeyId,omitempty"`

	// If true, this zone doesn't validate the `InResponseToField` part of an incoming identity provider assertion.
	DisableInResponseToCheck bool `json:"disableInResponseToCheck,omitempty"`

	// The parameter contains a globally unique name for an identity provider or a service provider.
	// Example: https://example-tenant.authentication.eu10.hana.ondemand.com
	EntityID string `json:"entityID,omitempty"`

	// keys
	Keys *SamlKey `json:"keys,omitempty"`
}

SamlConfigSettingsResp SamlConfigSettingsResp

swagger:model SamlConfigSettingsResp

type SamlKey

type SamlKey struct {
}

SamlKey SamlKey

swagger:model SamlKey

type TenantSettingsResp

type TenantSettingsResp struct {

	// credential type infos
	CredentialTypeInfos []*Binding `json:"CredentialTypeInfos"`

	// Lists the custom e-mail domains supported by this tenant.
	// Example: internal.test, mail.invalid
	CustomEmailDomains []string `json:"customEmailDomains"`

	// The parameter displays the default identity provider (IdP) of the current tenant.
	// Example: sap.default
	DefaultIdp string `json:"defaultIdp,omitempty"`

	// By default, login pages of the service can't be framed by other applications in different domains for security reasons. The service trusts the domains listed here to embed the login page. The entire list can't exceed 2048 characters. For more information, see [Implications of Using IFrames](https://help.sap.com/docs/btp/sap-business-technology-platform/security-considerations-for-sap-authorization-and-trust-management-service#implications-of-using-iframes).
	// Example: https://store.example.com
	IframeDomains string `json:"iframeDomains,omitempty"`

	// links
	Links *LinksSettings `json:"links,omitempty"`

	// saml config settings
	SamlConfigSettings *SamlConfigSettingsResp `json:"samlConfigSettings,omitempty"`

	// token policy settings
	TokenPolicySettings *TokenPolicySettingsResp `json:"tokenPolicySettings,omitempty"`

	// Indicates whether the fallback at logon is enabled or not that if the logon ID provided in the token of the identity provider is unknown, the service attempts to log on the user with the e-mail address from the token. When false, the service attempts to create a missing user if user creation at logon is allowed. Note that before you can switch this parameter from false to true again, ensure that e-mail addresses are unique among your shadow users.
	TreatUsersWithSameEmailAsSameUser bool `json:"treatUsersWithSameEmailAsSameUser,omitempty"`
}

TenantSettingsResp TenantSettingsResp

swagger:model TenantSettingsResp

type TokenPolicySettingsResp

type TokenPolicySettingsResp struct {

	// Time in seconds between when a access token is issued and when it expires. The value ranges from 1800 seconds to 86,400 seconds, in other words, from 30 minutes to 24 hours. Keep token validity as short as possible, but not less than 30 minutes. The default value is 43,000 seconds or 12 hours. The value `-1` means that the token uses the default setting. Token policy settings apply to all service instances in the subaccount that haven't set a specific value in the application security descriptor (xs-security.json). For more information, see [Setting Token Policy](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/f117cab6b92d438cb2a0b5204713994b.html#setting-token-policy).
	AccessTokenValidity int32 `json:"accessTokenValidity,omitempty"`

	// The ID of the key to use for signing metadata and assertions.
	// Example: default-jwt-key--9988843812
	ActiveKeyID string `json:"activeKeyId,omitempty"`

	// key ids
	KeyIds []string `json:"keyIds"`

	// If true, the service only issues one refresh token per client_id and user_id combination.
	RefreshTokenUnique bool `json:"refreshTokenUnique,omitempty"`

	// Time in seconds between when a refresh token is issued and when it expires. The value ranges from 1800 seconds to 31,536,000 seconds, in other words, from 30 minutes to one year. The validity of refresh tokens must be longer than the validity for access tokens. The system never issues refresh tokens if the validity is shorter. The default value is 604,800 seconds or 7 days. The value `-1` means that the token uses the default setting. Token policy settings apply to all service instances in the subaccount that haven't set a specific value in the application security descriptor (xs-security.json). For more information, see [Setting Token Policy](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/f117cab6b92d438cb2a0b5204713994b.html#setting-token-policy).
	RefreshTokenValidity int32 `json:"refreshTokenValidity,omitempty"`
}

TokenPolicySettingsResp TokenPolicySettingsResp

swagger:model TokenPolicySettingsResp