gocloak

package module

Go to main page

Versions in this module

v7

v7.11.0

Dec 9, 2020

Changes in this version

type GetResourceParams

+ MatchingURI *bool

v7.10.0

Dec 4, 2020

Changes in this version

+ type APIErrType string

+ const APIErrTypeInvalidGrant

+ const APIErrTypeUnknown

+ func ParseAPIErrType(err error) APIErrType

type APIError

+ Type APIErrType

v7.9.0

Dec 4, 2020

Changes in this version

+ func NilOrEmptyArray(value *[]string) bool

+ type AccessRepresentation struct

+ Impersonate *bool

+ Manage *bool

+ ManageGroupMembership *bool

+ MapRoles *bool

+ View *bool

+ type CreatePermissionTicketParams struct

+ Claims *map[string][]string

+ ResourceID *string

+ ResourceScopes *[]string

+ type GetResourcePoliciesParams struct

+ First *int

+ Max *int

+ Name *string

+ ResourceID *string

+ Scope *string

+ type GetUserPermissionParams struct

+ First *int

+ Granted *bool

+ Max *int

+ Owner *string

+ Requester *string

+ ResourceID *string

+ ReturnNames *string

+ ScopeID *string

type GoCloak

+ CreatePermissionTicket func(ctx context.Context, token, realm string, ...) (*PermissionTicketResponseRepresentation, error)

+ CreateResourceClient func(ctx context.Context, token, realm string, resource ResourceRepresentation) (*ResourceRepresentation, error)

+ CreateResourcePolicy func(ctx context.Context, token, realm, resourceID string, ...) (*ResourcePolicyRepresentation, error)

+ DeleteResourceClient func(ctx context.Context, token, realm, resourceID string) error

+ DeleteResourcePolicy func(ctx context.Context, token, realm, permissionID string) error

+ DeleteUserPermission func(ctx context.Context, token, realm, ticketID string) error

+ GetResourcePolicies func(ctx context.Context, token, realm string, params GetResourcePoliciesParams) ([]*ResourcePolicyRepresentation, error)

+ GetResourcePolicy func(ctx context.Context, token, realm, permissionID string) (*ResourcePolicyRepresentation, error)

+ GetUserPermissions func(ctx context.Context, token, realm string, params GetUserPermissionParams) ([]*PermissionGrantResponseRepresentation, error)

+ GrantUserPermission func(ctx context.Context, token, realm string, permission PermissionGrantParams) (*PermissionGrantResponseRepresentation, error)

+ UpdateResourcePolicy func(ctx context.Context, token, realm, permissionID string, ...) error

+ UpdateUserPermission func(ctx context.Context, token, realm string, permission PermissionGrantParams) (*PermissionGrantResponseRepresentation, error)

+ type PermissionGrantParams struct

+ Granted *bool

+ RequesterID *string

+ ResourceID *string

+ ScopeName *string

+ TicketID *string

+ type PermissionGrantResponseRepresentation struct

+ Granted *bool

+ ID *string

+ Owner *string

+ RequesterID *string

+ ResourceID *string

+ Scope *string

+ type PermissionTicketDescriptionRepresentation struct

+ Access *AccessRepresentation

+ CreatedTimeStamp *int64

+ DisableCredentialTypes *[]string

+ Email *string

+ EmailVerified *bool

+ Enabled *bool

+ FirstName *string

+ ID *string

+ LastName *string

+ NotBefore *int64

+ RequiredActions *[]string

+ TOTP *bool

+ UserName *string

+ type PermissionTicketPermissionRepresentation struct

+ RSID *string

+ Scopes *[]string

+ type PermissionTicketRepresentation struct

+ AZP *string

+ Claims *map[string][]string

+ Permissions *[]PermissionTicketPermissionRepresentation

+ type PermissionTicketResponseRepresentation struct

+ Ticket *string

+ type ResourcePolicyRepresentation struct

+ Clients *[]string

+ DecisionStrategy *DecisionStrategy

+ Description *string

+ Groups *[]string

+ ID *string

+ Logic *Logic

+ Name *string

+ Owner *string

+ Roles *[]string

+ Scopes *[]string

+ Type *string

type ResourceRepresentation

+ ResourceScopes *[]ScopeRepresentation

v7.8.0

Nov 26, 2020

Changes in this version

type GoCloak

+ GetResourceClient func(ctx context.Context, token, realm, clientID, resourceID string) (*ResourceRepresentation, error)

+ GetResourcesClient func(ctx context.Context, token, realm, clientID string, params GetResourceParams) ([]*ResourceRepresentation, error)

+ UpdateResourceClient func(ctx context.Context, token, realm, clientID string, ...) error

v7.7.0

Nov 24, 2020

Changes in this version

type GoCloak

+ GetClientRoleByID func(ctx context.Context, accessToken, realm, roleID string) (*Role, error)

v7.6.0

Nov 7, 2020

Changes in this version

type GoCloak

+ GetDependentPermissions func(ctx context.Context, token, realm, clientID, policyID string) ([]*PermissionRepresentation, error)

+ GetPermissionResources func(ctx context.Context, token, realm, clientID, permissionID string) ([]*PermissionResource, error)

+ GetPermissionScopes func(ctx context.Context, token, realm, clientID, permissionID string) ([]*PermissionScope, error)

+ type PermissionResource struct

+ ResourceID *string

+ ResourceName *string

+ type PermissionScope struct

+ ScopeID *string

+ ScopeName *string

v7.5.0

Sep 9, 2020

Changes in this version

type GoCloak

+ GetRequestingPartyPermissions func(ctx context.Context, token, realm string, options RequestingPartyTokenOptions) (*[]RequestingPartyPermission, error)

+ type RequestingPartyPermission struct

+ Claims *map[string]string

+ ResourceID *string

+ ResourceName *string

+ Scopes *[]string

v7.4.0

Aug 25, 2020

Changes in this version

type GetUsersParams

+ Enabled *bool

+ Exact *bool

v7.3.0

Aug 21, 2020

Changes in this version

type GoCloak

+ CreateClientScopeMappingsClientRoles func(ctx context.Context, token, realm, clientID, clientsID string, roles []Role) error

+ CreateClientScopeMappingsRealmRoles func(ctx context.Context, token, realm, clientID string, roles []Role) error

+ DeleteClientScopeMappingsClientRoles func(ctx context.Context, token, realm, clientID, clientsID string, roles []Role) error

+ DeleteClientScopeMappingsRealmRoles func(ctx context.Context, token, realm, clientID string, roles []Role) error

+ GetClientScopeMappings func(ctx context.Context, token, realm, clientID string) (*MappingsRepresentation, error)

+ GetClientScopeMappingsClientRoles func(ctx context.Context, token, realm, clientID, clientsID string) ([]*Role, error)

+ GetClientScopeMappingsClientRolesAvailable func(ctx context.Context, token, realm, clientID, clientsID string) ([]*Role, error)

+ GetClientScopeMappingsRealmRoles func(ctx context.Context, token, realm, clientID string) ([]*Role, error)

+ GetClientScopeMappingsRealmRolesAvailable func(ctx context.Context, token, realm, clientID string) ([]*Role, error)

type User

+ Groups *[]string

v7.2.0

Aug 18, 2020

Changes in this version

type GoCloak

+ GetAvailableRealmRolesByGroupID func(ctx context.Context, token, realm, groupID string) ([]*Role, error)

+ GetAvailableRealmRolesByUserID func(ctx context.Context, token, realm, userID string) ([]*Role, error)

+ GetCompositeRealmRolesByGroupID func(ctx context.Context, token, realm, groupID string) ([]*Role, error)

+ GetCompositeRealmRolesByRoleID func(ctx context.Context, token, realm, roleID string) ([]*Role, error)

+ GetCompositeRealmRolesByUserID func(ctx context.Context, token, realm, userID string) ([]*Role, error)

v7.1.0

Aug 9, 2020

Changes in this version

+ func SetAuthAdminRealms(url string) func(client *gocloak)

+ func SetAuthRealms(url string) func(client *gocloak)

+ func SetCertCacheInvalidationTime(duration time.Duration) func(client *gocloak)

+ func SetLogoutEndpoint(url string) func(client *gocloak)

+ func SetOpenIDConnectEndpoint(url string) func(client *gocloak)

+ func SetTokenEndpoint(url string) func(client *gocloak)

type GoCloak

+ GetAvailableClientRolesByGroupID func(ctx context.Context, token, realm, clientID, groupID string) ([]*Role, error)

v7.0.2

Jul 28, 2020

v7.0.1

Jul 28, 2020

Changes in this version

+ var AFFIRMATIVE = DecisionStrategyP("AFFIRMATIVE")

+ var CONSENSUS = DecisionStrategyP("CONSENSUS")

+ var NEGATIVE = LogicP("NEGATIVE")

+ var POSITIVE = LogicP("POSITIVE")

+ var UNANIMOUS = DecisionStrategyP("UNANIMOUS")

+ func BoolP(value bool) *bool

+ func Float32P(value float32) *float32

+ func Float64P(value float64) *float64

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

+ func Int32P(value int32) *int32

+ func Int64P(value int64) *int64

+ func IntP(value int) *int

+ func NilOrEmpty(value *string) bool

+ func NilOrEmptySlice(value *[]string) bool

+ func PBool(value *bool) bool

+ func PFloat32(value *float32) float32

+ func PFloat64(value *float64) float64

+ func PInt(value *int) int

+ func PInt32(value *int32) int32

+ func PInt64(value *int64) int64

+ func PString(value *string) string

+ func PStringSlice(value *[]string) []string

+ func StringP(value string) *string

+ func UserAttributeContains(attributes map[string][]string, attribute, value string) 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 AggregatedPolicyRepresentation struct

+ Policies *[]string

+ type Attributes struct

+ LDAPENTRYDN *[]string

+ LDAPID *[]string

+ type CertResponse struct

+ Keys *[]CertResponseKey

+ type CertResponseKey struct

+ Alg *string

+ E *string

+ KeyOps *[]string

+ Kid *string

+ Kty *string

+ N *string

+ Use *string

+ X5c *[]string

+ X5t *string

+ X5tS256 *string

+ X5u *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 ClientPolicyRepresentation struct

+ Clients *[]string

+ 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 CompositesRepresentation struct

+ Client *map[string][]string

+ Realm *[]string

+ type CredentialRepresentation struct

+ Algorithm *string

+ Config *MultiValuedHashMap

+ Counter *int32

+ CreatedDate *int64

+ CredentialData *string

+ Device *string

+ Digits *int32

+ HashIterations *int32

+ HashedSaltedValue *string

+ ID *string

+ Period *int32

+ Priority *int32

+ Salt *string

+ SecretData *string

+ Temporary *bool

+ Type *string

+ UserLabel *string

+ Value *string

+ type DecisionStrategy string

+ func DecisionStrategyP(value DecisionStrategy) *DecisionStrategy

+ type ExecuteActionsEmail struct

+ Actions *[]string

+ ClientID *string

+ Lifespan *int

+ RedirectURI *string

+ UserID *string

+ type FederatedIdentityRepresentation struct

+ IdentityProvider *string

+ UserID *string

+ UserName *string

+ type GetClientsParams struct

+ ClientID *string

+ ViewableOnly *bool

+ type GetGroupsParams struct

+ BriefRepresentation *bool

+ First *int

+ Full *bool

+ Max *int

+ Search *string

+ func (obj GetGroupsParams) MarshalJSON() ([]byte, error)

+ type GetPermissionParams struct

+ First *int

+ Max *int

+ Name *string

+ Resource *string

+ Scope *string

+ Type *string

+ type GetPolicyParams struct

+ First *int

+ Max *int

+ Name *string

+ Permission *bool

+ Type *string

+ type GetResourceParams struct

+ Deep *bool

+ First *int

+ Max *int

+ Name *string

+ Owner *string

+ Scope *string

+ Type *string

+ URI *string

+ type GetScopeParams struct

+ Deep *bool

+ First *int

+ Max *int

+ Name *string

+ type GetUsersByRoleParams struct

+ First *int

+ Max *int

+ type GetUsersParams struct

+ BriefRepresentation *bool

+ Email *string

+ First *int

+ FirstName *string

+ LastName *string

+ Max *int

+ Search *string

+ Username *string

+ type GoCloak interface

+ AddClientRoleComposite func(ctx context.Context, token, realm, roleID string, roles []Role) error

+ AddClientRoleToGroup func(ctx context.Context, token, realm, clientID, groupID string, roles []Role) error

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

+ AddDefaultGroup func(ctx context.Context, accessToken, realm, groupID string) error

+ AddDefaultScopeToClient func(ctx context.Context, token, realm, clientID, scopeID string) error

+ AddOptionalScopeToClient func(ctx context.Context, token, realm, clientID, scopeID string) error

+ AddRealmRoleComposite func(ctx context.Context, token, realm, roleName string, roles []Role) error

+ AddRealmRoleToGroup func(ctx context.Context, token, realm, groupID string, roles []Role) error

+ AddRealmRoleToUser func(ctx context.Context, token, realm, userID string, roles []Role) error

+ AddUserToGroup func(ctx context.Context, token, realm, userID, groupID string) error

+ ClearKeysCache func(ctx context.Context, token, realm string) error

+ ClearRealmCache func(ctx context.Context, token, realm string) error

+ ClearUserCache func(ctx context.Context, token, realm string) error

+ CreateChildGroup func(ctx context.Context, token, realm, groupID string, group Group) (string, error)

+ CreateClient func(ctx context.Context, accessToken, realm string, clientID Client) (string, error)

+ CreateClientProtocolMapper func(ctx context.Context, token, realm, clientID string, ...) (string, error)

+ CreateClientRole func(ctx context.Context, accessToken, realm, clientID string, role Role) (string, error)

+ CreateClientScope func(ctx context.Context, accessToken, realm string, scope ClientScope) (string, error)

+ CreateComponent func(ctx context.Context, accessToken, realm string, component Component) (string, error)

+ CreateGroup func(ctx context.Context, accessToken, realm string, group Group) (string, error)

+ CreateIdentityProvider func(ctx context.Context, token, realm string, ...) (string, error)

+ CreatePermission func(ctx context.Context, token, realm, clientID string, ...) (*PermissionRepresentation, error)

+ CreatePolicy func(ctx context.Context, token, realm, clientID string, ...) (*PolicyRepresentation, error)

+ CreateRealm func(ctx context.Context, token string, realm RealmRepresentation) (string, error)

+ CreateRealmRole func(ctx context.Context, token, realm string, role Role) (string, error)

+ CreateResource func(ctx context.Context, token, realm, clientID string, ...) (*ResourceRepresentation, error)

+ CreateScope func(ctx context.Context, token, realm, clientID string, scope ScopeRepresentation) (*ScopeRepresentation, error)

+ CreateUser func(ctx context.Context, token, realm string, user User) (string, error)

+ CreateUserFederatedIdentity func(ctx context.Context, token, realm, userID, providerID string, ...) error

+ DecodeAccessToken func(ctx context.Context, accessToken, realm, expectedAudience string) (*jwt.Token, *jwt.MapClaims, error)

+ DecodeAccessTokenCustomClaims func(ctx context.Context, accessToken, realm, expectedAudience string, ...) (*jwt.Token, error)

+ DeleteClient func(ctx context.Context, accessToken, realm, clientID string) error

+ DeleteClientProtocolMapper func(ctx context.Context, token, realm, clientID, mapperID string) error

+ DeleteClientRole func(ctx context.Context, accessToken, realm, clientID, roleName string) error

+ DeleteClientRoleComposite func(ctx context.Context, token, realm, roleID string, roles []Role) error

+ DeleteClientRoleFromGroup func(ctx context.Context, token, realm, clientID, groupID string, roles []Role) error

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

+ DeleteClientScope func(ctx context.Context, accessToken, realm, scopeID string) error

+ DeleteComponent func(ctx context.Context, accessToken, realm, componentID string) error

+ DeleteCredentials func(ctx context.Context, token, realm, UserID, CredentialID string) error

+ DeleteGroup func(ctx context.Context, accessToken, realm, groupID string) error

+ DeleteIdentityProvider func(ctx context.Context, token, realm, alias string) error

+ DeletePermission func(ctx context.Context, token, realm, clientID, permissionID string) error

+ DeletePolicy func(ctx context.Context, token, realm, clientID, policyID string) error

+ DeleteRealm func(ctx context.Context, token, realm string) error

+ DeleteRealmRole func(ctx context.Context, token, realm, roleName string) error

+ DeleteRealmRoleComposite func(ctx context.Context, token, realm, roleName string, roles []Role) error

+ DeleteRealmRoleFromGroup func(ctx context.Context, token, realm, groupID string, roles []Role) error

+ DeleteRealmRoleFromUser func(ctx context.Context, token, realm, userID string, roles []Role) error

+ DeleteResource func(ctx context.Context, token, realm, clientID, resourceID string) error

+ DeleteScope func(ctx context.Context, token, realm, clientID, scopeID string) error

+ DeleteUser func(ctx context.Context, accessToken, realm, userID string) error

+ DeleteUserFederatedIdentity func(ctx context.Context, token, realm, userID, providerID string) error

+ DeleteUserFromGroup func(ctx context.Context, token, realm, userID, groupID string) error

+ DisableAllCredentialsByType func(ctx context.Context, token, realm, userID string, types []string) error

+ ExecuteActionsEmail func(ctx context.Context, token, realm string, params ExecuteActionsEmail) error

+ GetAvailableClientRolesByUserID func(ctx context.Context, token, realm, clientID, userID string) ([]*Role, error)

+ GetCerts func(ctx context.Context, realm string) (*CertResponse, error)

+ GetClient func(ctx context.Context, accessToken, realm, clientID string) (*Client, error)

+ GetClientOfflineSessions func(ctx context.Context, token, realm, clientID string) ([]*UserSessionRepresentation, error)

+ GetClientRole func(ctx context.Context, token, realm, clientID, roleName string) (*Role, error)

+ GetClientRoles func(ctx context.Context, accessToken, realm, clientID string) ([]*Role, error)

+ GetClientRolesByGroupID func(ctx context.Context, token, realm, clientID, groupID string) ([]*Role, error)

+ GetClientRolesByUserID func(ctx context.Context, token, realm, clientID, userID string) ([]*Role, error)

+ GetClientScope func(ctx context.Context, token, realm, scopeID string) (*ClientScope, error)

+ GetClientScopes func(ctx context.Context, token, realm string) ([]*ClientScope, error)

+ GetClientSecret func(ctx context.Context, token, realm, clientID string) (*CredentialRepresentation, error)

+ GetClientServiceAccount func(ctx context.Context, token, realm, clientID string) (*User, error)

+ GetClientUserSessions func(ctx context.Context, token, realm, clientID string) ([]*UserSessionRepresentation, error)

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

+ GetClientsDefaultScopes func(ctx context.Context, token, realm, clientID string) ([]*ClientScope, error)

+ GetClientsOptionalScopes func(ctx context.Context, token, realm, clientID string) ([]*ClientScope, error)

+ GetComponents func(ctx context.Context, accessToken, realm string) ([]*Component, error)

+ GetCompositeClientRolesByGroupID func(ctx context.Context, token, realm, clientID, groupID string) ([]*Role, error)

+ GetCompositeClientRolesByRoleID func(ctx context.Context, token, realm, clientID, roleID string) ([]*Role, error)

+ GetCompositeClientRolesByUserID func(ctx context.Context, token, realm, clientID, userID string) ([]*Role, error)

+ GetConfiguredUserStorageCredentialTypes func(ctx context.Context, token, realm, userID string) ([]string, error)

+ GetCredentialRegistrators func(ctx context.Context, token, realm string) ([]string, error)

+ GetCredentials func(ctx context.Context, token, realm, UserID string) ([]*CredentialRepresentation, error)

+ GetDefaultDefaultClientScopes func(ctx context.Context, token, realm string) ([]*ClientScope, error)

+ GetDefaultGroups func(ctx context.Context, accessToken, realm string) ([]*Group, error)

+ GetDefaultOptionalClientScopes func(ctx context.Context, token, realm string) ([]*ClientScope, error)

+ GetGroup func(ctx context.Context, accessToken, realm, groupID string) (*Group, error)

+ GetGroupMembers func(ctx context.Context, accessToken, realm, groupID string, ...) ([]*User, error)

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

+ GetGroupsCount func(ctx context.Context, token, realm string, params GetGroupsParams) (int, error)

+ GetIdentityProvider func(ctx context.Context, token, realm, alias string) (*IdentityProviderRepresentation, error)

+ GetIdentityProviders func(ctx context.Context, token, realm string) ([]*IdentityProviderRepresentation, error)

+ GetIssuer func(ctx context.Context, realm string) (*IssuerResponse, error)

+ GetKeyStoreConfig func(ctx context.Context, accessToken, realm string) (*KeyStoreConfig, error)

+ GetPermission func(ctx context.Context, token, realm, clientID, permissionID string) (*PermissionRepresentation, error)

+ GetPermissions func(ctx context.Context, token, realm, clientID string, params GetPermissionParams) ([]*PermissionRepresentation, error)

+ GetPolicies func(ctx context.Context, token, realm, clientID string, params GetPolicyParams) ([]*PolicyRepresentation, error)

+ GetPolicy func(ctx context.Context, token, realm, clientID, policyID string) (*PolicyRepresentation, error)

+ GetRawUserInfo func(ctx context.Context, accessToken, realm string) (map[string]interface{}, error)

+ GetRealm func(ctx context.Context, token, realm string) (*RealmRepresentation, error)

+ GetRealmRole func(ctx context.Context, token, realm, roleName string) (*Role, error)

+ GetRealmRoles func(ctx context.Context, accessToken, realm string) ([]*Role, error)

+ GetRealmRolesByGroupID func(ctx context.Context, accessToken, realm, groupID string) ([]*Role, error)

+ GetRealmRolesByUserID func(ctx context.Context, accessToken, realm, userID string) ([]*Role, error)

+ GetRealms func(ctx context.Context, token string) ([]*RealmRepresentation, error)

+ GetRequestingPartyToken func(ctx context.Context, token, realm string, options RequestingPartyTokenOptions) (*JWT, error)

+ GetResource func(ctx context.Context, token, realm, clientID, resourceID string) (*ResourceRepresentation, error)

+ GetResources func(ctx context.Context, token, realm, clientID string, params GetResourceParams) ([]*ResourceRepresentation, error)

+ GetRoleMappingByGroupID func(ctx context.Context, accessToken, realm, groupID string) (*MappingsRepresentation, error)

+ GetRoleMappingByUserID func(ctx context.Context, accessToken, realm, userID string) (*MappingsRepresentation, error)

+ GetScope func(ctx context.Context, token, realm, clientID, scopeID string) (*ScopeRepresentation, error)

+ GetScopes func(ctx context.Context, token, realm, clientID string, params GetScopeParams) ([]*ScopeRepresentation, error)

+ GetServerInfo func(ctx context.Context, accessToken string) (*ServerInfoRepesentation, error)

+ GetToken func(ctx context.Context, realm string, options TokenOptions) (*JWT, error)

+ GetUserByID func(ctx context.Context, accessToken, realm, userID string) (*User, error)

+ GetUserCount func(ctx context.Context, accessToken, realm string, params GetUsersParams) (int, error)

+ GetUserFederatedIdentities func(ctx context.Context, token, realm, userID string) ([]*FederatedIdentityRepresentation, error)

+ GetUserGroups func(ctx context.Context, accessToken, realm, userID string) ([]*UserGroup, error)

+ GetUserInfo func(ctx context.Context, accessToken, realm string) (*UserInfo, error)

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

+ GetUserSessions func(ctx context.Context, token, realm, userID string) ([]*UserSessionRepresentation, error)

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

+ GetUsersByClientRoleName func(ctx context.Context, token, realm, clientID, roleName string, ...) ([]*User, error)

+ GetUsersByRoleName func(ctx context.Context, token, realm, roleName string) ([]*User, error)

+ Login func(ctx context.Context, clientID, clientSecret, realm, username, password string) (*JWT, error)

+ LoginAdmin func(ctx context.Context, username, password, realm string) (*JWT, error)

+ LoginClient func(ctx context.Context, clientID, clientSecret, realm string) (*JWT, error)

+ LoginClientSignedJWT func(ctx context.Context, clientID, realm string, key interface{}, ...) (*JWT, error)

+ LoginOtp func(ctx context.Context, ...) (*JWT, error)

+ Logout func(ctx context.Context, clientID, clientSecret, realm, refreshToken string) error

+ LogoutAllSessions func(ctx context.Context, accessToken, realm, userID string) error

+ LogoutPublicClient func(ctx context.Context, clientID, realm, accessToken, refreshToken string) error

+ LogoutUserSession func(ctx context.Context, accessToken, realm, session string) error

+ MoveCredentialBehind func(ctx context.Context, ...) error

+ MoveCredentialToFirst func(ctx context.Context, token, realm, userID, credentialID string) error

+ RefreshToken func(ctx context.Context, refreshToken, clientID, clientSecret, realm string) (*JWT, error)

+ RegenerateClientSecret func(ctx context.Context, token, realm, clientID string) (*CredentialRepresentation, error)

+ RemoveDefaultGroup func(ctx context.Context, accessToken, realm, groupID string) error

+ RemoveDefaultScopeFromClient func(ctx context.Context, token, realm, clientID, scopeID string) error

+ RemoveOptionalScopeFromClient func(ctx context.Context, token, realm, clientID, scopeID string) error

+ RestyClient func() *resty.Client

+ RetrospectToken func(ctx context.Context, accessToken, clientID, clientSecret, realm string) (*RetrospecTokenResult, error)

+ SetPassword func(ctx context.Context, token, userID, realm, password string, temporary bool) error

+ SetRestyClient func(restyClient *resty.Client)

+ UpdateClient func(ctx context.Context, accessToken, realm string, updatedClient Client) error

+ UpdateClientProtocolMapper func(ctx context.Context, token, realm, clientID, mapperID string, ...) error

+ UpdateClientScope func(ctx context.Context, accessToken, realm string, scope ClientScope) error

+ UpdateCredentialUserLabel func(ctx context.Context, token, realm, userID, credentialID, userLabel string) error

+ UpdateGroup func(ctx context.Context, accessToken, realm string, updatedGroup Group) error

+ UpdateIdentityProvider func(ctx context.Context, token, realm, alias string, ...) error

+ UpdatePermission func(ctx context.Context, token, realm, clientID string, ...) error

+ UpdatePolicy func(ctx context.Context, token, realm, clientID string, ...) error

+ UpdateRealm func(ctx context.Context, token string, realm RealmRepresentation) error

+ UpdateRealmRole func(ctx context.Context, token, realm, roleName string, role Role) error

+ UpdateResource func(ctx context.Context, token, realm, clientID string, ...) error

+ UpdateRole func(ctx context.Context, accessToken, realm, clientID string, role Role) error

+ UpdateScope func(ctx context.Context, token, realm, clientID string, ...) error

+ UpdateUser func(ctx context.Context, accessToken, realm string, user User) error

+ func NewClient(basePath string) GoCloak

+ type Group struct

+ Access *map[string]bool

+ Attributes *map[string][]string

+ ClientRoles *map[string][]string

+ ID *string

+ Name *string

+ Path *string

+ RealmRoles *[]string

+ SubGroups *[]Group

+ type GroupDefinition struct

+ ExtendChildren *bool

+ ID *string

+ Path *string

+ type GroupPolicyRepresentation struct

+ Groups *[]GroupDefinition

+ GroupsClaim *string

+ type GroupsCount struct

+ Count int

+ type HTTPErrorResponse struct

+ Description string

+ Error string

+ Message string

+ func (e HTTPErrorResponse) NotEmpty() bool

+ func (e HTTPErrorResponse) String() string

+ type IdentityProviderRepresentation struct

+ AddReadTokenRoleOnCreate *bool

+ Alias *string

+ Config *map[string]string

+ DisplayName *string

+ Enabled *bool

+ FirstBrokerLoginFlowAlias *string

+ InternalID *string

+ LinkOnly *bool

+ PostBrokerLoginFlowAlias *string

+ ProviderID *string

+ StoreToken *bool

+ TrustEmail *bool

+ type IssuerResponse struct

+ AccountService *string

+ PublicKey *string

+ Realm *string

+ TokenService *string

+ TokensNotBefore *int

+ type JSPolicyRepresentation struct

+ Code *string

+ 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 string

+ func LogicP(value Logic) *Logic

+ 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 PermissionRepresentation struct

+ DecisionStrategy *DecisionStrategy

+ Description *string

+ ID *string

+ Logic *Logic

+ Name *string

+ Policies *[]string

+ ResourceType *string

+ Resources *[]string

+ Scopes *[]string

+ Type *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

+ IncludedClientAudience *string

+ JSONTypeLabel *string

+ Multivalued *string

+ UserAttribute *string

+ UserinfoTokenClaim *string

+ UsermodelClientRoleMappingClientID *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 *RolesRepresentation

+ 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 *[]User

+ VerifyEmail *bool

+ WaitIncrementSeconds *int

+ type RequestingPartyTokenOptions struct

+ Audience *string

+ ClaimToken *string

+ ClaimTokenFormat *string

+ GrantType *string

+ Permissions *[]string

+ RPT *string

+ ResponseIncludeResourceName *bool

+ ResponseMode *string

+ ResponsePermissionsLimit *uint32

+ SubmitRequest *bool

+ Ticket *string

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

+ type ResourceOwnerRepresentation struct

+ ID *string

+ Name *string

+ type ResourcePermission struct

+ RSID *string

+ RSName *string

+ ResourceID *string

+ ResourceScopes *[]string

+ Scopes *[]string

+ type ResourceRepresentation struct

+ Attributes *map[string][]string

+ DisplayName *string

+ ID *string

+ IconURI *string

+ Name *string

+ Owner *ResourceOwnerRepresentation

+ 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 *StringOrArray

+ AuthTime *int

+ Exp *int

+ Iat *int

+ Jti *string

+ Nbf *int

+ Permissions *[]ResourcePermission

+ Type *string

+ type Role struct

+ Attributes *map[string][]string

+ ClientRole *bool

+ Composite *bool

+ Composites *CompositesRepresentation

+ ContainerID *string

+ Description *string

+ ID *string

+ Name *string

+ ScopeParamRequired *bool

+ type RoleDefinition struct

+ ID *string

+ Private *bool

+ Required *bool

+ type RolePolicyRepresentation struct

+ Roles *[]RoleDefinition

+ type RolesRepresentation struct

+ Client *map[string][]Role

+ Realm *[]Role

+ 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 StringOrArray []string

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

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

+ 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 TimePolicyRepresentation struct

+ DayMonth *string

+ DayMonthEnd *string

+ Hour *string

+ HourEnd *string

+ Minute *string

+ MinuteEnd *string

+ Month *string

+ MonthEnd *string

+ NotBefore *string

+ NotOnOrAfter *string

+ Year *string

+ YearEnd *string

+ type TokenOptions struct

+ ClientAssertion *string

+ ClientAssertionType *string

+ ClientID *string

+ ClientSecret *string

+ Code *string

+ GrantType *string

+ Password *string

+ Permission *string

+ RefreshToken *string

+ ResponseType *string

+ ResponseTypes *[]string

+ Scope *string

+ Scopes *[]string

+ Totp *string

+ Username *string

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

+ type User struct

+ Access *map[string]bool

+ Attributes *map[string][]string

+ ClientRoles *map[string][]string

+ CreatedTimestamp *int64

+ Credentials *[]CredentialRepresentation

+ DisableableCredentialTypes *[]interface{}

+ Email *string

+ EmailVerified *bool

+ Enabled *bool

+ FederationLink *string

+ FirstName *string

+ ID *string

+ LastName *string

+ RealmRoles *[]string

+ RequiredActions *[]string

+ ServiceAccountClientID *string

+ Totp *bool

+ Username *string

+ type UserGroup struct

+ ID *string

+ Name *string

+ Path *string

+ type UserInfo struct

+ Address *UserInfoAddress

+ Email *string

+ EmailVerified *bool

+ FamilyName *string

+ Gender *string

+ GivenName *string

+ Locale *string

+ MiddleName *string

+ Name *string

+ Nickname *string

+ PhoneNumber *string

+ PhoneNumberVerified *bool

+ Picture *string

+ PreferredUsername *string

+ Profile *string

+ Sub *string

+ UpdatedAt *int

+ Website *string

+ ZoneInfo *string

+ type UserInfoAddress struct

+ Country *string

+ Formatted *string

+ Locality *string

+ PostalCode *string

+ Region *string

+ StreetAddress *string

+ type UserPolicyRepresentation struct

+ Users *[]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/v3

github.com/Nerzal/gocloak/v4

github.com/Nerzal/gocloak/v5

github.com/Nerzal/gocloak/v6

github.com/Nerzal/gocloak/v8

github.com/Nerzal/gocloak/v9

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