keycloak

package module
v2.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 23, 2024 License: AGPL-3.0 Imports: 5 Imported by: 0

README

Basic keycloak client in go

This repo provides a basic keycloak client in go.

Documentation

Index

Constants

View Source 
const (
	MsgErrMissingParam              = "missingParameter"
	MsgErrInvalidParam              = "invalidParameter"
	MsgErrCannotObtain              = "cannotObtain"
	MsgErrCannotMarshal             = "cannotMarshal"
	MsgErrCannotUnmarshal           = "cannotUnmarshal"
	MsgErrCannotParse               = "cannotParse"
	MsgErrCannotCreate              = "cannotCreate"
	MsgErrUnkownHTTPContentType     = "unkownHTTPContentType"
	MsgErrUnknownResponseStatusCode = "unknownResponseStatusCode"
	MsgErrExistingValue             = "existing"
	MsgErrReadOnly                  = "readOnlyValue"

	EvenParams       = "key/valParametersShouldBeEven"
	TokenProviderURL = "tokenProviderURL"
	APIURL           = "APIURL"
	TokenMsg         = "token"
	Response         = "response"
	AccessToken      = "accessToken"
	OIDCProvider     = "OIDCProvider"
	UserOrEmail      = "UsernameOrEmail"
	Username         = "username"
	Email            = "email"
)

Constants for error management

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivationCodeRepresentation 

type ActivationCodeRepresentation struct {
	Code *string `json:"code,omitempty"`
}

ActivationCodeRepresentation struct

type AdminEventRepresentation 

type AdminEventRepresentation struct {
	AuthDetails    *AuthDetailsRepresentation `json:"authDetails,omitempty"`
	Error          *string                    `json:"error,omitempty"`
	OperationType  *string                    `json:"operationType,omitempty"`
	RealmID        *string                    `json:"realmId,omitempty"`
	Representation *string                    `json:"representation,omitempty"`
	ResourcePath   *string                    `json:"resourcePath,omitempty"`
	ResourceType   *string                    `json:"resourceType,omitempty"`
	Time           *int64                     `json:"time,omitempty"`
}

AdminEventRepresentation struct

type AttachementRepresentation 

type AttachementRepresentation struct {
	Filename    *string `json:"filename,omitempty"`
	ContentType *string `json:"contentType,omitempty"`
	Content     *string `json:"content,omitempty"`
}

AttachementRepresentation struct

type AttributeKey 

type AttributeKey string

AttributeKey type

type Attributes 

type Attributes map[AttributeKey][]string

Attributes type

func (Attributes) Get 

func (a Attributes) Get(key AttributeKey) []string

Get a given attribute

func (Attributes) GetBool 

func (a Attributes) GetBool(key AttributeKey) (*bool, error)

GetBool gets the first value of a given attribute

func (Attributes) GetDate 

func (a Attributes) GetDate(key AttributeKey, dateLayouts []string) *string

GetDate returns an attribute which contains a date value

func (Attributes) GetInt 

func (a Attributes) GetInt(key AttributeKey) (*int, error)

GetInt gets the first value of a given attribute

func (Attributes) GetString 

func (a Attributes) GetString(key AttributeKey) *string

GetString gets the first value of a given attribute

func (Attributes) GetTime 

func (a Attributes) GetTime(key AttributeKey, dateLayouts []string) (*time.Time, error)

GetTime returns an attribute which contains a date value

func (Attributes) Merge 

func (a Attributes) Merge(others *Attributes)

Merge current attributes with others (Values from others replace those with the same key in current attributes)

func (Attributes) Remove 

func (a Attributes) Remove(key AttributeKey)

Remove a given attribute

func (Attributes) Set 

func (a Attributes) Set(key AttributeKey, value []string)

Set a given attribute

func (Attributes) SetBool 

func (a Attributes) SetBool(key AttributeKey, value bool)

SetBool sets the value of a given attribute

func (Attributes) SetBoolWhenNotNil 

func (a Attributes) SetBoolWhenNotNil(key AttributeKey, value *bool)

SetBoolWhenNotNil sets an attribute value if it is not nil

func (Attributes) SetDate 

func (a Attributes) SetDate(key AttributeKey, value string, dateLayouts []string)

SetDate sets a date

func (Attributes) SetDateWhenNotNil 

func (a Attributes) SetDateWhenNotNil(key AttributeKey, value *string, dateLayouts []string)

SetDateWhenNotNil sets a date attribute if it is not nil

func (Attributes) SetInt 

func (a Attributes) SetInt(key AttributeKey, value int)

SetInt sets the value of a given attribute

func (Attributes) SetIntWhenNotNil 

func (a Attributes) SetIntWhenNotNil(key AttributeKey, value *int)

SetIntWhenNotNil sets an attribute value if it is not nil

func (Attributes) SetString 

func (a Attributes) SetString(key AttributeKey, value string)

SetString sets the value of a given attribute

func (Attributes) SetStringWhenNotNil 

func (a Attributes) SetStringWhenNotNil(key AttributeKey, value *string)

SetStringWhenNotNil sets an attribute value if it is not nil

func (Attributes) SetTime 

func (a Attributes) SetTime(key AttributeKey, value time.Time, dateLayout string)

SetTime sets a date

func (Attributes) SetTimeWhenNotNil 

func (a Attributes) SetTimeWhenNotNil(key AttributeKey, value *time.Time, dateLayout string)

SetTimeWhenNotNil sets a date attribute if it is not nil

type AuthDetailsRepresentation 

type AuthDetailsRepresentation struct {
	ClientID  *string `json:"clientId,omitempty"`
	IPAddress *string `json:"ipAddress,omitempty"`
	RealmID   *string `json:"realmId,omitempty"`
	UserID    *string `json:"userId,omitempty"`
}

AuthDetailsRepresentation struct

type AuthenticationExecutionExportRepresentation 

type AuthenticationExecutionExportRepresentation struct {
	Authenticator       *string `json:"authenticator,omitempty"`
	AuthenticatorConfig *string `json:"authenticatorConfig,omitempty"`
	AuthenticatorFlow   *bool   `json:"authenticatorFlow,omitempty"`
	AutheticatorFlow    *bool   `json:"autheticatorFlow,omitempty"`
	FlowAlias           *string `json:"flowAlias,omitempty"`
	Priority            *int32  `json:"priority,omitempty"`
	Requirement         *string `json:"requirement,omitempty"`
	UserSetupAllowed    *bool   `json:"userSetupAllowed,omitempty"`
}

AuthenticationExecutionExportRepresentation struct

type AuthenticationExecutionInfoRepresentation 

type AuthenticationExecutionInfoRepresentation struct {
	Alias                *string   `json:"alias,omitempty"`
	AuthenticationConfig *string   `json:"authenticationConfig,omitempty"`
	AuthenticationFlow   *bool     `json:"authenticationFlow,omitempty"`
	Configurable         *bool     `json:"configurable,omitempty"`
	DisplayName          *string   `json:"displayName,omitempty"`
	FlowID               *string   `json:"flowId,omitempty"`
	ID                   *string   `json:"id,omitempty"`
	Index                *int32    `json:"index,omitempty"`
	Level                *int32    `json:"level,omitempty"`
	ProviderID           *string   `json:"providerId,omitempty"`
	Requirement          *string   `json:"requirement,omitempty"`
	RequirementChoices   *[]string `json:"requirementChoices,omitempty"`
}

AuthenticationExecutionInfoRepresentation struct

type AuthenticationExecutionRepresentation 

type AuthenticationExecutionRepresentation struct {
	Authenticator       *string `json:"authenticator,omitempty"`
	AuthenticatorConfig *string `json:"authenticatorConfig,omitempty"`
	AuthenticatorFlow   *bool   `json:"authenticatorFlow,omitempty"`
	AutheticatorFlow    *bool   `json:"autheticatorFlow,omitempty"`
	FlowID              *string `json:"flowId,omitempty"`
	ID                  *string `json:"id,omitempty"`
	ParentFlow          *string `json:"parentFlow,omitempty"`
	Priority            *int32  `json:"priority,omitempty"`
	Requirement         *string `json:"requirement,omitempty"`
}

AuthenticationExecutionRepresentation struct

type AuthenticationFlowRepresentation 

type AuthenticationFlowRepresentation struct {
	Alias                    *string                                        `json:"alias,omitempty"`
	AuthenticationExecutions *[]AuthenticationExecutionExportRepresentation `json:"authenticationExecutions,omitempty"`
	BuiltIn                  *bool                                          `json:"builtIn,omitempty"`
	Description              *string                                        `json:"description,omitempty"`
	ID                       *string                                        `json:"id,omitempty"`
	ProviderID               *string                                        `json:"providerId,omitempty"`
	TopLevel                 *bool                                          `json:"topLevel,omitempty"`
}

AuthenticationFlowRepresentation struct

type AuthenticatorConfigInfoRepresentation 

type AuthenticatorConfigInfoRepresentation struct {
	HelpText   *string                         `json:"helpText,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *[]ConfigPropertyRepresentation `json:"properties,omitempty"`
	ProviderID *string                         `json:"providerId,omitempty"`
}

AuthenticatorConfigInfoRepresentation struct

type AuthenticatorConfigRepresentation 

type AuthenticatorConfigRepresentation struct {
	Alias  *string                 `json:"alias,omitempty"`
	Config *map[string]interface{} `json:"config,omitempty"`
	ID     *string                 `json:"id,omitempty"`
}

AuthenticatorConfigRepresentation struct

type CertificateRepresentation 

type CertificateRepresentation struct {
	Certificate *string `json:"certificate,omitempty"`
	Kid         *string `json:"kid,omitempty"`
	PrivateKey  *string `json:"privateKey,omitempty"`
	PublicKey   *string `json:"publicKey,omitempty"`
}

CertificateRepresentation struct

type ClientDetailedError 

type ClientDetailedError struct {
	HTTPStatus int
	Message    string
}

ClientDetailedError struct

func (ClientDetailedError) Error 

func (e ClientDetailedError) Error() string

Error implements error

func (ClientDetailedError) ErrorMessage 

func (e ClientDetailedError) ErrorMessage() string

ErrorMessage implements common-service/errors/DetailedError

func (ClientDetailedError) Status 

func (e ClientDetailedError) Status() int

Status implements common-service/errors/DetailedError

type ClientInitialAccessCreatePresentation 

type ClientInitialAccessCreatePresentation struct {
	Count      *int32 `json:"count,omitempty"`
	Expiration *int32 `json:"expiration,omitempty"`
}

ClientInitialAccessCreatePresentation struct

type ClientInitialAccessPresentation 

type ClientInitialAccessPresentation struct {
	Count          *int32  `json:"count,omitempty"`
	Expiration     *int32  `json:"expiration,omitempty"`
	ID             *string `json:"id,omitempty"`
	RemainingCount *int32  `json:"remainingCount,omitempty"`
	Timestamp      *int32  `json:"timestamp,omitempty"`
	Token          *string `json:"token,omitempty"`
}

ClientInitialAccessPresentation struct

type ClientMapperRepresentation 

type ClientMapperRepresentation struct {
	ContainerID    *string `json:"containerId,omitempty"`
	ContainerName  *string `json:"containerName,omitempty"`
	ContainerType  *string `json:"containerType,omitempty"`
	MapperID       *string `json:"mapperId,omitempty"`
	MapperName     *string `json:"mapperName,omitempty"`
	ProtocolMapper *string `json:"protocolMapper,omitempty"`
}

ClientMapperRepresentation struct https://www.keycloak.org/docs-api/9.0/rest-api/index.html#_clientscopeevaluateresource-protocolmapperevaluationrepresentation

type ClientMappingsRepresentation 

type ClientMappingsRepresentation struct {
	Client   *string               `json:"client,omitempty"`
	ID       *string               `json:"id,omitempty"`
	Mappings *[]RoleRepresentation `json:"mappings,omitempty"`
}

ClientMappingsRepresentation struct

type ClientRepresentation 

type ClientRepresentation struct {
	Access                       *map[string]interface{}         `json:"access,omitempty"`
	AdminURL                     *string                         `json:"adminUrl,omitempty"`
	Attributes                   *map[string]interface{}         `json:"attributes,omitempty"`
	AuthorizationServicesEnabled *bool                           `json:"authorizationServicesEnabled,omitempty"`
	AuthorizationSettings        *ResourceServerRepresentation   `json:"authorizationSettings,omitempty"`
	BaseURL                      *string                         `json:"baseUrl,omitempty"`
	BearerOnly                   *bool                           `json:"bearerOnly,omitempty"`
	ClientAuthenticatorType      *string                         `json:"clientAuthenticatorType,omitempty"`
	ClientID                     *string                         `json:"clientId,omitempty"`
	ClientTemplate               *string                         `json:"clientTemplate,omitempty"`
	ConsentRequired              *bool                           `json:"consentRequired,omitempty"`
	DefaultRoles                 *[]string                       `json:"defaultRoles,omitempty"`
	Description                  *string                         `json:"description,omitempty"`
	DirectAccessGrantsEnabled    *bool                           `json:"directAccessGrantsEnabled,omitempty"`
	Enabled                      *bool                           `json:"enabled,omitempty"`
	FrontchannelLogout           *bool                           `json:"frontchannelLogout,omitempty"`
	FullScopeAllowed             *bool                           `json:"fullScopeAllowed,omitempty"`
	ID                           *string                         `json:"id,omitempty"`
	ImplicitFlowEnabled          *bool                           `json:"implicitFlowEnabled,omitempty"`
	Name                         *string                         `json:"name,omitempty"`
	NodeReRegistrationTimeout    *int32                          `json:"nodeReRegistrationTimeout,omitempty"`
	NotBefore                    *int32                          `json:"notBefore,omitempty"`
	Protocol                     *string                         `json:"protocol,omitempty"`
	ProtocolMappers              *[]ProtocolMapperRepresentation `json:"protocolMappers,omitempty"`
	PublicClient                 *bool                           `json:"publicClient,omitempty"`
	RedirectUris                 *[]string                       `json:"redirectUris,omitempty"`
	RegisteredNodes              *map[string]interface{}         `json:"registeredNodes,omitempty"`
	RegistrationAccessToken      *string                         `json:"registrationAccessToken,omitempty"`
	RootURL                      *string                         `json:"rootUrl,omitempty"`
	Secret                       *string                         `json:"secret,omitempty"`
	ServiceAccountsEnabled       *bool                           `json:"serviceAccountsEnabled,omitempty"`
	StandardFlowEnabled          *bool                           `json:"standardFlowEnabled,omitempty"`
	SurrogateAuthRequired        *bool                           `json:"surrogateAuthRequired,omitempty"`
	UseTemplateConfig            *bool                           `json:"useTemplateConfig,omitempty"`
	UseTemplateMappers           *bool                           `json:"useTemplateMappers,omitempty"`
	UseTemplateScope             *bool                           `json:"useTemplateScope,omitempty"`
	WebOrigins                   *[]string                       `json:"webOrigins,omitempty"`
}

ClientRepresentation struct

type ClientTemplateRepresentation 

type ClientTemplateRepresentation struct {
	Attributes                *map[string]interface{}         `json:"attributes,omitempty"`
	BearerOnly                *bool                           `json:"bearerOnly,omitempty"`
	ConsentRequired           *bool                           `json:"consentRequired,omitempty"`
	Description               *string                         `json:"description,omitempty"`
	DirectAccessGrantsEnabled *bool                           `json:"directAccessGrantsEnabled,omitempty"`
	FrontchannelLogout        *bool                           `json:"frontchannelLogout,omitempty"`
	FullScopeAllowed          *bool                           `json:"fullScopeAllowed,omitempty"`
	ID                        *string                         `json:"id,omitempty"`
	ImplicitFlowEnabled       *bool                           `json:"implicitFlowEnabled,omitempty"`
	Name                      *string                         `json:"name,omitempty"`
	Protocol                  *string                         `json:"protocol,omitempty"`
	ProtocolMappers           *[]ProtocolMapperRepresentation `json:"protocolMappers,omitempty"`
	PublicClient              *bool                           `json:"publicClient,omitempty"`
	ServiceAccountsEnabled    *bool                           `json:"serviceAccountsEnabled,omitempty"`
	StandardFlowEnabled       *bool                           `json:"standardFlowEnabled,omitempty"`
}

ClientTemplateRepresentation struct

type ComponentExportRepresentation 

type ComponentExportRepresentation struct {
	Config        *MultivaluedHashMap `json:"config,omitempty"`
	ID            *string             `json:"id,omitempty"`
	Name          *string             `json:"name,omitempty"`
	ProviderID    *string             `json:"providerId,omitempty"`
	SubComponents *MultivaluedHashMap `json:"subComponents,omitempty"`
	SubType       *string             `json:"subType,omitempty"`
}

ComponentExportRepresentation struct

type ComponentRepresentation 

type ComponentRepresentation struct {
	Config       *MultivaluedHashMap `json:"config,omitempty"`
	ID           *string             `json:"id,omitempty"`
	Name         *string             `json:"name,omitempty"`
	ParentID     *string             `json:"parentId,omitempty"`
	ProviderID   *string             `json:"providerId,omitempty"`
	ProviderType *string             `json:"providerType,omitempty"`
	SubType      *string             `json:"subType,omitempty"`
}

ComponentRepresentation struct

type ComponentTypeRepresentation 

type ComponentTypeRepresentation struct {
	HelpText   *string                         `json:"helpText,omitempty"`
	ID         *string                         `json:"id,omitempty"`
	Metadata   *map[string]interface{}         `json:"metadata,omitempty"`
	Properties *[]ConfigPropertyRepresentation `json:"properties,omitempty"`
}

ComponentTypeRepresentation struct

type Config 

type Config struct {
	// AddrTokenProvider is deprecated. Please prefer using URIProvider
	AddrTokenProvider []string
	URIProvider       KeycloakURIProvider
	AddrAPI           string
	Timeout           time.Duration
}

Config is the keycloak client http config.

type ConfigPropertyRepresentation 

type ConfigPropertyRepresentation struct {
	DefaultValue *map[string]interface{} `json:"defaultValue,omitempty"`
	HelpText     *string                 `json:"helpText,omitempty"`
	Label        *string                 `json:"label,omitempty"`
	Name         *string                 `json:"name,omitempty"`
	Options      *[]string               `json:"options,omitempty"`
	Secret       *bool                   `json:"secret,omitempty"`
	Type         *string                 `json:"type,omitempty"`
}

ConfigPropertyRepresentation struct

type CredentialRepresentation 

type CredentialRepresentation struct {
	ID             *string `json:"id,omitempty"`
	Type           *string `json:"type,omitempty"`
	UserLabel      *string `json:"userLabel,omitempty"`
	CreatedDate    *int64  `json:"createdDate,omitempty"`
	CredentialData *string `json:"credentialData,omitempty"`
	Value          *string `json:"value,omitempty"`
	Temporary      *bool   `json:"temporary,omitempty"`
}

CredentialRepresentation struct

type DeletableUserRepresentation 

type DeletableUserRepresentation struct {
	RealmID   string `json:"realmId,omitempty"`
	RealmName string `json:"realmName,omitempty"`
	UserID    string `json:"userId,omitempty"`
	Username  string `json:"username,omitempty"`
}

DeletableUserRepresentation struct

type EmailInfoRepresentation added in v2.5.5 

type EmailInfoRepresentation struct {
	RealmName    *string `json:"realm,omitempty"`
	CreationDate *int64  `json:"creationDate,omitempty"`
}

EmailInfoRepresentation struct

type EmailRepresentation 

type EmailRepresentation struct {
	Recipient   *string                      `json:"recipient,omitempty"`
	Theming     *EmailThemingRepresentation  `json:"theming,omitempty"`
	Attachments *[]AttachementRepresentation `json:"attachments,omitempty"`
}

EmailRepresentation struct

type EmailThemingRepresentation 

type EmailThemingRepresentation struct {
	SubjectKey         *string            `json:"subjectKey,omitempty"`
	SubjectParameters  *[]string          `json:"subjectParameters,omitempty"`
	Template           *string            `json:"template,omitempty"`
	TemplateParameters *map[string]string `json:"templateParameters,omitempty"`
	Locale             *string            `json:"locale,omitempty"`
	ThemeRealmName     *string            `json:"themeRealmName,omitempty"`
}

EmailThemingRepresentation struct

type EventRepresentation 

type EventRepresentation struct {
	ClientID  *string                 `json:"clientId,omitempty"`
	Details   *map[string]interface{} `json:"details,omitempty"`
	Error     *string                 `json:"error,omitempty"`
	IPAddress *string                 `json:"ipAddress,omitempty"`
	RealmID   *string                 `json:"realmId,omitempty"`
	SessionID *string                 `json:"sessionId,omitempty"`
	Time      *int64                  `json:"time,omitempty"`
	Type      *string                 `json:"type,omitempty"`
	UserID    *string                 `json:"userId,omitempty"`
}

EventRepresentation struct

type FederatedIdentityRepresentation 

type FederatedIdentityRepresentation struct {
	IdentityProvider *string `json:"identityProvider,omitempty"`
	UserID           *string `json:"userId,omitempty"`
	UserName         *string `json:"userName,omitempty"`
}

FederatedIdentityRepresentation struct

type GlobalRequestResult 

type GlobalRequestResult struct {
	FailedRequests  *[]string `json:"failedRequests,omitempty"`
	SuccessRequests *[]string `json:"successRequests,omitempty"`
}

GlobalRequestResult struct

type GroupRepresentation 

type GroupRepresentation struct {
	Access      *map[string]interface{} `json:"access,omitempty"`
	Attributes  *map[string]interface{} `json:"attributes,omitempty"`
	ClientRoles *map[string]interface{} `json:"clientRoles,omitempty"`
	ID          *string                 `json:"id,omitempty"`
	Name        *string                 `json:"name,omitempty"`
	Path        *string                 `json:"path,omitempty"`
	RealmRoles  *[]string               `json:"realmRoles,omitempty"`
	SubGroups   *[]GroupRepresentation  `json:"subGroups,omitempty"`
}

GroupRepresentation struct

type HTTPError 

type HTTPError struct {
	HTTPStatus int
	Message    string
}

HTTPError is returned when an error occured while contacting the keycloak instance.

func (HTTPError) Error 

func (e HTTPError) Error() string

type IdentityProviderMapperRepresentation 

type IdentityProviderMapperRepresentation struct {
	Config                 *map[string]interface{} `json:"config,omitempty"`
	ID                     *string                 `json:"id,omitempty"`
	IdentityProviderAlias  *string                 `json:"identityProviderAlias,omitempty"`
	IdentityProviderMapper *string                 `json:"identityProviderMapper,omitempty"`
	Name                   *string                 `json:"name,omitempty"`
}

IdentityProviderMapperRepresentation struct

type IdentityProviderRepresentation 

type IdentityProviderRepresentation struct {
	AddReadTokenRoleOnCreate  *bool                   `json:"addReadTokenRoleOnCreate,omitempty"`
	Alias                     *string                 `json:"alias,omitempty"`
	AuthenticateByDefault     *bool                   `json:"authenticateByDefault,omitempty"`
	Config                    *map[string]interface{} `json:"config,omitempty"`
	DisplayName               *string                 `json:"displayName,omitempty"`
	Enabled                   *bool                   `json:"enabled,omitempty"`
	FirstBrokerLoginFlowAlias *string                 `json:"firstBrokerLoginFlowAlias,omitempty"`
	InternalID                *string                 `json:"internalId,omitempty"`
	LinkOnly                  *bool                   `json:"linkOnly,omitempty"`
	PostBrokerLoginFlowAlias  *string                 `json:"postBrokerLoginFlowAlias,omitempty"`
	ProviderID                *string                 `json:"providerId,omitempty"`
	StoreToken                *bool                   `json:"storeToken,omitempty"`
	TrustEmail                *bool                   `json:"trustEmail,omitempty"`
}

IdentityProviderRepresentation struct

type KeyStoreConfig 

type KeyStoreConfig struct {
	Format           *string `json:"format,omitempty"`
	KeyAlias         *string `json:"keyAlias,omitempty"`
	KeyPassword      *string `json:"keyPassword,omitempty"`
	RealmAlias       *string `json:"realmAlias,omitempty"`
	RealmCertificate *bool   `json:"realmCertificate,omitempty"`
	StorePassword    *string `json:"storePassword,omitempty"`
}

KeyStoreConfig struct

type KeycloakURIProvider 

type KeycloakURIProvider interface {
	GetDefaultKey() string
	GetAllBaseURIs() []string
	GetBaseURI(realmName string) string
	ForEachTokenURI(callback func(realm, tokenURI string))
}

KeycloakURIProvider interface

type KeysMetadataRepresentation 

type KeysMetadataRepresentation struct {
	Active *map[string]interface{}                                `json:"active,omitempty"`
	Keys   *[]KeysMetadataRepresentationKeyMetadataRepresentation `json:"keys,omitempty"`
}

KeysMetadataRepresentation struct

type KeysMetadataRepresentationKeyMetadataRepresentation 

type KeysMetadataRepresentationKeyMetadataRepresentation struct {
	Certificate      *string `json:"certificate,omitempty"`
	Kid              *string `json:"kid,omitempty"`
	ProviderID       *string `json:"providerId,omitempty"`
	ProviderPriority *int64  `json:"providerPriority,omitempty"`
	PublicKey        *string `json:"publicKey,omitempty"`
	Status           *string `json:"status,omitempty"`
	Type             *string `json:"type,omitempty"`
}

KeysMetadataRepresentationKeyMetadataRepresentation struct

type ManagementPermissionReference 

type ManagementPermissionReference struct {
	Enabled          *bool                   `json:"enabled,omitempty"`
	Resource         *string                 `json:"resource,omitempty"`
	ScopePermissions *map[string]interface{} `json:"scopePermissions,omitempty"`
}

ManagementPermissionReference struct

type MappingsRepresentation 

type MappingsRepresentation struct {
	ClientMappings *map[string]interface{} `json:"clientMappings,omitempty"`
	RealmMappings  *[]RoleRepresentation   `json:"realmMappings,omitempty"`
}

MappingsRepresentation struct

type MemoryInfoRepresentation 

type MemoryInfoRepresentation struct {
	Free           *int64  `json:"free,omitempty"`
	FreeFormated   *string `json:"freeFormated,omitempty"`
	FreePercentage *int64  `json:"freePercentage,omitempty"`
	Total          *int64  `json:"total,omitempty"`
	TotalFormated  *string `json:"totalFormated,omitempty"`
	Used           *int64  `json:"used,omitempty"`
	UsedFormated   *string `json:"usedFormated,omitempty"`
}

MemoryInfoRepresentation struct

type MultivaluedHashMap 

type MultivaluedHashMap struct {
	Empty      *bool  `json:"empty,omitempty"`
	LoadFactor *int32 `json:"loadFactor,omitempty"`
	Threshold  *int32 `json:"threshold,omitempty"`
}

MultivaluedHashMap struct

type PartialImportRepresentation 

type PartialImportRepresentation struct {
	Clients           *[]ClientRepresentation           `json:"clients,omitempty"`
	Groups            *[]GroupRepresentation            `json:"groups,omitempty"`
	IdentityProviders *[]IdentityProviderRepresentation `json:"identityProviders,omitempty"`
	IfResourceExists  *string                           `json:"ifResourceExists,omitempty"`
	Policy            *string                           `json:"policy,omitempty"`
	Roles             *RolesRepresentation              `json:"roles,omitempty"`
	Users             *[]UserRepresentation             `json:"users,omitempty"`
}

PartialImportRepresentation struct

type PasswordPolicyTypeRepresentation 

type PasswordPolicyTypeRepresentation struct {
	ConfigType        *string `json:"configType,omitempty"`
	DefaultValue      *string `json:"defaultValue,omitempty"`
	DisplayName       *string `json:"displayName,omitempty"`
	ID                *string `json:"id,omitempty"`
	MultipleSupported *bool   `json:"multipleSupported,omitempty"`
}

PasswordPolicyTypeRepresentation struct

type PolicyRepresentation 

type PolicyRepresentation struct {
	Config           *map[string]interface{} `json:"config,omitempty"`
	DecisionStrategy *string                 `json:"decisionStrategy,omitempty"`
	Description      *string                 `json:"description,omitempty"`
	ID               *string                 `json:"id,omitempty"`
	Logic            *string                 `json:"logic,omitempty"`
	Name             *string                 `json:"name,omitempty"`
	Policies         *[]string               `json:"policies,omitempty"`
	Resources        *[]string               `json:"resources,omitempty"`
	Scopes           *[]string               `json:"scopes,omitempty"`
	Type             *string                 `json:"type,omitempty"`
}

PolicyRepresentation struct

type ProfileAttrValidatorRepresentation added in v2.6.1 

type ProfileAttrValidatorRepresentation map[string]interface{}

type ProfileAttrbPermissionsRepresentation added in v2.6.1 

type ProfileAttrbPermissionsRepresentation struct {
	View []string `json:"view,omitempty"`
	Edit []string `json:"edit,omitempty"`
}

ProfileAttrbPermissionsRepresentation struct

type ProfileAttrbRepresentation added in v2.6.1 

type ProfileAttrbRepresentation struct {
	Name        *string                                `json:"name,omitempty"`
	DisplayName *string                                `json:"displayName,omitempty"`
	Group       *string                                `json:"group,omitempty"`
	Required    *ProfileAttrbRequiredRepresentation    `json:"required,omitempty"`
	Permissions *ProfileAttrbPermissionsRepresentation `json:"permissions,omitempty"`
	Validations ProfileAttrbValidationRepresentation   `json:"validations,omitempty"`
	Selector    *ProfileAttrbSelectorRepresentation    `json:"selector,omitempty"`
	Annotations map[string]string                      `json:"annotations,omitempty"`
}

ProfileAttrbRepresentation struct

func (*ProfileAttrbRepresentation) AnnotationEqualsIgnoreCase added in v2.6.1 

func (attrb *ProfileAttrbRepresentation) AnnotationEqualsIgnoreCase(key string, value string) bool

AnnotationEqualsIgnoreCase checks if an annotation

func (*ProfileAttrbRepresentation) AnnotationMatches added in v2.6.1 

func (attrb *ProfileAttrbRepresentation) AnnotationMatches(key string, matcher func(value string) bool) bool

AnnotationMatches checks if an annotation

func (*ProfileAttrbRepresentation) IsAnnotationFalse added in v2.6.1 

func (attrb *ProfileAttrbRepresentation) IsAnnotationFalse(key string) bool

IsAnnotationFalse checks if an annotation is false

func (*ProfileAttrbRepresentation) IsAnnotationTrue added in v2.6.1 

func (attrb *ProfileAttrbRepresentation) IsAnnotationTrue(key string) bool

IsAnnotationTrue checks if an annotation is true

type ProfileAttrbRequiredRepresentation added in v2.6.1 

type ProfileAttrbRequiredRepresentation struct {
	Roles  []string `json:"roles,omitempty"`
	Scopes []string `json:"scopes,omitempty"`
}

ProfileAttrbRequiredRepresentation struct

type ProfileAttrbSelectorRepresentation added in v2.6.1 

type ProfileAttrbSelectorRepresentation struct {
	Scopes []string `json:"scopes,omitempty"`
}

ProfileAttrbSelectorRepresentation struct

type ProfileAttrbValidationRepresentation added in v2.6.1 

type ProfileAttrbValidationRepresentation map[string]ProfileAttrValidatorRepresentation

ProfileAttrbValidationRepresentation struct Known keys: - email: empty - length: min, max (int/string), trim-disabled (boolean as string) - integer: min, max (integer as string) - double: min, max (double as string) - options: options (array of allowed values) - pattern: pattern (regex as string), error-message (string) - local-date: empty - uri: empty - username-prohibited-characters: error-message (string) - person-name-prohibited-characters: error-message (string)

type ProfileGroupRepresentation added in v2.6.1 

type ProfileGroupRepresentation struct {
	Name               *string           `json:"name,omitempty"`
	DisplayHeader      *string           `displayHeader:"name,omitempty"`
	DisplayDescription *string           `displayDescription:"name,omitempty"`
	Annotations        map[string]string `annotations:"name,omitempty"`
}

ProfileGroupRepresentation struct

type ProfileInfoRepresentation 

type ProfileInfoRepresentation struct {
	DisabledFeatures *[]string `json:"disabledFeatures,omitempty"`
	Name             *string   `json:"name,omitempty"`
}

ProfileInfoRepresentation struct

type ProtocolMapperRepresentation 

type ProtocolMapperRepresentation struct {
	Config          *map[string]interface{} `json:"config,omitempty"`
	ConsentRequired *bool                   `json:"consentRequired,omitempty"`
	ConsentText     *string                 `json:"consentText,omitempty"`
	ID              *string                 `json:"id,omitempty"`
	Name            *string                 `json:"name,omitempty"`
	Protocol        *string                 `json:"protocol,omitempty"`
	ProtocolMapper  *string                 `json:"protocolMapper,omitempty"`
}

ProtocolMapperRepresentation struct

type ProviderRepresentation 

type ProviderRepresentation struct {
	OperationalInfo *map[string]interface{} `json:"operationalInfo,omitempty"`
	Order           *int32                  `json:"order,omitempty"`
}

ProviderRepresentation struct

type RealmEventsConfigRepresentation 

type RealmEventsConfigRepresentation struct {
	AdminEventsDetailsEnabled *bool     `json:"adminEventsDetailsEnabled,omitempty"`
	AdminEventsEnabled        *bool     `json:"adminEventsEnabled,omitempty"`
	EnabledEventTypes         *[]string `json:"enabledEventTypes,omitempty"`
	EventsEnabled             *bool     `json:"eventsEnabled,omitempty"`
	EventsExpiration          *int64    `json:"eventsExpiration,omitempty"`
	EventsListeners           *[]string `json:"eventsListeners,omitempty"`
}

RealmEventsConfigRepresentation struct

type RealmRepresentation 

type RealmRepresentation struct {
	AccessCodeLifespan                  *int32                                  `json:"accessCodeLifespan,omitempty"`
	AccessCodeLifespanLogin             *int32                                  `json:"accessCodeLifespanLogin,omitempty"`
	AccessCodeLifespanUserAction        *int32                                  `json:"accessCodeLifespanUserAction,omitempty"`
	AccessTokenLifespan                 *int32                                  `json:"accessTokenLifespan,omitempty"`
	AccessTokenLifespanForImplicitFlow  *int32                                  `json:"accessTokenLifespanForImplicitFlow,omitempty"`
	AccountTheme                        *string                                 `json:"accountTheme,omitempty"`
	ActionTokenGeneratedByAdminLifespan *int32                                  `json:"actionTokenGeneratedByAdminLifespan,omitempty"`
	ActionTokenGeneratedByUserLifespan  *int32                                  `json:"actionTokenGeneratedByUserLifespan,omitempty"`
	AdminEventsDetailsEnabled           *bool                                   `json:"adminEventsDetailsEnabled,omitempty"`
	AdminEventsEnabled                  *bool                                   `json:"adminEventsEnabled,omitempty"`
	AdminTheme                          *string                                 `json:"adminTheme,omitempty"`
	Attributes                          *map[string]*string                     `json:"attributes,omitempty"`
	AuthenticationFlows                 *[]AuthenticationFlowRepresentation     `json:"authenticationFlows,omitempty"`
	AuthenticatorConfig                 *[]AuthenticatorConfigRepresentation    `json:"authenticatorConfig,omitempty"`
	BrowserFlow                         *string                                 `json:"browserFlow,omitempty"`
	BrowserSecurityHeaders              *map[string]interface{}                 `json:"browserSecurityHeaders,omitempty"`
	BruteForceProtected                 *bool                                   `json:"bruteForceProtected,omitempty"`
	ClientAuthenticationFlow            *string                                 `json:"clientAuthenticationFlow,omitempty"`
	ClientScopeMappings                 *map[string]interface{}                 `json:"clientScopeMappings,omitempty"`
	ClientTemplates                     *[]ClientTemplateRepresentation         `json:"clientTemplates,omitempty"`
	Clients                             *[]ClientRepresentation                 `json:"clients,omitempty"`
	Components                          *MultivaluedHashMap                     `json:"components,omitempty"`
	DefaultGroups                       *[]string                               `json:"defaultGroups,omitempty"`
	DefaultLocale                       *string                                 `json:"defaultLocale,omitempty"`
	DefaultRoles                        *[]string                               `json:"defaultRoles,omitempty"`
	DirectGrantFlow                     *string                                 `json:"directGrantFlow,omitempty"`
	DisplayName                         *string                                 `json:"displayName,omitempty"`
	DisplayNameHTML                     *string                                 `json:"displayNameHtml,omitempty"`
	DockerAuthenticationFlow            *string                                 `json:"dockerAuthenticationFlow,omitempty"`
	DuplicateEmailsAllowed              *bool                                   `json:"duplicateEmailsAllowed,omitempty"`
	EditUsernameAllowed                 *bool                                   `json:"editUsernameAllowed,omitempty"`
	EmailTheme                          *string                                 `json:"emailTheme,omitempty"`
	Enabled                             *bool                                   `json:"enabled,omitempty"`
	EnabledEventTypes                   *[]string                               `json:"enabledEventTypes,omitempty"`
	EventsEnabled                       *bool                                   `json:"eventsEnabled,omitempty"`
	EventsExpiration                    *int64                                  `json:"eventsExpiration,omitempty"`
	EventsListeners                     *[]string                               `json:"eventsListeners,omitempty"`
	FailureFactor                       *int32                                  `json:"failureFactor,omitempty"`
	FederatedUsers                      *[]UserRepresentation                   `json:"federatedUsers,omitempty"`
	Groups                              *[]GroupRepresentation                  `json:"groups,omitempty"`
	ID                                  *string                                 `json:"id,omitempty"`
	IdentityProviderMappers             *[]IdentityProviderMapperRepresentation `json:"identityProviderMappers,omitempty"`
	IdentityProviders                   *[]IdentityProviderRepresentation       `json:"identityProviders,omitempty"`
	InternationalizationEnabled         *bool                                   `json:"internationalizationEnabled,omitempty"`
	KeycloakVersion                     *string                                 `json:"keycloakVersion,omitempty"`
	LoginTheme                          *string                                 `json:"loginTheme,omitempty"`
	LoginWithEmailAllowed               *bool                                   `json:"loginWithEmailAllowed,omitempty"`
	MaxDeltaTimeSeconds                 *int32                                  `json:"maxDeltaTimeSeconds,omitempty"`
	MaxFailureWaitSeconds               *int32                                  `json:"maxFailureWaitSeconds,omitempty"`
	MinimumQuickLoginWaitSeconds        *int32                                  `json:"minimumQuickLoginWaitSeconds,omitempty"`
	NotBefore                           *int32                                  `json:"notBefore,omitempty"`
	OfflineSessionIdleTimeout           *int32                                  `json:"offlineSessionIdleTimeout,omitempty"`
	OtpPolicyAlgorithm                  *string                                 `json:"otpPolicyAlgorithm,omitempty"`
	OtpPolicyDigits                     *int32                                  `json:"otpPolicyDigits,omitempty"`
	OtpPolicyInitialCounter             *int32                                  `json:"otpPolicyInitialCounter,omitempty"`
	OtpPolicyLookAheadWindow            *int32                                  `json:"otpPolicyLookAheadWindow,omitempty"`
	OtpPolicyPeriod                     *int32                                  `json:"otpPolicyPeriod,omitempty"`
	OtpPolicyType                       *string                                 `json:"otpPolicyType,omitempty"`
	OtpSupportedApplications            *[]string                               `json:"otpSupportedApplications,omitempty"`
	PasswordPolicy                      *string                                 `json:"passwordPolicy,omitempty"`
	PermanentLockout                    *bool                                   `json:"permanentLockout,omitempty"`
	ProtocolMappers                     *[]ProtocolMapperRepresentation         `json:"protocolMappers,omitempty"`
	QuickLoginCheckMilliSeconds         *int64                                  `json:"quickLoginCheckMilliSeconds,omitempty"`
	Realm                               *string                                 `json:"realm,omitempty"`
	RefreshTokenMaxReuse                *int32                                  `json:"refreshTokenMaxReuse,omitempty"`
	RegistrationAllowed                 *bool                                   `json:"registrationAllowed,omitempty"`
	RegistrationEmailAsUsername         *bool                                   `json:"registrationEmailAsUsername,omitempty"`
	RegistrationFlow                    *string                                 `json:"registrationFlow,omitempty"`
	RememberMe                          *bool                                   `json:"rememberMe,omitempty"`
	RequiredActions                     *[]RequiredActionProviderRepresentation `json:"requiredActions,omitempty"`
	ResetCredentialsFlow                *string                                 `json:"resetCredentialsFlow,omitempty"`
	ResetPasswordAllowed                *bool                                   `json:"resetPasswordAllowed,omitempty"`
	RevokeRefreshToken                  *bool                                   `json:"revokeRefreshToken,omitempty"`
	Roles                               *RolesRepresentation                    `json:"roles,omitempty"`
	ScopeMappings                       *[]ScopeMappingRepresentation           `json:"scopeMappings,omitempty"`
	SMTPServer                          *map[string]interface{}                 `json:"smtpServer,omitempty"`
	SslRequired                         *string                                 `json:"sslRequired,omitempty"`
	SsoSessionIdleTimeout               *int32                                  `json:"ssoSessionIdleTimeout,omitempty"`
	SsoSessionMaxLifespan               *int32                                  `json:"ssoSessionMaxLifespan,omitempty"`
	SupportedLocales                    *[]string                               `json:"supportedLocales,omitempty"`
	UserFederationMappers               *[]UserFederationMapperRepresentation   `json:"userFederationMappers,omitempty"`
	UserFederationProviders             *[]UserFederationProviderRepresentation `json:"userFederationProviders,omitempty"`
	Users                               *[]UserRepresentation                   `json:"users,omitempty"`
	VerifyEmail                         *bool                                   `json:"verifyEmail,omitempty"`
	WaitIncrementSeconds                *int32                                  `json:"waitIncrementSeconds,omitempty"`
}

RealmRepresentation struct

func (*RealmRepresentation) IsUserProfileEnabled added in v2.6.1 

func (r *RealmRepresentation) IsUserProfileEnabled() bool

IsUserProfileEnabled tells if user profile is enabled for the given realm

type RecoveryCodeRepresentation 

type RecoveryCodeRepresentation struct {
	Code *string `json:"code,omitempty"`
}

RecoveryCodeRepresentation struct

type RequiredActionProviderRepresentation 

type RequiredActionProviderRepresentation struct {
	Alias         *string                 `json:"alias,omitempty"`
	Config        *map[string]interface{} `json:"config,omitempty"`
	DefaultAction *bool                   `json:"defaultAction,omitempty"`
	Enabled       *bool                   `json:"enabled,omitempty"`
	Name          *string                 `json:"name,omitempty"`
	ProviderID    *string                 `json:"providerId,omitempty"`
}

RequiredActionProviderRepresentation struct

type ResourceOwnerRepresentation 

type ResourceOwnerRepresentation struct {
	ID   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

ResourceOwnerRepresentation struct

type ResourceRepresentation 

type ResourceRepresentation struct {
	ID          *string                      `json:"id,omitempty"`
	IconURI     *string                      `json:"icon_uri,omitempty"`
	Name        *string                      `json:"name,omitempty"`
	Owner       *ResourceOwnerRepresentation `json:"owner,omitempty"`
	Policies    *[]PolicyRepresentation      `json:"policies,omitempty"`
	Scopes      *[]ScopeRepresentation       `json:"scopes,omitempty"`
	Type        *string                      `json:"type,omitempty"`
	TypedScopes *[]ScopeRepresentation       `json:"typedScopes,omitempty"`
	URI         *string                      `json:"uri,omitempty"`
}

ResourceRepresentation struct

type ResourceServerRepresentation 

type ResourceServerRepresentation struct {
	AllowRemoteResourceManagement *bool                     `json:"allowRemoteResourceManagement,omitempty"`
	ClientID                      *string                   `json:"clientId,omitempty"`
	ID                            *string                   `json:"id,omitempty"`
	Name                          *string                   `json:"name,omitempty"`
	Policies                      *[]PolicyRepresentation   `json:"policies,omitempty"`
	PolicyEnforcementMode         *string                   `json:"policyEnforcementMode,omitempty"`
	Resources                     *[]ResourceRepresentation `json:"resources,omitempty"`
	Scopes                        *[]ScopeRepresentation    `json:"scopes,omitempty"`
}

ResourceServerRepresentation struct

type RoleRepresentation 

type RoleRepresentation struct {
	ClientRole         *bool                         `json:"clientRole,omitempty"`
	Composite          *bool                         `json:"composite,omitempty"`
	Composites         *RoleRepresentationComposites `json:"composites,omitempty"`
	ContainerID        *string                       `json:"containerId,omitempty"`
	Description        *string                       `json:"description,omitempty"`
	ID                 *string                       `json:"id,omitempty"`
	Name               *string                       `json:"name,omitempty"`
	ScopeParamRequired *bool                         `json:"scopeParamRequired,omitempty"`
	Attributes         *map[string][]string          `json:"attributes,omitempty"`
}

RoleRepresentation struct

type RoleRepresentationComposites 

type RoleRepresentationComposites struct {
	Client *map[string]interface{} `json:"client,omitempty"`
	Realm  *[]string               `json:"realm,omitempty"`
}

RoleRepresentationComposites struct

type RolesRepresentation 

type RolesRepresentation struct {
	Client *map[string]interface{} `json:"client,omitempty"`
	Realm  *[]RoleRepresentation   `json:"realm,omitempty"`
}

RolesRepresentation struct

type SMSRepresentation 

type SMSRepresentation struct {
	MSISDN  *string                   `json:"msisdn,omitempty"`
	Theming *SMSThemingRepresentation `json:"theming,omitempty"`
}

SMSRepresentation struct

type SMSThemingRepresentation 

type SMSThemingRepresentation struct {
	MessageKey        *string   `json:"messageKey,omitempty"`
	MessageParameters *[]string `json:"messageParameters,omitempty"`
	Locale            *string   `json:"locale,omitempty"`
}

SMSThemingRepresentation struct

type ScopeMappingRepresentation 

type ScopeMappingRepresentation struct {
	Client         *string   `json:"client,omitempty"`
	ClientTemplate *string   `json:"clientTemplate,omitempty"`
	Roles          *[]string `json:"roles,omitempty"`
	Self           *string   `json:"self,omitempty"`
}

ScopeMappingRepresentation struct

type ScopeRepresentation 

type ScopeRepresentation struct {
	IconURI   *string                   `json:"iconUri,omitempty"`
	ID        *string                   `json:"id,omitempty"`
	Name      *string                   `json:"name,omitempty"`
	Policies  *[]PolicyRepresentation   `json:"policies,omitempty"`
	Resources *[]ResourceRepresentation `json:"resources,omitempty"`
}

ScopeRepresentation struct

type ServerInfoRepresentation 

type ServerInfoRepresentation struct {
	BuiltinProtocolMappers *map[string]interface{}             `json:"builtinProtocolMappers,omitempty"`
	ClientImporters        *[]map[string]interface{}           `json:"clientImporters,omitempty"`
	ClientInstallations    *map[string]interface{}             `json:"clientInstallations,omitempty"`
	ComponentTypes         *map[string]interface{}             `json:"componentTypes,omitempty"`
	Enums                  *map[string]interface{}             `json:"enums,omitempty"`
	IdentityProviders      *[]map[string]interface{}           `json:"identityProviders,omitempty"`
	MemoryInfo             *MemoryInfoRepresentation           `json:"memoryInfo,omitempty"`
	PasswordPolicies       *[]PasswordPolicyTypeRepresentation `json:"passwordPolicies,omitempty"`
	ProfileInfo            *ProfileInfoRepresentation          `json:"profileInfo,omitempty"`
	ProtocolMapperTypes    *map[string]interface{}             `json:"protocolMapperTypes,omitempty"`
	Providers              *map[string]interface{}             `json:"providers,omitempty"`
	SocialProviders        *[]map[string]interface{}           `json:"socialProviders,omitempty"`
	SystemInfo             *SystemInfoRepresentation           `json:"systemInfo,omitempty"`
	Themes                 *map[string]interface{}             `json:"themes,omitempty"`
}

ServerInfoRepresentation struct

type SmsCodeRepresentation 

type SmsCodeRepresentation struct {
	Code *string `json:"code,omitempty"`
}

SmsCodeRepresentation struct

type SpiInfoRepresentation 

type SpiInfoRepresentation struct {
	Internal  *bool                   `json:"internal,omitempty"`
	Providers *map[string]interface{} `json:"providers,omitempty"`
}

SpiInfoRepresentation struct

type StatisticsUsersRepresentation 

type StatisticsUsersRepresentation struct {
	Total    int64 `json:"total,omitempty"`
	Disabled int64 `json:"disabled,omitempty"`
	Inactive int64 `json:"inactive,omitempty"`
}

StatisticsUsersRepresentation elements returned by GetStatisticsUsers

type SynchronizationResult 

type SynchronizationResult struct {
	Added   *int32  `json:"added,omitempty"`
	Failed  *int32  `json:"failed,omitempty"`
	Ignored *bool   `json:"ignored,omitempty"`
	Removed *int32  `json:"removed,omitempty"`
	Status  *string `json:"status,omitempty"`
	Updated *int32  `json:"updated,omitempty"`
}

SynchronizationResult struct

type SystemInfoRepresentation 

type SystemInfoRepresentation struct {
	FileEncoding   *string `json:"fileEncoding,omitempty"`
	JavaHome       *string `json:"javaHome,omitempty"`
	JavaRuntime    *string `json:"javaRuntime,omitempty"`
	JavaVendor     *string `json:"javaVendor,omitempty"`
	JavaVersion    *string `json:"javaVersion,omitempty"`
	JavaVM         *string `json:"javaVm,omitempty"`
	JavaVMVersion  *string `json:"javaVmVersion,omitempty"`
	OsArchitecture *string `json:"osArchitecture,omitempty"`
	OsName         *string `json:"osName,omitempty"`
	OsVersion      *string `json:"osVersion,omitempty"`
	ServerTime     *string `json:"serverTime,omitempty"`
	Uptime         *string `json:"uptime,omitempty"`
	UptimeMillis   *int64  `json:"uptimeMillis,omitempty"`
	UserDir        *string `json:"userDir,omitempty"`
	UserLocale     *string `json:"userLocale,omitempty"`
	UserName       *string `json:"userName,omitempty"`
	UserTimezone   *string `json:"userTimezone,omitempty"`
	Version        *string `json:"version,omitempty"`
}

SystemInfoRepresentation struct

type TrustIDAuthTokenRepresentation added in v2.5.7 

type TrustIDAuthTokenRepresentation struct {
	Token *string `json:"token"`
}

TrustIDAuthTokenRepresentation struct

type UserConsentRepresentation 

type UserConsentRepresentation struct {
	ClientID               *string                 `json:"clientId,omitempty"`
	CreatedDate            *int64                  `json:"createdDate,omitempty"`
	GrantedClientRoles     *map[string]interface{} `json:"grantedClientRoles,omitempty"`
	GrantedProtocolMappers *map[string]interface{} `json:"grantedProtocolMappers,omitempty"`
	GrantedRealmRoles      *[]string               `json:"grantedRealmRoles,omitempty"`
	LastUpdatedDate        *int64                  `json:"lastUpdatedDate,omitempty"`
}

UserConsentRepresentation struct

type UserFederationMapperRepresentation 

type UserFederationMapperRepresentation struct {
	Config                        *map[string]interface{} `json:"config,omitempty"`
	FederationMapperType          *string                 `json:"federationMapperType,omitempty"`
	FederationProviderDisplayName *string                 `json:"federationProviderDisplayName,omitempty"`
	ID                            *string                 `json:"id,omitempty"`
	Name                          *string                 `json:"name,omitempty"`
}

UserFederationMapperRepresentation struct

type UserFederationProviderRepresentation 

type UserFederationProviderRepresentation struct {
	ChangedSyncPeriod *int32                  `json:"changedSyncPeriod,omitempty"`
	Config            *map[string]interface{} `json:"config,omitempty"`
	DisplayName       *string                 `json:"displayName,omitempty"`
	FullSyncPeriod    *int32                  `json:"fullSyncPeriod,omitempty"`
	ID                *string                 `json:"id,omitempty"`
	LastSync          *int32                  `json:"lastSync,omitempty"`
	Priority          *int32                  `json:"priority,omitempty"`
	ProviderName      *string                 `json:"providerName,omitempty"`
}

UserFederationProviderRepresentation struct

type UserProfileRepresentation added in v2.6.1 

type UserProfileRepresentation struct {
	Attributes []ProfileAttrbRepresentation `json:"attributes"`
	Groups     []ProfileGroupRepresentation `json:"groups"`
}

UserProfileRepresentation struct

type UserRepresentation 

type UserRepresentation struct {
	Access                     *map[string]bool                   `json:"access,omitempty"`
	Attributes                 *Attributes                        `json:"attributes,omitempty"`
	ClientConsents             *[]UserConsentRepresentation       `json:"clientConsents,omitempty"`
	ClientRoles                *map[string][]string               `json:"clientRoles,omitempty"`
	CreatedTimestamp           *int64                             `json:"createdTimestamp,omitempty"`
	Credentials                *[]CredentialRepresentation        `json:"credentials,omitempty"`
	DisableableCredentialTypes *[]string                          `json:"disableableCredentialTypes,omitempty"`
	Email                      *string                            `json:"email,omitempty"`
	EmailVerified              *bool                              `json:"emailVerified,omitempty"`
	Enabled                    *bool                              `json:"enabled,omitempty"`
	FederatedIdentities        *[]FederatedIdentityRepresentation `json:"federatedIdentities,omitempty"`
	FederationLink             *string                            `json:"federationLink,omitempty"`
	FirstName                  *string                            `json:"firstName,omitempty"`
	Groups                     *[]string                          `json:"groups,omitempty"`
	ID                         *string                            `json:"id,omitempty"`
	LastName                   *string                            `json:"lastName,omitempty"`
	NotBefore                  *int32                             `json:"notBefore,omitempty"`
	Origin                     *string                            `json:"origin,omitempty"`
	RealmRoles                 *[]string                          `json:"realmRoles,omitempty"`
	RequiredActions            *[]string                          `json:"requiredActions,omitempty"`
	Self                       *string                            `json:"self,omitempty"`
	ServiceAccountClientID     *string                            `json:"serviceAccountClientId,omitempty"`
	Username                   *string                            `json:"username,omitempty"`
}

UserRepresentation struct

func (*UserRepresentation) GetAttribute 

func (u *UserRepresentation) GetAttribute(key AttributeKey) []string

GetAttribute returns an attribute given its key

func (*UserRepresentation) GetAttributeBool 

func (u *UserRepresentation) GetAttributeBool(key AttributeKey) (*bool, error)

GetAttributeBool returns the first value of an attribute given its key

func (*UserRepresentation) GetAttributeDate 

func (u *UserRepresentation) GetAttributeDate(key AttributeKey, dateLayouts []string) *string

GetAttributeDate returns an attribute which contains a date value

func (*UserRepresentation) GetAttributeInt 

func (u *UserRepresentation) GetAttributeInt(key AttributeKey) (*int, error)

GetAttributeInt returns the first value of an attribute given its key

func (*UserRepresentation) GetAttributeString 

func (u *UserRepresentation) GetAttributeString(key AttributeKey) *string

GetAttributeString returns the first value of an attribute given its key

func (*UserRepresentation) GetAttributeTime 

func (u *UserRepresentation) GetAttributeTime(key AttributeKey, dateLayouts []string) (*time.Time, error)

GetAttributeTime returns an attribute which contains a date value

func (*UserRepresentation) GetFieldValues added in v2.6.0 

func (u *UserRepresentation) GetFieldValues(field fields.Field) []string

GetFieldValues returns a field value

func (*UserRepresentation) RemoveAttribute 

func (u *UserRepresentation) RemoveAttribute(key AttributeKey)

RemoveAttribute removes an attribute given its key

func (*UserRepresentation) SetAttribute 

func (u *UserRepresentation) SetAttribute(key AttributeKey, value []string)

SetAttribute sets an attribute

func (*UserRepresentation) SetAttributeBool 

func (u *UserRepresentation) SetAttributeBool(key AttributeKey, value bool)

SetAttributeBool sets an attribute with a single value

func (*UserRepresentation) SetAttributeDate 

func (u *UserRepresentation) SetAttributeDate(key AttributeKey, date string, dateLayouts []string)

SetAttributeDate sets a date attribute

func (*UserRepresentation) SetAttributeInt 

func (u *UserRepresentation) SetAttributeInt(key AttributeKey, value int)

SetAttributeInt sets an attribute with a single value

func (*UserRepresentation) SetAttributeString 

func (u *UserRepresentation) SetAttributeString(key AttributeKey, value string)

SetAttributeString sets an attribute with a single value

func (*UserRepresentation) SetAttributeTime 

func (u *UserRepresentation) SetAttributeTime(key AttributeKey, date time.Time, dateLayout string)

SetAttributeTime sets a date attribute

func (*UserRepresentation) SetFieldValues added in v2.6.0 

func (u *UserRepresentation) SetFieldValues(field fields.Field, values []string)

SetFieldValues sets a field value

type UserSessionRepresentation 

type UserSessionRepresentation struct {
	Clients    *map[string]interface{} `json:"clients,omitempty"`
	ID         *string                 `json:"id,omitempty"`
	IPAddress  *string                 `json:"ipAddress,omitempty"`
	LastAccess *int64                  `json:"lastAccess,omitempty"`
	Start      *int64                  `json:"start,omitempty"`
	UserID     *string                 `json:"userId,omitempty"`
	Username   *string                 `json:"username,omitempty"`
}

UserSessionRepresentation struct

type UsersPageRepresentation 

type UsersPageRepresentation struct {
	Count *int                 `json:"count,omitempty"`
	Users []UserRepresentation `json:"users,omitempty"`
}

UsersPageRepresentation is used to manage users paging

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.