api

package

Go to main page

Versions in this module

v2

v2.19.0

May 1, 2026

v2.18.1

Mar 19, 2026

v2.18.0

Mar 16, 2026

v2.17.0

Jan 14, 2026

v2.16.0

Nov 10, 2025

Changes in this version

type Client

+ func (c *Client) CreateIdpMapper(accessToken string, realmName string, idpAlias string, ...) error

+ func (c *Client) DeleteIdpMapper(accessToken string, realmName string, idpAlias string, mapperID string) error

+ func (c *Client) UpdateIdpMapper(accessToken string, realmName string, idpAlias string, mapperID string, ...) error

v2.15.0

Oct 27, 2025

v2.14.1

Oct 6, 2025

v2.14.0

Oct 6, 2025

Changes in this version

type Client

+ func (c *Client) CreateComponent(accessToken string, realmName string, compRep keycloak.ComponentRepresentation) error

+ func (c *Client) GetComponents(accessToken string, realmName string, paramKV ...string) ([]keycloak.ComponentRepresentation, error)

+ func (c *Client) UpdateComponent(accessToken string, realmName, componentID string, ...) error

v2.13.0

Aug 15, 2025

v2.12.2

Jul 29, 2025

v2.12.1

Jul 28, 2025

Changes in this version

type Client

+ func (c *Client) CreateIdp(accessToken string, realmName string, ...) error

+ func (c *Client) DeleteIdp(accessToken string, realmName string, idpAlias string) error

v2.12.0

Jul 23, 2025

Changes in this version

type AccountClient

+ func (c *AccountClient) DeleteLinkedAccount(accessToken string, realmName string, providerAlias string) error

+ func (c *AccountClient) GetLinkedAccounts(accessToken string, realmName string) ([]keycloak.LinkedAccountRepresentation, error)

type Client

+ func (c *Client) UnlinkShadowUser(accessToken string, reqRealmName string, userID string, provider string) error

v2.11.4

Jun 18, 2025

v2.11.3

Jun 18, 2025

v2.11.2

Jun 16, 2025

v2.11.1

May 21, 2025

v2.11.0

May 19, 2025

Changes in this version

type Client

+ func (c *Client) WithPlugin(p plugin.Plugin) *Client

v2.10.0

May 13, 2025

v2.9.1

May 5, 2025

v2.9.0

Mar 31, 2025

v2.8.1

Jan 8, 2025

v2.8.0

Oct 23, 2024

v2.7.0

May 6, 2024

v2.6.4

Nov 20, 2023

v2.6.3

Sep 21, 2023

Changes in this version

type Client

+ func (c *Client) UpdateIdp(accessToken string, realmName, idpAlias string, ...) error

v2.6.2

Mar 15, 2023

v2.6.1

Feb 13, 2023

Changes in this version

type Client

+ func (c *Client) GetUserProfile(accessToken string, realmName string) (keycloak.UserProfileRepresentation, error)

v2.6.0

Sep 2, 2022

Changes in this version

type Client

+ func (c *Client) GetFederatedIdentities(accessToken string, realmName string, userID string) ([]keycloak.FederatedIdentityRepresentation, error)

+ func (c *Client) SendEmailToUser(accessToken string, reqRealmName string, realmName string, userID string, ...) error

v2.5.7

Jul 14, 2022

Changes in this version

type Client

+ func (c *Client) GenerateTrustIDAuthToken(accessToken string, reqRealmName string, realmName string, userID string) (string, error)

v2.5.6

Jun 1, 2022

v2.5.5

Mar 2, 2022

Changes in this version

type Client

+ func (c *Client) GetSupportInfo(accessToken string, email string) ([]keycloak.EmailInfoRepresentation, error)

v2.5.4

Feb 7, 2022

Changes in this version

type Client

+ func (c *Client) UpdateRole(accessToken string, realmName string, roleID string, ...) error

v2.5.3

Feb 2, 2022

v2.5.2

Dec 14, 2021

v2.5.1

Dec 6, 2021

Changes in this version

+ type AccountClient struct

+ func (c *AccountClient) DeleteAccount(accessToken string, realmName string) error

+ func (c *AccountClient) DeleteCredential(accessToken string, realmName string, credentialID string) error

+ func (c *AccountClient) ExecuteActionsEmail(accessToken string, realmName string, actions []string) error

+ func (c *AccountClient) GetAccount(accessToken string, realm string) (keycloak.UserRepresentation, error)

+ func (c *AccountClient) GetCredentialRegistrators(accessToken string, realmName string) ([]string, error)

+ func (c *AccountClient) GetCredentials(accessToken string, realmName string) ([]keycloak.CredentialRepresentation, error)

+ func (c *AccountClient) MoveAfter(accessToken string, realmName string, credentialID string, ...) error

+ func (c *AccountClient) MoveToFirst(accessToken string, realmName string, credentialID string) error

+ func (c *AccountClient) SendEmail(accessToken, realmName, template, subject string, recipient *string, ...) error

+ func (c *AccountClient) UpdateAccount(accessToken string, realm string, user keycloak.UserRepresentation) error

+ func (c *AccountClient) UpdateLabelCredential(accessToken string, realmName string, credentialID string, label string) error

+ func (c *AccountClient) UpdatePassword(accessToken, realm, currentPassword, newPassword, confirmPassword string) (string, error)

+ type Client struct

+ func New(config keycloak.Config) (*Client, error)

+ func (c *Client) AccountClient() *AccountClient

+ func (c *Client) AddClientRolesToUserRoleMapping(accessToken string, realmName, userID, clientID string, ...) error

+ func (c *Client) AddGroupToUser(accessToken string, realmName, userID, groupID string) error

+ func (c *Client) AddRealmLevelRoleMappings(accessToken string, realmName, userID string, ...) error

+ func (c *Client) AssignClientRole(accessToken string, realmName string, groupID string, clientID string, ...) error

+ func (c *Client) CheckConsentCodeSMS(accessToken string, realmName string, userID string, consentCode string) error

+ func (c *Client) ClearAllLoginFailures(accessToken string, realmName string) error

+ func (c *Client) ClearUserLoginFailures(accessToken string, realmName, userID string) error

+ func (c *Client) CopyExistingAuthenticationFlow(accessToken string, realmName, flowAlias, newName string) error

+ func (c *Client) CountUsers(accessToken string, realmName string) (int, error)

+ func (c *Client) CreateActivationCode(accessToken string, realmName string, userID string) (keycloak.ActivationCodeRepresentation, error)

+ func (c *Client) CreateAuthenticationExecution(accessToken string, realmName string, ...) (string, error)

+ func (c *Client) CreateAuthenticationExecutionForFlow(accessToken string, realmName, flowAlias, provider string) (string, error)

+ func (c *Client) CreateAuthenticationFlow(accessToken string, realmName string, ...) error

+ func (c *Client) CreateClientInitialAccess(accessToken string, realmName string, ...) (keycloak.ClientInitialAccessPresentation, error)

+ func (c *Client) CreateClientRole(accessToken string, realmName, clientID string, ...) (string, error)

+ func (c *Client) CreateFlowWithExecutionForExistingFlow(accessToken string, ...) (string, error)

+ func (c *Client) CreateGroup(accessToken string, reqRealmName string, group keycloak.GroupRepresentation) (string, error)

+ func (c *Client) CreateRealm(accessToken string, realm keycloak.RealmRepresentation) (string, error)

+ func (c *Client) CreateRecoveryCode(accessToken string, realmName string, userID string) (keycloak.RecoveryCodeRepresentation, error)

+ func (c *Client) CreateRole(accessToken string, realmName string, role keycloak.RoleRepresentation) (string, error)

+ func (c *Client) CreateUser(accessToken string, reqRealmName, targetRealmName string, ...) (string, error)

+ func (c *Client) DeleteAuthenticationExecution(accessToken string, realmName, executionID string) error

+ func (c *Client) DeleteAuthenticationFlow(accessToken string, realmName, flowID string) error

+ func (c *Client) DeleteAuthenticatorConfig(accessToken string, realmName, configID string) error

+ func (c *Client) DeleteClientInitialAccess(accessToken string, realmName, accessID string) error

+ func (c *Client) DeleteClientRolesFromUserRoleMapping(accessToken string, realmName, userID, clientID string) error

+ func (c *Client) DeleteCredential(accessToken string, realmName string, userID string, credentialID string) error

+ func (c *Client) DeleteGroup(accessToken string, realmName string, groupID string) error

+ func (c *Client) DeleteGroupFromUser(accessToken string, realmName, userID, groupID string) error

+ func (c *Client) DeleteRealm(accessToken string, realmName string) error

+ func (c *Client) DeleteRealmLevelRoleMappings(accessToken string, realmName, userID string, ...) error

+ func (c *Client) DeleteRequiredAction(accessToken string, realmName, actionAlias string) error

+ func (c *Client) DeleteRole(accessToken string, realmName string, roleID string) error

+ func (c *Client) DeleteUser(accessToken string, realmName, userID string) error

+ func (c *Client) ExecuteActionsEmail(accessToken string, reqRealmName string, targetRealmName string, userID string, ...) error

+ func (c *Client) ExportRealm(accessToken string, realmName string) (keycloak.RealmRepresentation, error)

+ func (c *Client) GenerateCertificate(accessToken string, realmName, idClient, attr string) (keycloak.CertificateRepresentation, error)

+ func (c *Client) GenerateKeyPairAndCertificate(accessToken string, realmName, idClient, attr string, ...) ([]byte, error)

+ func (c *Client) GetAttackDetectionStatus(accessToken string, realmName, userID string) (map[string]interface{}, error)

+ func (c *Client) GetAuthenticationExecutionForFlow(accessToken string, realmName, flowAlias string) (keycloak.AuthenticationExecutionInfoRepresentation, error)

+ func (c *Client) GetAuthenticationFlow(accessToken string, realmName, flowID string) (keycloak.AuthenticationFlowRepresentation, error)

+ func (c *Client) GetAuthenticationFlows(accessToken string, realmName string) ([]keycloak.AuthenticationFlowRepresentation, error)

+ func (c *Client) GetAuthenticatorConfig(accessToken string, realmName, configID string) (keycloak.AuthenticatorConfigRepresentation, error)

+ func (c *Client) GetAuthenticatorProviderConfig(accessToken string, realmName, providerID string) (keycloak.AuthenticatorConfigInfoRepresentation, error)

+ func (c *Client) GetAuthenticatorProviders(accessToken string, realmName string) ([]map[string]interface{}, error)

+ func (c *Client) GetAvailableGroupClientRoles(accessToken string, realmName string, groupID string, clientID string) ([]keycloak.RoleRepresentation, error)

+ func (c *Client) GetClient(accessToken string, realmName, idClient string) (keycloak.ClientRepresentation, error)

+ func (c *Client) GetClientAuthenticatorProviders(accessToken string, realmName string) ([]map[string]interface{}, error)

+ func (c *Client) GetClientInitialAccess(accessToken string, realmName string) ([]keycloak.ClientInitialAccessPresentation, error)

+ func (c *Client) GetClientMappers(accessToke string, realmName, idClient string) ([]keycloak.ClientMapperRepresentation, error)

+ func (c *Client) GetClientRegistrationPolicy(accessToken string, realmName, configID string) ([]keycloak.ComponentTypeRepresentation, error)

+ func (c *Client) GetClientRoleMappings(accessToken string, realmName, userID, clientID string) ([]keycloak.RoleRepresentation, error)

+ func (c *Client) GetClientRoles(accessToken string, realmName, idClient string) ([]keycloak.RoleRepresentation, error)

+ func (c *Client) GetClients(accessToken string, realmName string, paramKV ...string) ([]keycloak.ClientRepresentation, error)

+ func (c *Client) GetConfigDescriptionForClients(accessToken string, realmName string) (map[string]interface{}, error)

+ func (c *Client) GetCredentialTypes(accessToken string, realmName string) ([]string, error)

+ func (c *Client) GetCredentials(accessToken string, realmName string, userID string) ([]keycloak.CredentialRepresentation, error)

+ func (c *Client) GetExpiredTermsOfUseAcceptance(accessToken string) ([]keycloak.DeletableUserRepresentation, error)

+ func (c *Client) GetFormActionProviders(accessToken string, realmName string) ([]map[string]interface{}, error)

+ func (c *Client) GetFormProviders(accessToken string, realmName string) ([]map[string]interface{}, error)

+ func (c *Client) GetGroup(accessToken string, realmName string, groupID string) (keycloak.GroupRepresentation, error)

+ func (c *Client) GetGroupClientRoles(accessToken string, realmName string, groupID string, clientID string) ([]keycloak.RoleRepresentation, error)

+ func (c *Client) GetGroups(accessToken string, realmName string) ([]keycloak.GroupRepresentation, error)

+ func (c *Client) GetGroupsOfUser(accessToken string, realmName, userID string) ([]keycloak.GroupRepresentation, error)

+ func (c *Client) GetIdp(accessToken string, realmName string, idpAlias string) (keycloak.IdentityProviderRepresentation, error)

+ func (c *Client) GetIdpMappers(accessToken string, realmName string, idpAlias string) ([]keycloak.IdentityProviderMapperRepresentation, error)

+ func (c *Client) GetIdps(accessToken string, realmName string) ([]keycloak.IdentityProviderRepresentation, error)

+ func (c *Client) GetKeyInfo(accessToken string, realmName, idClient, attr string) (keycloak.CertificateRepresentation, error)

+ func (c *Client) GetKeyStore(accessToken string, realmName, idClient, attr string, ...) ([]byte, error)

+ func (c *Client) GetRealm(accessToken string, realmName string) (keycloak.RealmRepresentation, error)

+ func (c *Client) GetRealmCredentialRegistrators(accessToken string, realmName string) ([]string, error)

+ func (c *Client) GetRealmLevelRoleMappings(accessToken string, realmName, userID string) ([]keycloak.RoleRepresentation, error)

+ func (c *Client) GetRealms(accessToken string) ([]keycloak.RealmRepresentation, error)

+ func (c *Client) GetRequiredAction(accessToken string, realmName, actionAlias string) (keycloak.RequiredActionProviderRepresentation, error)

+ func (c *Client) GetRequiredActions(accessToken string, realmName string) ([]keycloak.RequiredActionProviderRepresentation, error)

+ func (c *Client) GetRole(accessToken string, realmName string, roleID string) (keycloak.RoleRepresentation, error)

+ func (c *Client) GetRoles(accessToken string, realmName string) ([]keycloak.RoleRepresentation, error)

+ func (c *Client) GetRolesWithAttributes(accessToken string, realmName string) ([]keycloak.RoleRepresentation, error)

+ func (c *Client) GetSecret(accessToken string, realmName, idClient string) (keycloak.CredentialRepresentation, error)

+ func (c *Client) GetStatisticsAuthenticators(accessToken string, realmName string) (map[string]int64, error)

+ func (c *Client) GetStatisticsUsers(accessToken string, realmName string) (keycloak.StatisticsUsersRepresentation, error)

+ func (c *Client) GetToken(realm string, username string, password string) (string, error)

+ func (c *Client) GetUnregisteredRequiredActions(accessToken string, realmName string) ([]map[string]interface{}, error)

+ func (c *Client) GetUser(accessToken string, realmName, userID string) (keycloak.UserRepresentation, error)

+ func (c *Client) GetUsers(accessToken string, reqRealmName, targetRealmName string, paramKV ...string) (keycloak.UsersPageRepresentation, error)

+ func (c *Client) LinkShadowUser(accessToken string, reqRealmName string, userID string, provider string, ...) error

+ func (c *Client) LogoutAllSessions(accessToken string, realmName, userID string) error

+ func (c *Client) LowerExecutionPriority(accessToken string, realmName, executionID string) error

+ func (c *Client) MoveAfter(accessToken string, realmName string, userID string, credentialID string, ...) error

+ func (c *Client) MoveToFirst(accessToken string, realmName string, userID string, credentialID string) error

+ func (c *Client) RaiseExecutionPriority(accessToken string, realmName, executionID string) error

+ func (c *Client) RegisterRequiredAction(accessToken string, realmName, providerID, name string) error

+ func (c *Client) RemoveClientRole(accessToken string, realmName string, groupID string, clientID string, ...) error

+ func (c *Client) ResetPapercardFailures(accessToken, realmName, userID, credentialID string) error

+ func (c *Client) ResetPassword(accessToken string, realmName, userID string, ...) error

+ func (c *Client) SendConsentCodeSMS(accessToken string, realmName string, userID string) error

+ func (c *Client) SendEmail(accessToken string, reqRealmName string, realmName string, ...) error

+ func (c *Client) SendPaperCardsReminders(accessToken, realmName string, ...) (bool, error)

+ func (c *Client) SendReminderEmail(accessToken string, realmName string, userID string, paramKV ...string) error

+ func (c *Client) SendSMS(accessToken string, realmName string, smsRep keycloak.SMSRepresentation) error

+ func (c *Client) SendSmsCode(accessToken string, realmName string, userID string) (keycloak.SmsCodeRepresentation, error)

+ func (c *Client) UpdateAuthenticationExecution(accessToken string, realmName, executionID string, ...) error

+ func (c *Client) UpdateAuthenticationExecutionForFlow(accessToken string, realmName, flowAlias string, ...) error

+ func (c *Client) UpdateAuthenticatorConfig(accessToken string, realmName, configID string, ...) error

+ func (c *Client) UpdateClient(accessToken string, realmName, idClient string, ...) error

+ func (c *Client) UpdateLabelCredential(accessToken string, realmName string, userID string, credentialID string, ...) error

+ func (c *Client) UpdatePassword(accessToken, realm, currentPassword, newPassword, confirmPassword string) (string, error)

+ func (c *Client) UpdateRealm(accessToken string, realmName string, realm keycloak.RealmRepresentation) error

+ func (c *Client) UpdateRequiredAction(accessToken string, realmName, actionAlias string, ...) error

+ func (c *Client) UpdateUser(accessToken string, realmName, userID string, user keycloak.UserRepresentation) error

+ func (c *Client) UploadCertificate(accessToken string, realmName, idClient, attr string, file []byte) (keycloak.CertificateRepresentation, error)

+ func (c *Client) UploadCertificatePrivateKey(accessToken string, realmName, idClient, attr string, file []byte) (keycloak.CertificateRepresentation, error)

+ func (c *Client) VerifyToken(issuer string, realmName string, accessToken string) error

+ type RemindersResponse struct

+ Partial bool

+ type Token struct

+ ExpirationTime int64

+ ID string

+ IssuedAt int64

+ Issuer string

+ NotBefore int64

+ Subject string

+ Username string

Other modules containing this package

github.com/cloudtrust/keycloak-client

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