Package-level declarations

Types

Link copied to clipboard
data class AccessToken(val accessToken: String, val expiresIn: Long, val refreshExpiresIn: Long, val refreshToken: String, val tokenType: String, val notBeforePolicy: Int, val sessionState: String, val scope: String)
Link copied to clipboard
data class AddClient(val clientId: String, val name: String? = null, val description: String? = null, val baseUrl: String? = null, val surrogateAuthRequired: Boolean, val enabled: Boolean, val clientAuthenticatorType: String, val redirectUris: List<String>, val webOrigins: List<String>, val notBefore: Int, val bearerOnly: Boolean, val consentRequired: Boolean, val standardFlowEnabled: Boolean, val implicitFlowEnabled: Boolean, val directAccessGrantsEnabled: Boolean, val serviceAccountsEnabled: Boolean, val publicClient: Boolean, val frontchannelLogout: Boolean, val protocol: String? = null, val attributes: Map<String, String>, val authenticationFlowBindingOverrides: Map<String, List<String>>, val fullScopeAllowed: Boolean, val nodeReRegistrationTimeout: Int, val protocolMappers: List<ProtocolMapper>? = null, val defaultClientScopes: List<String>, val optionalClientScopes: List<String>, val access: ClientAccess, val adminUrl: String? = null, val rootUrl: String? = null)
Link copied to clipboard
data class AddClientScope(val name: String, val description: String? = null, val protocol: String, val attributes: Map<String, String>, val protocolMappers: List<ProtocolMapper>? = null)
Link copied to clipboard
data class AddFlow(val alias: String, val builtIn: Boolean, val description: String, val providerId: String, val topLevel: Boolean)
Link copied to clipboard
data class AddFlowExecution(val provider: String)
Link copied to clipboard
data class AddGroup(val name: String)
Link copied to clipboard
data class AddIdentityProvider(val providerId: String, val alias: String, val displayName: String? = null, val enabled: Boolean, val config: Map<String, String>, val trustEmail: Boolean, val storeToken: Boolean, val linkOnly: Boolean, val firstBrokerLoginFlowAlias: String, val postBrokerLoginFlowAlias: String, val updateProfileFirstLoginMode: String = "on")
Link copied to clipboard
data class AddIdentityProviderMapper(val config: Map<String, String>, val identityProviderAlias: String, val identityProviderMapper: String, val name: String)
Link copied to clipboard
data class AddMapper(val name: String, val config: Map<String, String>, val protocol: String, val protocolMapper: String)
Link copied to clipboard
data class AddRealm(val realm: String, val enabled: Boolean, val id: String)
Link copied to clipboard
data class AddRole(val name: String, val description: String? = "")
Link copied to clipboard
data class AddSimpleClient(val clientId: String, val enabled: Boolean, val attributes: Map<String, String>, val protocol: String = OPENID_CONNECT_PROTOCOL, val redirectUris: List<String>, val secret: String? = null, val publicClient: Boolean)
Link copied to clipboard
data class AddUser(val username: String, val enabled: Boolean = true, val emailVerified: Boolean = true, val attributes: Map<String, List<String>> = emptyMap())
Link copied to clipboard
data class AddUserFederation(val name: String, val parentId: String, val config: Map<String, List<String>>, val providerId: String = "ldap", val providerType: String = "org.keycloak.storage.UserStorageProvider")
Link copied to clipboard
data class AddUserFederationMapper(val name: String, val config: Map<String, List<String>>, val parentId: String, val providerId: String, val providerType: String)
Link copied to clipboard
data class AssignClientScope(val client: UUID, val clientScopeId: UUID, val realm: String)
Link copied to clipboard
data class AssignGroup(val realm: String, val groupId: UUID, val userId: UUID)
Link copied to clipboard
data class AssignRole(val clientRole: Boolean, val composite: Boolean, val containerId: String, val id: UUID, val name: String)
Link copied to clipboard
Link copied to clipboard
data class AuthenticationExecution(val id: UUID, val requirement: Flow.Requirement, val displayName: String, val requirementChoices: List<Flow.Requirement>, val configurable: Boolean, val providerId: String, val level: Int, val index: Int, val authenticationConfig: String? = null)
Link copied to clipboard
data class AuthenticationExecutionImport(val requirement: Flow.Requirement, val providerId: String, val level: Int, val index: Int, val config: Map<String, String> = emptyMap())
Link copied to clipboard
data class AuthenticatorConfig(val alias: String? = null, val config: Map<String, String>, val id: UUID? = null)
Link copied to clipboard
data class Client(val id: UUID, val clientId: String, val name: String?, val description: String?, val surrogateAuthRequired: Boolean, val enabled: Boolean, val alwaysDisplayInConsole: Boolean = false, val clientAuthenticatorType: String, val redirectUris: List<String>, val webOrigins: List<String>, val notBefore: Int, val bearerOnly: Boolean, val consentRequired: Boolean, val standardFlowEnabled: Boolean, val implicitFlowEnabled: Boolean, val directAccessGrantsEnabled: Boolean, val serviceAccountsEnabled: Boolean, val publicClient: Boolean, val frontchannelLogout: Boolean, val protocol: String?, val attributes: Map<String, String>, val authenticationFlowBindingOverrides: Map<String, List<String>>, val fullScopeAllowed: Boolean, val nodeReRegistrationTimeout: Int, val protocolMappers: List<ProtocolMapper>?, val defaultClientScopes: List<String>, val optionalClientScopes: List<String>, val access: ClientAccess, val baseUrl: String?, val adminUrl: String?, val secret: String?, val rootUrl: String?)
Link copied to clipboard
data class ClientAccess(val view: Boolean, val configure: Boolean, val manage: Boolean)
Link copied to clipboard
data class ClientListItem(val id: UUID, val clientId: String, val name: String?, val description: String?, val baseUrl: String?, val surrogateAuthRequired: Boolean, val enabled: Boolean, val clientAuthenticatorType: String, val redirectUris: List<String>, val webOrigins: List<String>, val notBefore: Int, val bearerOnly: Boolean, val consentRequired: Boolean, val standardFlowEnabled: Boolean, val implicitFlowEnabled: Boolean, val directAccessGrantsEnabled: Boolean, val serviceAccountsEnabled: Boolean, val publicClient: Boolean, val frontchannelLogout: Boolean, val protocol: String?, val attributes: Map<String, String>, val authenticationFlowBindingOverrides: Map<String, List<String>>, val fullScopeAllowed: Boolean, val nodeReRegistrationTimeout: Int, val protocolMappers: List<ProtocolMapper>?, val defaultClientScopes: List<String>, val optionalClientScopes: List<String>, val access: ClientAccess, val adminUrl: String?, val rootUrl: String?)
Link copied to clipboard
data class ClientScope(val id: UUID, val name: String, val description: String? = null, val protocol: String, val attributes: Map<String, String>, val protocolMappers: List<ProtocolMapper>? = null)
Link copied to clipboard
data class ClientScopeItem(val id: UUID, val name: String)
Link copied to clipboard
data class ClientSecret(val type: String, val value: String)
Link copied to clipboard
data class Flow(val id: UUID, val alias: String, val description: String, val providerId: String, val topLevel: Boolean, val builtIn: Boolean, val authenticationExecutions: List<Flow.AuthenticationExecution>)
Link copied to clipboard
data class Group(val id: UUID, val name: String, val path: String, val attributes: Map<String, List<String>>, val realmRoles: List<String>, val clientRoles: Map<String, List<String>>, val subGroups: List<Group>, val access: Map<String, Boolean>? = null)
Link copied to clipboard
data class GroupListItem(val id: UUID, val name: String, val path: String, val subGroups: List<GroupListItem>)
Link copied to clipboard
data class IdentityProvider(val providerId: String, val internalId: UUID, val alias: String, val displayName: String? = null, val enabled: Boolean, val config: Map<String, String>, val trustEmail: Boolean, val storeToken: Boolean, val linkOnly: Boolean, val firstBrokerLoginFlowAlias: String = "", val postBrokerLoginFlowAlias: String = "", val updateProfileFirstLoginMode: String)
Link copied to clipboard
data class IdentityProviderItem(val alias: String, val displayName: String? = null, val internalId: UUID)
Link copied to clipboard
data class IdentityProviderMapper(val id: String, val name: String, val identityProviderAlias: String, val identityProviderMapper: String, val config: Map<String, String>)
Link copied to clipboard
data class IdentityProviderMapperItem(val id: String, val name: String, val identityProviderAlias: String, val identityProviderMapper: String, val config: Map<String, String>)
Link copied to clipboard
data class ImportClient(val import: String)
Link copied to clipboard
Link copied to clipboard
data class ImportFlow(val alias: String, val description: String, val providerId: String, val topLevel: Boolean, val buildIn: Boolean, val authenticationExecutions: List<AuthenticationExecutionImport>)
Link copied to clipboard
data class Mapper(val id: UUID, val name: String, val protocol: String, val protocolMapper: String, val consentRequired: Boolean, val config: Map<String, String>)
Link copied to clipboard
data class ProtocolMapper(val id: UUID? = null, val name: String, val protocol: String, val protocolMapper: String, val consentRequired: Boolean, val config: Map<String, String>)
Link copied to clipboard
data class Realm(val id: String, val realm: String, var displayName: String? = null, var displayNameHtml: String? = null, val notBefore: Int, val revokeRefreshToken: Boolean, val refreshTokenMaxReuse: Int, val accessTokenLifespan: Int, val accessTokenLifespanForImplicitFlow: Int, val ssoSessionIdleTimeout: Int, val ssoSessionMaxLifespan: Int, val ssoSessionIdleTimeoutRememberMe: Int, val ssoSessionMaxLifespanRememberMe: Int, val offlineSessionIdleTimeout: Int, val offlineSessionMaxLifespanEnabled: Boolean, val offlineSessionMaxLifespan: Int, val accessCodeLifespan: Int, val accessCodeLifespanUserAction: Int, val accessCodeLifespanLogin: Int, val actionTokenGeneratedByAdminLifespan: Int, val actionTokenGeneratedByUserLifespan: Int, val enabled: Boolean, val sslRequired: String, val registrationAllowed: Boolean, val registrationEmailAsUsername: Boolean, val rememberMe: Boolean, val verifyEmail: Boolean, val loginWithEmailAllowed: Boolean, val duplicateEmailsAllowed: Boolean, val resetPasswordAllowed: Boolean, val editUsernameAllowed: Boolean, val bruteForceProtected: Boolean, val permanentLockout: Boolean, val maxFailureWaitSeconds: Int, val minimumQuickLoginWaitSeconds: Int, val waitIncrementSeconds: Int, val quickLoginCheckMilliSeconds: Int, val maxDeltaTimeSeconds: Int, val failureFactor: Int, val requiredCredentials: List<String>, val passwordPolicy: String = "", val otpPolicyType: String, val otpPolicyAlgorithm: String, val otpPolicyInitialCounter: Int, val otpPolicyDigits: Int, val otpPolicyLookAheadWindow: Int, val otpPolicyPeriod: Int, val otpSupportedApplications: List<String>, val webAuthnPolicyRpEntityName: String, val webAuthnPolicySignatureAlgorithms: List<String>, val webAuthnPolicyRpId: String, val webAuthnPolicyAttestationConveyancePreference: String, val webAuthnPolicyAuthenticatorAttachment: String, val webAuthnPolicyRequireResidentKey: String, val webAuthnPolicyUserVerificationRequirement: String, val webAuthnPolicyCreateTimeout: Int, val webAuthnPolicyAvoidSameAuthenticatorRegister: Boolean, val webAuthnPolicyAcceptableAaguids: List<String>, val browserSecurityHeaders: Map<String, String>, val smtpServer: Map<String, String>, val eventsEnabled: Boolean, val eventsListeners: List<String>, val eventsExpiration: Int, val enabledEventTypes: List<String>, val identityProviders: List<IdentityProviderItem> = emptyList(), val identityProviderMappers: List<IdentityProviderMapperItem> = emptyList(), val adminEventsEnabled: Boolean, val adminEventsDetailsEnabled: Boolean, val internationalizationEnabled: Boolean, val supportedLocales: List<String>, val defaultLocale: String = "en", val browserFlow: String, val registrationFlow: String, val directGrantFlow: String, val resetCredentialsFlow: String, val clientAuthenticationFlow: String, val dockerAuthenticationFlow: String, val firstBrokerLoginFlow: String? = null, val attributes: Map<String, String>, val userManagedAccessAllowed: Boolean, val accountTheme: String? = null, val adminTheme: String? = null, val emailTheme: String? = null, val loginTheme: String? = null, val requiredActions: List<RequiredActionProviderItem>? = null, val upConfig: RealmProfile? = null, val clientProfiles: Map<String, List<String>> = mapOf("profiles" to emptyList()), val clientPolicies: Map<String, List<String>> = mapOf("policies" to emptyList()))
Link copied to clipboard
data class RealmAttribute(val name: String, val displayName: String?, val validations: Map<String, Map<String, Int>>, val permissions: Map<String, List<String>>, val multivalued: Boolean)
Link copied to clipboard
data class RealmProfile(val attributes: List<RealmAttribute>, val groups: List<Map<String, String>>, var unmanagedAttributePolicy: String? = null)
Link copied to clipboard
class RealmUpdateBuilder(existingRealm: Realm)
Link copied to clipboard
data class RequiredActionProviderItem(val alias: String, val config: Map<String, String>?, val defaultAction: Boolean, val enabled: Boolean, val name: String, val priority: Int?, val providerId: String)
Link copied to clipboard
data class ResetPassword(val value: String, val temporary: Boolean = false, val type: String = "Password")
Link copied to clipboard
data class Role(val id: UUID, val name: String, val description: String? = null, val composite: Boolean, val clientRole: Boolean, val containerId: String, val attributes: Map<String, List<String>>? = null)
Link copied to clipboard
data class RoleListItem(val id: UUID, val name: String, val description: String?, val composite: Boolean, val clientRole: Boolean, val containerId: String)
Link copied to clipboard
class UpdateClientBuilder(existingClient: Client)
Link copied to clipboard
data class UpdateFlow(val id: UUID, val alias: String, val providerId: String, val topLevel: Boolean, val description: String)
Link copied to clipboard
data class UpdateFlowExecution(val id: UUID, val requirement: Flow.Requirement, val level: Int, val index: Int, val providerId: String)
Link copied to clipboard
data class UpdateFlowInPlace(val newAlias: String, val description: String, val providerId: String, val topLevel: Boolean, val authenticationExecutions: List<AuthenticationExecutionImport>)
Link copied to clipboard
data class UpdateGroup(val name: String, val path: String, val attributes: Map<String, List<String>>, val access: Map<String, Boolean>, val clientRoles: Map<String, List<String>>, val realmRoles: List<String>, val subGroups: List<Group>)
Link copied to clipboard
data class UpdateIdentityProvider(val internalId: UUID, val providerId: String, val alias: String, val displayName: String? = null, val enabled: Boolean, val config: Map<String, String>, val trustEmail: Boolean, val storeToken: Boolean, val linkOnly: Boolean, val firstBrokerLoginFlowAlias: String, val postBrokerLoginFlowAlias: String, val updateProfileFirstLoginMode: String = "on")
Link copied to clipboard
class UpdateUserBuilder(existingUser: User)
Link copied to clipboard
data class User(val id: UUID, val createdTimestamp: Long, val username: String, val enabled: Boolean, val emailVerified: Boolean, val attributes: Attributes? = null, val notBefore: Long, val totp: Boolean, val access: UserAccess? = null, val disableableCredentialTypes: List<String>, val requiredActions: List<String>, val email: String? = null, val firstName: String? = null, val lastName: String? = null, val credentials: List<UserCredential>? = null, val federationLink: String? = null)
Link copied to clipboard
data class UserAccess(val impersonate: Boolean, val manage: Boolean, val manageGroupMembership: Boolean, val mapRoles: Boolean, val view: Boolean)
Link copied to clipboard
data class UserCredential(val algorithm: String? = "pbkdf2-sha256", val counter: Int? = 0, val createdDate: Long? = Date().time, val digits: Int? = 0, val hashIterations: Int? = 27500, val hashedSaltedValue: String?, val period: Int? = 0, val salt: String? = null, val type: String? = "password", val config: Map<String, String>? = emptyMap())
Link copied to clipboard
data class UserFederation(val id: String, val name: String, val providerId: String, val providerType: String, val parentId: String, val config: Map<String, List<String>>)
Link copied to clipboard
data class UserFederationMapper(val id: UUID, val name: String, val config: Map<String, List<String>>, val parentId: String, val providerId: String, val providerType: String)
Link copied to clipboard
data class UserGroupListItem(val id: UUID, val name: String, val path: String)

Properties

Link copied to clipboard
Link copied to clipboard
const val GROUP_MAPPER: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun addClientScope(name: String, description: String? = null, protocol: String = "openid-connect", protocolMappers: List<ProtocolMapper>? = null, consentScreenText: String? = null, displayOnConsentScreen: Boolean = false, guiOrder: Int? = null, includeInTokenScope: Boolean = true, config: Map<String, String>? = null): AddClientScope
Link copied to clipboard
fun addKeycloakIdentityProvider(authorizationUrl: String, tokenUrl: String, alias: String, clientId: String, clientSecret: String, clientAuthMethod: String = "client_secret_post", logoutUrl: String = "", userInfoUrl: String = "", issuer: String = "", defaultScopes: List<String> = emptyList(), validateSignature: String = "", forwardParameters: List<String> = emptyList(), loginHint: Boolean = false, disableUserInfo: Boolean = false, hideOnLoginPage: Boolean = false, backchannelSupported: Boolean = false, syncMode: String = "IMPORT", acceptsPromptNoneForwardFromClient: String = "", uiLocales: Boolean = true, displayName: String = "", guiOrder: String = "", enabled: Boolean = true, trustEmail: Boolean = false, useJwksUrl: Boolean = false, storeToken: Boolean = false, linkOnly: Boolean = false, firstBrokerLoginFlowAlias: String = "first broker login", postBrokerLoginFlowAlias: String = "", updateProfileFirstLoginMode: String = "on"): AddIdentityProvider
Link copied to clipboard
fun audienceMapper(name: String, addToAccessToken: Boolean, addToIdToken: Boolean, clientAudience: String, customAudience: String): AddMapper
Link copied to clipboard
Link copied to clipboard
fun batchSize(config: Map<String, String>): String
Link copied to clipboard
Link copied to clipboard
fun bindDN(config: Map<String, String>): String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun editMode(config: Map<String, String>): String
Link copied to clipboard
fun emailAddressMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper
Link copied to clipboard
fun fullNameMapper(name: String, parentId: String, ldapFullNameAttribute: String, readOnly: Boolean, writeOnly: Boolean): AddUserFederationMapper
Link copied to clipboard
Link copied to clipboard
fun givenNameMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper
Link copied to clipboard
fun groupMapper(name: String, parentId: String, groupNameLdapAttribute: String, groupObjectClasses: List<String>, groupsDn: String, preserveGroupInheritance: Boolean, membershipLdapAttribute: String, membershipAttributeType: String, membershipUserLdapAttribute: String, filter: String, mode: String, ignoreMissingGroups: Boolean, userRolesRetrieveStrategy: String, mappedGroupAttributes: List<String>, memberofLdapAttribute: String, dropNonExistingGroupsDuringSync: Boolean, groupsPath: String): AddUserFederationMapper
Link copied to clipboard
fun groupMembershipMapper(name: String, addToAccessToken: Boolean, addToIdToken: Boolean, fullGroupPath: Boolean, addToUserInfo: Boolean, claimName: String): AddMapper
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun ldapMapper(name: String, config: Map<String, String>, parentId: String, providerId: String): AddUserFederationMapper
Link copied to clipboard
fun nameMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper
Link copied to clipboard
Link copied to clipboard
fun patchIdentityProvider(existingIdp: IdentityProvider, providerId: String?, alias: String?, displayName: String?, enabled: Boolean?, config: Map<String, String>?, trustEmail: Boolean?, storeToken: Boolean?, linkOnly: Boolean?, firstBrokerLoginFlowAlias: String?, postBrokerLoginFlowAlias: String?, updateProfileFirstLoginMode: String?): UpdateIdentityProvider
Link copied to clipboard
fun patchIdpConfig(existingIdp: IdentityProvider, newConfig: Map<String, String>?): Map<String, String>
Link copied to clipboard
fun patchKeycloakIdentityProvider(existingIdp: IdentityProvider, authorizationUrl: String? = null, tokenUrl: String? = null, alias: String? = null, clientId: String? = null, clientSecret: String? = null, clientAuthMethod: String? = null, logoutUrl: String? = null, userInfoUrl: String? = null, issuer: String? = null, defaultScopes: List<String>? = null, validateSignature: String? = null, forwardParameters: List<String>? = null, loginHint: Boolean? = null, disableUserInfo: Boolean? = null, hideOnLoginPage: Boolean? = null, backchannelSupported: Boolean? = null, syncMode: String? = null, acceptsPromptNoneForwardFromClient: String? = null, uiLocales: Boolean? = null, displayName: String? = null, guiOrder: String? = null, enabled: Boolean? = null, trustEmail: Boolean? = null, useJwksUrl: Boolean? = null, storeToken: Boolean? = null, linkOnly: Boolean? = null, firstBrokerLoginFlowAlias: String? = null, postBrokerLoginFlowAlias: String? = null, updateProfileFirstLoginMode: String? = null): UpdateIdentityProvider
Link copied to clipboard
fun priority(config: Map<String, String>): String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun roleMapper(identityProviderAlias: String, name: String, attributeValue: String, role: String): AddIdentityProviderMapper
Link copied to clipboard
Link copied to clipboard
fun surnameMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun userAttributeMapper(name: String, parentId: String, userModelAttribute: String, ldapAttribute: String, readOnly: Boolean, alwaysReadFromLdap: Boolean, isMandatoryInLdap: Boolean): AddUserFederationMapper
fun userAttributeMapper(name: String, addToAccessToken: Boolean, addToIdToken: Boolean, addToUserInfo: Boolean, claimName: String, aggregateAttributeValues: Boolean, multivalued: Boolean, userAttribute: String): AddMapper
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun userRealmRoleMapper(name: String, addToAccessToken: Boolean, addToIdToken: Boolean, addToUserInfo: Boolean, claimName: String, prefix: String): AddMapper
Link copied to clipboard
fun usersDN(config: Map<String, String>): String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard