gocloak

package module

Go to main page

Versions in this module

v3

v3.10.0

Dec 9, 2019

Changes in this version

type GetGroupsParams

+ Full bool

type Group

+ Access map[string]bool

+ Attributes map[string][]string

+ ClientRoles map[string][]string

+ RealmRoles []string

v3.9.0

Dec 7, 2019

Changes in this version

type GoCloak

+ GetGroupMembers func(accessToken string, realm, groupID string, params GetGroupsParams) ([]*User, error)

v3.8.0

Nov 27, 2019

Changes in this version

type GoCloak

+ SetRestyClient func(restyClient resty.Client)

v3.7.0

Nov 20, 2019

Changes in this version

type GoCloak

+ AddClientRoleToUser func(token string, realm string, clientID string, userID string, roles []Role) error

+ ClearRealmCache func(token string, realm string) error

+ DeleteClientRoleFromUser func(token string, realm string, clientID string, userID string, roles []Role) error

type HTTPErrorResponse

+ Error string

+ type StringOrArray []string

+ func (s *StringOrArray) UnmarshalJSON(data []byte) error

+ func (s StringOrArray) MarshalJSON() ([]byte, error)

v3.6.0

Nov 19, 2019

Changes in this version

type GoCloak

+ GetRealms func(token string) ([]*RealmRepresentation, error)

v3.5.2

Nov 13, 2019

v3.5.1

Sep 29, 2019

v3.5.0

Sep 19, 2019

Changes in this version

type GoCloak

+ AddDefaultScopeToClient func(token string, realm string, clientID string, scopeID string) error

+ AddOptionalScopeToClient func(token string, realm string, clientID string, scopeID string) error

+ CreateClientProtocolMapper func(token, realm, clientID string, mapper ProtocolMapperRepresentation) error

+ DeleteClientProtocolMapper func(token, realm, clientID, mapperID string) error

+ GetClientScopes func(token string, realm string) ([]*ClientScope, error)

+ GetClientsDefaultScopes func(token string, realm string, clientID string) ([]*ClientScope, error)

+ GetClientsOptionalScopes func(token string, realm string, clientID string) ([]*ClientScope, error)

+ GetDefaultDefaultClientScopes func(token string, realm string) ([]*ClientScope, error)

+ GetDefaultOptionalClientScopes func(token string, realm string) ([]*ClientScope, error)

+ RemoveDefaultScopeFromClient func(token string, realm string, clientID string, scopeID string) error

+ RemoveOptionalScopeFromClient func(token string, realm string, clientID string, scopeID string) error

type ProtocolMappersConfig

+ IncludedClientAudience string

+ Multivalued string

+ UsermodelClientRoleMappingClientID string

v3.4.0

Jul 19, 2019

Changes in this version

type GoCloak

+ LogoutPublicClient func(clientID, realm, accessToken, refreshToken string) error

v3.3.0

Jun 28, 2019

Changes in this version

type GoCloak

+ GetClientServiceAccount func(token string, realm string, clientID string) (*User, error)

type User

+ Credentials []*CredentialRepresentation

+ ServiceAccountClientID string

v3.2.0

Jun 24, 2019

Changes in this version

type GoCloak

+ GetClientScope func(token string, realm string, scopeID string) (*ClientScope, error)

+ RegenerateClientSecret func(token string, realm string, clientID string) (*CredentialRepresentation, error)

type User

+ ClientRoles map[string][]string

+ RealmRoles []string

v3.1.0

Jun 7, 2019

v3.0.1

Jun 7, 2019

v3.0.0

Jun 5, 2019

Changes in this version

+ func GetQueryParams(s interface{}) (map[string]string, error)

+ func IsObjectAlreadyExists(err error) bool

+ type APIError struct

+ Code int

+ Message string

+ func (apiError APIError) Error() string

+ type Access struct

+ Impersonate bool

+ Manage bool

+ ManageGroupMembership bool

+ MapRoles bool

+ View bool

+ type ActiveKeys struct

+ AES string

+ HS256 string

+ RS256 string

+ type Attributes struct

+ LDAPENTRYDN []string

+ LDAPID []string

+ type CertResponse struct

+ Keys []CertResponseKey

+ type CertResponseKey struct

+ Alg string

+ E string

+ Kid string

+ Kty string

+ N string

+ Use string

+ type Client struct

+ Access map[string]interface{}

+ AdminURL string

+ Attributes map[string]string

+ AuthenticationFlowBindingOverrides map[string]string

+ AuthorizationServicesEnabled bool

+ AuthorizationSettings *ResourceServerRepresentation

+ BaseURL string

+ BearerOnly bool

+ ClientAuthenticatorType string

+ ClientID string

+ ConsentRequired bool

+ DefaultClientScopes []string

+ DefaultRoles []string

+ Description string

+ DirectAccessGrantsEnabled bool

+ Enabled bool

+ FrontChannelLogout bool

+ FullScopeAllowed bool

+ ID string

+ ImplicitFlowEnabled bool

+ Name string

+ NodeReRegistrationTimeout int32

+ NotBefore int32

+ OptionalClientScopes []string

+ Origin string

+ Protocol string

+ ProtocolMappers []ProtocolMapperRepresentation

+ PublicClient bool

+ RedirectURIs []string

+ RegisteredNodes map[string]string

+ RegistrationAccessToken string

+ RootURL string

+ Secret string

+ ServiceAccountsEnabled bool

+ StandardFlowEnabled bool

+ SurrogateAuthRequired bool

+ WebOrigins []string

+ type ClientMappingsRepresentation struct

+ Client string

+ ID string

+ Mappings []Role

+ type ClientScope struct

+ ClientScopeAttributes *ClientScopeAttributes

+ Description string

+ ID string

+ Name string

+ Protocol string

+ ProtocolMappers []ProtocolMappers

+ type ClientScopeAttributes struct

+ ConsentScreenText string

+ DisplayOnConsentScreen string

+ IncludeInTokenScope string

+ type Component struct

+ ComponentConfig ComponentConfig

+ ID string

+ Name string

+ ParentID string

+ ProviderID string

+ ProviderType string

+ SubType string

+ type ComponentConfig struct

+ Algorithm []string

+ Priority []string

+ type CredentialRepresentation struct

+ Algorithm string

+ Config MultivaluedHashMap

+ Counter int32

+ CreatedDate int64

+ Device string

+ Digits int32

+ HashIterations int32

+ HashedSaltedValue string

+ Period int32

+ Salt string

+ Temporary bool

+ Type string

+ Value string

+ type DecisionStrategy int

+ const AFFIRMATIVE

+ const CONSENSUS

+ const UNANIMOUS

+ type ExecuteActionsEmail struct

+ Actions []string

+ ClientID string

+ Lifespan int

+ RedirectURI string

+ UserID string

+ type GetClientsParams struct

+ ClientID string

+ ViewableOnly bool

+ type GetGroupsParams struct

+ First int

+ Max int

+ Search string

+ type GetUsersParams struct

+ BriefRepresentation bool

+ Email string

+ First int

+ FirstName string

+ LastName string

+ Max int

+ Search string

+ Username string

+ type GoCloak interface

+ AddRealmRoleComposite func(token string, realm string, roleName string, roles []Role) error

+ AddRealmRoleToUser func(token string, realm string, userID string, roles []Role) error

+ AddUserToGroup func(token string, realm string, userID string, groupID string) error

+ CreateClient func(accessToken string, realm string, clientID Client) error

+ CreateClientRole func(accessToken string, realm string, clientID string, role Role) error

+ CreateClientScope func(accessToken string, realm string, scope ClientScope) error

+ CreateComponent func(accessToken string, realm string, component Component) error

+ CreateGroup func(accessToken string, realm string, group Group) error

+ CreateRealm func(token string, realm RealmRepresentation) error

+ CreateRealmRole func(token string, realm string, role Role) error

+ CreateUser func(token string, realm string, user User) (string, error)

+ DecodeAccessToken func(accessToken string, realm string) (*jwt.Token, *jwt.MapClaims, error)

+ DecodeAccessTokenCustomClaims func(accessToken string, realm string, claims jwt.Claims) (*jwt.Token, error)

+ DeleteClient func(accessToken string, realm, clientID string) error

+ DeleteClientRole func(accessToken string, realm, clientID, roleName string) error

+ DeleteClientScope func(accessToken string, realm, scopeID string) error

+ DeleteComponent func(accessToken string, realm, componentID string) error

+ DeleteGroup func(accessToken string, realm, groupID string) error

+ DeleteRealm func(token string, realm string) error

+ DeleteRealmRole func(token string, realm string, roleName string) error

+ DeleteRealmRoleComposite func(token string, realm string, roleName string, roles []Role) error

+ DeleteRealmRoleFromUser func(token string, realm string, userID string, roles []Role) error

+ DeleteUser func(accessToken string, realm, userID string) error

+ DeleteUserFromGroup func(token string, realm string, userID string, groupID string) error

+ ExecuteActionsEmail func(token string, realm string, params ExecuteActionsEmail) error

+ GetCerts func(realm string) (*CertResponse, error)

+ GetClient func(accessToken string, realm string, clientID string) (*Client, error)

+ GetClientOfflineSessions func(token, realm, clientID string) ([]*UserSessionRepresentation, error)

+ GetClientRole func(token string, realm string, clientID string, roleName string) (*Role, error)

+ GetClientRoles func(accessToken string, realm string, clientID string) ([]*Role, error)

+ GetClientSecret func(token string, realm string, clientID string) (*CredentialRepresentation, error)

+ GetClientUserSessions func(token, realm, clientID string) ([]*UserSessionRepresentation, error)

+ GetClients func(accessToken string, realm string, params GetClientsParams) ([]*Client, error)

+ GetComponents func(accessToken string, realm string) ([]*Component, error)

+ GetGroup func(accessToken string, realm, groupID string) (*Group, error)

+ GetGroups func(accessToken string, realm string, params GetGroupsParams) ([]*Group, error)

+ GetIssuer func(realm string) (*IssuerResponse, error)

+ GetKeyStoreConfig func(accessToken string, realm string) (*KeyStoreConfig, error)

+ GetRealm func(token string, realm string) (*RealmRepresentation, error)

+ GetRealmRole func(token string, realm string, roleName string) (*Role, error)

+ GetRealmRoles func(accessToken string, realm string) ([]*Role, error)

+ GetRealmRolesByGroupID func(accessToken string, realm string, groupID string) ([]*Role, error)

+ GetRealmRolesByUserID func(accessToken string, realm string, userID string) ([]*Role, error)

+ GetRoleMappingByGroupID func(accessToken string, realm string, groupID string) (*MappingsRepresentation, error)

+ GetRoleMappingByUserID func(accessToken string, realm string, userID string) (*MappingsRepresentation, error)

+ GetServerInfo func(accessToken string) (*ServerInfoRepesentation, error)

+ GetToken func(realm string, options TokenOptions) (*JWT, error)

+ GetUserByID func(accessToken string, realm string, userID string) (*User, error)

+ GetUserCount func(accessToken string, realm string) (int, error)

+ GetUserGroups func(accessToken string, realm string, userID string) ([]*UserGroup, error)

+ GetUserInfo func(accessToken string, realm string) (*UserInfo, error)

+ GetUserOfflineSessionsForClient func(token, realm, userID, clientID string) ([]*UserSessionRepresentation, error)

+ GetUserSessions func(token, realm, userID string) ([]*UserSessionRepresentation, error)

+ GetUsers func(accessToken string, realm string, params GetUsersParams) ([]*User, error)

+ GetUsersByRoleName func(token string, realm string, roleName string) ([]*User, error)

+ Login func(clientID, clientSecret, realm, username, password string) (*JWT, error)

+ LoginAdmin func(username, password, realm string) (*JWT, error)

+ LoginClient func(clientID, clientSecret, realm string) (*JWT, error)

+ Logout func(clientID, clientSecret, realm, refreshToken string) error

+ RefreshToken func(refreshToken string, clientID, clientSecret, realm string) (*JWT, error)

+ RequestPermission func(clientID, clientSecret, realm, username, password, permission string) (*JWT, error)

+ RestyClient func() *resty.Client

+ RetrospectToken func(accessToken string, clientID, clientSecret string, realm string) (*RetrospecTokenResult, error)

+ SetPassword func(token string, userID string, realm string, password string, temporary bool) error

+ UpdateClient func(accessToken string, realm string, updatedClient Client) error

+ UpdateClientScope func(accessToken string, realm string, scope ClientScope) error

+ UpdateGroup func(accessToken string, realm string, updatedGroup Group) error

+ UpdateRealmRole func(token string, realm string, roleName string, role Role) error

+ UpdateRole func(accessToken string, realm string, clientID string, role Role) error

+ UpdateUser func(accessToken string, realm string, user User) error

+ UserAttributeContains func(attributes map[string][]string, attribute string, value string) bool

+ func NewClient(basePath string) GoCloak

+ type Group struct

+ ID string

+ Name string

+ Path string

+ SubGroups []interface{}

+ type HTTPErrorResponse struct

+ ErrorMessage string

+ type IssuerResponse struct

+ AccountService string

+ PublicKey string

+ Realm string

+ TokenService string

+ TokensNotBefore int

+ type JWT struct

+ AccessToken string

+ ExpiresIn int

+ IDToken string

+ NotBeforePolicy int

+ RefreshExpiresIn int

+ RefreshToken string

+ Scope string

+ SessionState string

+ TokenType string

+ type Key struct

+ Algorithm string

+ Certificate string

+ Kid string

+ ProviderID string

+ ProviderPriority int

+ PublicKey string

+ Status string

+ Type string

+ type KeyStoreConfig struct

+ ActiveKeys ActiveKeys

+ Key []Key

+ type Logic int

+ const NEGATIVE

+ const POSITIVE

+ type MappingsRepresentation struct

+ ClientMappings map[string]ClientMappingsRepresentation

+ RealmMappings []Role

+ type MemoryInfoRepresentation struct

+ Free int

+ FreeFormated string

+ FreePercentage int

+ Total int

+ TotalFormated string

+ Used int

+ UsedFormated string

+ type MultivaluedHashMap struct

+ Empty bool

+ LoadFactor float32

+ Threshold int32

+ type ObjectAlreadyExists struct

+ ErrorMessage string

+ func (e *ObjectAlreadyExists) Error() string

+ type PolicyEnforcementMode int

+ const DISABLED

+ const ENFORCING

+ const PERMISSIVE

+ type PolicyRepresentation struct

+ Config map[string]string

+ DecisionStrategy *DecisionStrategy

+ Description string

+ ID string

+ Logic *Logic

+ Name string

+ Owner string

+ Policies []string

+ Resources []string

+ Scopes []string

+ Type string

+ type ProtocolMapperRepresentation struct

+ Config map[string]string

+ ID string

+ Name string

+ Protocol string

+ ProtocolMapper string

+ type ProtocolMappers struct

+ ConsentRequired bool

+ ID string

+ Name string

+ Protocol string

+ ProtocolMapper string

+ ProtocolMappersConfig ProtocolMappersConfig

+ type ProtocolMappersConfig struct

+ AccessTokenClaim string

+ ClaimName string

+ ClaimValue string

+ IDTokenClaim string

+ JSONTypeLabel string

+ UserAttribute string

+ UserinfoTokenClaim string

+ type RealmRepresentation struct

+ AccessCodeLifespan int

+ AccessCodeLifespanLogin int

+ AccessCodeLifespanUserAction int

+ AccessTokenLifespan int

+ AccessTokenLifespanForImplicitFlow int

+ AccountTheme string

+ ActionTokenGeneratedByAdminLifespan int

+ ActionTokenGeneratedByUserLifespan int

+ AdminEventsDetailsEnabled bool

+ AdminEventsEnabled bool

+ AdminTheme string

+ Attributes map[string]string

+ AuthenticationFlows []interface{}

+ AuthenticatorConfig []interface{}

+ BrowserFlow string

+ BrowserSecurityHeaders map[string]string

+ BruteForceProtected bool

+ ClientAuthenticationFlow string

+ ClientScopeMappings map[string]string

+ ClientScopes []ClientScope

+ Clients []Client

+ Components interface{}

+ DefaultDefaultClientScopes []string

+ DefaultGroups []string

+ DefaultLocale string

+ DefaultOptionalClientScopes []string

+ DefaultRoles []string

+ DefaultSignatureAlgorithm string

+ DirectGrantFlow string

+ DisplayName string

+ DisplayNameHTML string

+ DockerAuthenticationFlow string

+ DuplicateEmailsAllowed bool

+ EditUsernameAllowed bool

+ EmailTheme string

+ Enabled bool

+ EnabledEventTypes []string

+ EventsEnabled bool

+ EventsExpiration int64

+ EventsListeners []string

+ FailureFactor int

+ FederatedUsers []interface{}

+ Groups []interface{}

+ ID string

+ IdentityProviderMappers []interface{}

+ IdentityProviders []interface{}

+ InternationalizationEnabled bool

+ KeycloakVersion string

+ LoginTheme string

+ LoginWithEmailAllowed bool

+ MaxDeltaTimeSeconds int

+ MaxFailureWaitSeconds int

+ MinimumQuickLoginWaitSeconds int

+ NotBefore int

+ OfflineSessionIdleTimeout int

+ OfflineSessionMaxLifespan int

+ OfflineSessionMaxLifespanEnabled bool

+ OtpPolicyAlgorithm string

+ OtpPolicyDigits int

+ OtpPolicyInitialCounter int

+ OtpPolicyLookAheadWindow int

+ OtpPolicyPeriod int

+ OtpPolicyType string

+ OtpSupportedApplications []string

+ PasswordPolicy string

+ PermanentLockout bool

+ ProtocolMappers []interface{}

+ QuickLoginCheckMilliSeconds int64

+ Realm string

+ RefreshTokenMaxReuse int

+ RegistrationAllowed bool

+ RegistrationEmailAsUsername bool

+ RegistrationFlow string

+ RememberMe bool

+ RequiredActions []interface{}

+ ResetCredentialsFlow string

+ ResetPasswordAllowed bool

+ RevokeRefreshToken bool

+ Roles interface{}

+ SMTPServer map[string]string

+ ScopeMappings []interface{}

+ SslRequired string

+ SsoSessionIdleTimeout int

+ SsoSessionIdleTimeoutRememberMe int

+ SsoSessionMaxLifespan int

+ SsoSessionMaxLifespanRememberMe int

+ SupportedLocales []string

+ UserFederationMappers []interface{}

+ UserFederationProviders []interface{}

+ UserManagedAccessAllowed bool

+ Users []interface{}

+ VerifyEmail bool

+ WaitIncrementSeconds int

+ type ResourceRepresentation struct

+ Attributes map[string]string

+ DisplayName string

+ ID string

+ IconURI string

+ Name string

+ OwnerManagedAccess bool

+ Scopes []ScopeRepresentation

+ Type string

+ URIs []string

+ type ResourceServerRepresentation struct

+ AllowRemoteResourceManagement bool

+ ClientID string

+ ID string

+ Name string

+ Policies []PolicyRepresentation

+ PolicyEnforcementMode *PolicyEnforcementMode

+ Resources []ResourceRepresentation

+ Scopes []ScopeRepresentation

+ type RetrospecTokenResult struct

+ Active bool

+ Aud string

+ AuthTime int

+ Exp int

+ Iat int

+ Jti string

+ Nbf int

+ Permissions map[string]string

+ Type string

+ type Role struct

+ Attributes map[string][]string

+ ClientRole bool

+ Composite bool

+ ContainerID string

+ Description string

+ ID string

+ Name string

+ ScopeParamRequired bool

+ type ScopeRepresentation struct

+ DisplayName string

+ ID string

+ IconURI string

+ Name string

+ Policies []PolicyRepresentation

+ Resources []ResourceRepresentation

+ type ServerInfoRepesentation struct

+ MemoryInfo MemoryInfoRepresentation

+ SystemInfo SystemInfoRepresentation

+ type SetPasswordRequest struct

+ Password string

+ Temporary bool

+ Type string

+ type SystemInfoRepresentation struct

+ FileEncoding string

+ JavaHome string

+ JavaRuntime string

+ JavaVM string

+ JavaVMVersion string

+ JavaVendor string

+ JavaVersion string

+ OSArchitecture string

+ OSName string

+ OSVersion string

+ ServerTime string

+ Uptime string

+ UptimeMillis int

+ UserDir string

+ UserLocale string

+ UserName string

+ UserTimezone string

+ Version string

+ type TokenOptions struct

+ ClientID string

+ ClientSecret string

+ GrantType string

+ Password string

+ Permission string

+ RefreshToken string

+ ResponseType string

+ ResponseTypes []string

+ Scope string

+ Scopes []string

+ Username string

+ func (t *TokenOptions) FormData() map[string]string

+ type User struct

+ Access map[string]bool

+ Attributes map[string][]string

+ CreatedTimestamp int64

+ DisableableCredentialTypes []interface{}

+ Email string

+ EmailVerified bool

+ Enabled bool

+ FederationLink string

+ FirstName string

+ ID string

+ LastName string

+ RequiredActions []interface{}

+ Totp bool

+ Username string

+ type UserGroup struct

+ ID string

+ Name string

+ Path string

+ type UserInfo struct

+ Address interface{}

+ Email string

+ EmailVerified bool

+ PreferredUsername string

+ Sub string

+ type UserSessionRepresentation struct

+ Clients map[string]string

+ ID string

+ IPAddress string

+ LastAccess int64

+ Start int64

+ UserID string

+ Username string

Other modules containing this package

github.com/Nerzal/gocloak

github.com/Nerzal/gocloak/v10

github.com/Nerzal/gocloak/v11

github.com/Nerzal/gocloak/v12

github.com/Nerzal/gocloak/v13

github.com/Nerzal/gocloak/v4

github.com/Nerzal/gocloak/v5

github.com/Nerzal/gocloak/v6

github.com/Nerzal/gocloak/v7

github.com/Nerzal/gocloak/v8

github.com/Nerzal/gocloak/v9

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