xsuaa_plattform

package

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

* User Management (System for Cross-domain Identity Management (SCIM)) * * Provides functions to administrate the Authorization and Trust Management service (XSUAA) of SAP BTP, Cloud Foundry environment. You can provision users from identity providers and manage roles and role collections. Use this API to manage shadow users; users the service provisions from your identity provider to the subaccount. For more information, see [Switch Off Automatic Creation of Shadow Users](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/d8525671e8b14147b96ef497e1e1af80.html). The System for Cross-domain Identity Management (SCIM) interfaces for users and groups supplement the relevant UAA [users](https://docs.cloudfoundry.org/api/uaa/version/74.0.0/index.html#users)and [groups](https://docs.cloudfoundry.org/api/uaa/version/74.0.0/index.html#groups) interfaces. Groups in the Authorization and Trust Management service are mapped to role collections. See also [SAP Note 2760424]( https://launchpad.support.sap.com/#/notes/2760424). To enable access to this API, create an OAuth 2.0 client for the XSUAA service instance. To create the client, enable the apiaccess plan. For more information, see [Access UAA Admin APIs](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/ebc9113a520e495ea5fb759b9a7929f2.html). * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

type Approval
type AuthorizationError
type Email
type GenericError
type Group
type MethodError
type Name
type PhoneNumber
type ScimGroup
type ScimGroupMember
type ScimGroupMemberPatch
type ScimGroupPatch
type ScimGroups
type ScimMeta
type ScimUser
type ScimUserPostPut
type ScimUsers

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Approval ¶

type Approval struct {
	// The client id on the approval. Represents the application this approval or denial was for.
	ClientId      string    `json:"clientId,omitempty"`
	ExpiresAt     time.Time `json:"expiresAt,omitempty"`
	LastUpdatedAt time.Time `json:"lastUpdatedAt,omitempty"`
	Scope         string    `json:"scope,omitempty"`
	Status        string    `json:"status,omitempty"`
	// The ID of the user.
	UserId string `json:"userId,omitempty"`
}

type AuthorizationError ¶

type AuthorizationError struct {
	Error_           string `json:"error,omitempty"`
	ErrorDescription string `json:"error_description,omitempty"`
	Scope            string `json:"scope,omitempty"`
}

type Email ¶

type Email struct {
	Type_ string `json:"type,omitempty"`
	Value string `json:"value,omitempty"`
	// Set to true if this is the user's primary email address.
	Primary bool `json:"primary,omitempty"`
}

type GenericError ¶

type GenericError struct {
	ErrorDescription string `json:"error_description,omitempty"`
	Error_           string `json:"error,omitempty"`
	Message          string `json:"message,omitempty"`
}

type Group ¶

type Group struct {
	Display string `json:"display,omitempty"`
	Value   string `json:"value,omitempty"`
	// Membership type. DIRECT means the user is directly associated with the group. INDIRECT means that the membership is derived from a nested group.
	Type_ string `json:"type,omitempty"`
}

type MethodError ¶

type MethodError struct {
	Timestamp string `json:"timestamp,omitempty"`
	Status    int32  `json:"status,omitempty"`
	Error_    string `json:"error,omitempty"`
	Message   string `json:"message,omitempty"`
	Path      string `json:"path,omitempty"`
}

type Name ¶

type Name struct {
	FamilyName      string `json:"familyName,omitempty"`
	GivenName       string `json:"givenName,omitempty"`
	HonorificPrefix string `json:"honorificPrefix,omitempty"`
	HonorificSuffix string `json:"honorificSuffix,omitempty"`
	Formatted       string `json:"formatted,omitempty"`
	MiddleName      string `json:"middleName,omitempty"`
}

type PhoneNumber ¶

type PhoneNumber struct {
	Value string `json:"value,omitempty"`
}

type ScimGroup ¶

type ScimGroup struct {
	// The group ID of a SCIM group.
	Id          string            `json:"id,omitempty"`
	Meta        *ScimMeta         `json:"meta,omitempty"`
	DisplayName string            `json:"displayName,omitempty"`
	ZoneId      string            `json:"zoneId,omitempty"`
	Description string            `json:"description,omitempty"`
	Members     []ScimGroupMember `json:"members,omitempty"`
	Schemas     []string          `json:"schemas,omitempty"`
}

type ScimGroupMember ¶

type ScimGroupMember struct {
	// The identity provider hosting the users. For the default identity provider, use sap.default. Subaccounts created before October 2020 return ldap as the default identity provider. The system accepts both sap.default and ldap for the default identity provider, but returns sap.default or ldap depending on when the subaccount was created.
	Origin string `json:"origin,omitempty"`
	Type_  string `json:"type,omitempty"`
	// The ID of a specific user. User IDs can be found using the \"/Users\" endpoint.
	Value string `json:"value,omitempty"`
}

type ScimGroupMemberPatch ¶

type ScimGroupMemberPatch struct {
	// The identity provider hosting the user. For the default identity provider, use sap.default. Subaccounts created before October 2020 return ldap as the default identity provider. The system accepts both sap.default and ldap for the default identity provider, but returns sap.default or ldap depending on when the subaccount was created.
	Origin string `json:"origin,omitempty"`
	Type_  string `json:"type,omitempty"`
	// The ID of a specific user. User IDs can be found using the \"/Users\" endpoint.
	Value string `json:"value,omitempty"`
	// Use this parameter to add or remove users from a group.
	Operation string `json:"operation,omitempty"`
}

type ScimGroupPatch ¶

type ScimGroupPatch struct {
	// The group ID of a SCIM group.
	Id          string                 `json:"id,omitempty"`
	Meta        *ScimMeta              `json:"meta,omitempty"`
	DisplayName string                 `json:"displayName,omitempty"`
	ZoneId      string                 `json:"zoneId,omitempty"`
	Description string                 `json:"description,omitempty"`
	Members     []ScimGroupMemberPatch `json:"members,omitempty"`
}

type ScimGroups ¶

type ScimGroups struct {
	Resources []ScimGroup `json:"resources,omitempty"`
	// Specifies the index of the first resource in the current set of search results.
	StartIndex int32 `json:"startIndex,omitempty"`
	// Specifies the maximum number of search results returned per response page.
	ItemsPerPage int32 `json:"itemsPerPage,omitempty"`
	// Specifies the total number of results matching the query. The service returns a maximum of 500 results.
	TotalResults int32    `json:"totalResults,omitempty"`
	Schemas      []string `json:"schemas,omitempty"`
}

type ScimMeta ¶

type ScimMeta struct {
	Attributes   []string  `json:"attributes,omitempty"`
	Version      int32     `json:"version,omitempty"`
	Created      time.Time `json:"created,omitempty"`
	LastModified time.Time `json:"lastModified,omitempty"`
}

type ScimUser ¶

type ScimUser struct {
	// The user ID of a SCIM user.
	Id         string    `json:"id,omitempty"`
	ExternalId string    `json:"externalId,omitempty"`
	Meta       *ScimMeta `json:"meta,omitempty"`
	UserName   string    `json:"userName,omitempty"`
	Name       *Name     `json:"name,omitempty"`
	Emails     []Email   `json:"emails,omitempty"`
	Groups     []Group   `json:"groups,omitempty"`
	// A list of approval decisions made by this user. Approvals record the user's explicit approval or rejection for an application's request for delegated permissions.
	Approvals []Approval `json:"approvals,omitempty"`
	Active    bool       `json:"active,omitempty"`
	Verified  bool       `json:"verified,omitempty"`
	// The identity provider hosting the users. For the default identity provider, use sap.default. Subaccounts created before October 2020 return ldap as the default identity provider. The system accepts both sap.default and ldap for the default identity provider, but returns sap.default or ldap depending on when the subaccount was created.
	Origin               string        `json:"origin,omitempty"`
	ZoneId               string        `json:"zoneId,omitempty"`
	DisplayName          string        `json:"displayName,omitempty"`
	Locale               string        `json:"locale,omitempty"`
	NickName             string        `json:"nickName,omitempty"`
	PasswordLastModified time.Time     `json:"passwordLastModified,omitempty"`
	PreviousLogonTime    int64         `json:"previousLogonTime,omitempty"`
	LastLogonTime        int64         `json:"lastLogonTime,omitempty"`
	Schemas              []string      `json:"schemas,omitempty"`
	PhoneNumbers         []PhoneNumber `json:"phoneNumbers,omitempty"`
	PreferredLanguage    string        `json:"preferredLanguage,omitempty"`
	ProfileUrl           string        `json:"profileUrl,omitempty"`
	Salt                 string        `json:"salt,omitempty"`
	Timezone             string        `json:"timezone,omitempty"`
	Title                string        `json:"title,omitempty"`
	UserType             string        `json:"userType,omitempty"`
}

type ScimUserPostPut ¶

type ScimUserPostPut struct {
	// The user ID of a SCIM user.
	Id         string    `json:"id,omitempty"`
	ExternalId string    `json:"externalId,omitempty"`
	Meta       *ScimMeta `json:"meta,omitempty"`
	UserName   string    `json:"userName,omitempty"`
	Name       *Name     `json:"name,omitempty"`
	Emails     []Email   `json:"emails,omitempty"`
	// A list of approval decisions made by this user. Approvals record the user's explicit approval or rejection for an application's request for delegated permissions.
	Approvals []Approval `json:"approvals,omitempty"`
	Active    bool       `json:"active,omitempty"`
	Verified  bool       `json:"verified,omitempty"`
	// The identity provider hosting the users. For the default identity provider, use sap.default. Subaccounts created before October 2020 return ldap as the default identity provider. The system accepts both sap.default and ldap for the default identity provider, but returns sap.default or ldap depending on when the subaccount was created.
	Origin               string        `json:"origin,omitempty"`
	ZoneId               string        `json:"zoneId,omitempty"`
	DisplayName          string        `json:"displayName,omitempty"`
	Locale               string        `json:"locale,omitempty"`
	NickName             string        `json:"nickName,omitempty"`
	PasswordLastModified time.Time     `json:"passwordLastModified,omitempty"`
	PreviousLogonTime    int64         `json:"previousLogonTime,omitempty"`
	LastLogonTime        int64         `json:"lastLogonTime,omitempty"`
	Schemas              []string      `json:"schemas,omitempty"`
	PhoneNumbers         []PhoneNumber `json:"phoneNumbers,omitempty"`
	PreferredLanguage    string        `json:"preferredLanguage,omitempty"`
	ProfileUrl           string        `json:"profileUrl,omitempty"`
	Salt                 string        `json:"salt,omitempty"`
	Timezone             string        `json:"timezone,omitempty"`
	Title                string        `json:"title,omitempty"`
	UserType             string        `json:"userType,omitempty"`
}

type ScimUsers ¶

type ScimUsers struct {
	Resources []ScimUser `json:"resources,omitempty"`
	// Specifies the index of the first response page in the current set of search results.
	StartIndex int32 `json:"startIndex,omitempty"`
	// Specifies the maximum number of search results returned per response page.
	ItemsPerPage int32 `json:"itemsPerPage,omitempty"`
	// Specifies the total number of results matching the query. The service returns a maximum of 500 results.
	TotalResults int32    `json:"totalResults,omitempty"`
	Schemas      []string `json:"schemas,omitempty"`
}

Source Files ¶

View all Source files

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