keycloakapi/de.klg71.keycloakmigration.keycloakapi.model

Package de.klg71.keycloakmigration.keycloakapi.model

Types

AccessToken

data class AccessToken(accessToken: String, expiresIn: Long, refreshExpiresIn: Long, refreshToken: String, tokenType: String, notBeforePolicy: Int, sessionState: String, scope: String)

AddClient

data class AddClient(clientId: String, name: String?, description: String?, baseUrl: String?, surrogateAuthRequired: Boolean, enabled: Boolean, clientAuthenticatorType: String, redirectUris: List<String>, webOrigins: List<String>, notBefore: Int, bearerOnly: Boolean, consentRequired: Boolean, standardFlowEnabled: Boolean, implicitFlowEnabled: Boolean, directAccessGrantsEnabled: Boolean, serviceAccountsEnabled: Boolean, publicClient: Boolean, frontchannelLogout: Boolean, protocol: String?, attributes: Map<String, String>, authenticationFlowBindingOverrides: Map<String, List<String>>, fullScopeAllowed: Boolean, nodeReRegistrationTimeout: Int, protocolMappers: List<ProtocolMapper>?, defaultClientScopes: List<String>, optionalClientScopes: List<String>, access: ClientAccess, adminUrl: String?, rootUrl: String?)

AddClientScope

data class AddClientScope(name: String, description: String?, protocol: String, attributes: Map<String, String>, protocolMappers: List<ProtocolMapper>?)

AddFlow

data class AddFlow(alias: String, builtIn: Boolean, description: String, providerId: String, topLevel: Boolean)

AddFlowExecution

data class AddFlowExecution(provider: String)

AddGroup

data class AddGroup(name: String)

AddIdentityProvider

data class AddIdentityProvider(providerId: String, alias: String, displayName: String?, enabled: Boolean, config: Map<String, String>, trustEmail: Boolean, storeToken: Boolean, linkOnly: Boolean, firstBrokerLoginFlowAlias: String, postBrokerLoginFlowAlias: String, updateProfileFirstLoginMode: String)

AddIdentityProviderMapper

data class AddIdentityProviderMapper(config: Map<String, String>, identityProviderAlias: String, identityProviderMapper: String, name: String)

AddMapper

data class AddMapper(name: String, config: Map<String, String>, protocol: String, protocolMapper: String)

AddRealm

data class AddRealm(realm: String, enabled: Boolean, id: String)

AddRole

data class AddRole(name: String, description: String?)

AddSimpleClient

data class AddSimpleClient(clientId: String, enabled: Boolean, attributes: Map<String, String>, protocol: String, redirectUris: List<String>, secret: String?, publicClient: Boolean)

AddUser

data class AddUser(username: String, enabled: Boolean, emailVerified: Boolean, attributes: Map<String, List<String>>)

AddUserFederation

data class AddUserFederation(name: String, parentId: String, config: Map<String, List<String>>, providerId: String, providerType: String)

AddUserFederationMapper

data class AddUserFederationMapper(name: String, config: Map<String, List<String>>, parentId: UUID, providerId: String, providerType: String)

AssignClientScope

data class AssignClientScope(client: UUID, clientScopeId: UUID, realm: String)

AssignGroup

data class AssignGroup(realm: String, groupId: UUID, userId: UUID)

AssignRole

data class AssignRole(clientRole: Boolean, composite: Boolean, containerId: String, id: UUID, name: String)

Attributes

typealias Attributes = Map<String, List<String>>

AuthenticationExecution

data class AuthenticationExecution(id: UUID, requirement: Flow.Requirement, displayName: String, requirementChoices: List<Flow.Requirement>, configurable: Boolean, providerId: String, level: Int, index: Int, authenticationConfig: String?)

AuthenticationExecutionImport

data class AuthenticationExecutionImport(requirement: Flow.Requirement, providerId: String, level: Int, index: Int, config: Map<String, String>)

AuthenticatorConfig

data class AuthenticatorConfig(alias: String?, config: Map<String, String>, id: UUID?)

Client

data class Client(id: UUID, clientId: String, name: String?, description: String?, surrogateAuthRequired: Boolean, enabled: Boolean, alwaysDisplayInConsole: Boolean, clientAuthenticatorType: String, redirectUris: List<String>, webOrigins: List<String>, notBefore: Int, bearerOnly: Boolean, consentRequired: Boolean, standardFlowEnabled: Boolean, implicitFlowEnabled: Boolean, directAccessGrantsEnabled: Boolean, serviceAccountsEnabled: Boolean, publicClient: Boolean, frontchannelLogout: Boolean, protocol: String?, attributes: Map<String, String>, authenticationFlowBindingOverrides: Map<String, List<String>>, fullScopeAllowed: Boolean, nodeReRegistrationTimeout: Int, protocolMappers: List<ProtocolMapper>?, defaultClientScopes: List<String>, optionalClientScopes: List<String>, access: ClientAccess, baseUrl: String?, adminUrl: String?, secret: String?, rootUrl: String?)

ClientAccess

data class ClientAccess(view: Boolean, configure: Boolean, manage: Boolean)

ClientListItem

data class ClientListItem(id: UUID, clientId: String, name: String?, description: String?, baseUrl: String?, surrogateAuthRequired: Boolean, enabled: Boolean, clientAuthenticatorType: String, redirectUris: List<String>, webOrigins: List<String>, notBefore: Int, bearerOnly: Boolean, consentRequired: Boolean, standardFlowEnabled: Boolean, implicitFlowEnabled: Boolean, directAccessGrantsEnabled: Boolean, serviceAccountsEnabled: Boolean, publicClient: Boolean, frontchannelLogout: Boolean, protocol: String?, attributes: Map<String, String>, authenticationFlowBindingOverrides: Map<String, List<String>>, fullScopeAllowed: Boolean, nodeReRegistrationTimeout: Int, protocolMappers: List<ProtocolMapper>?, defaultClientScopes: List<String>, optionalClientScopes: List<String>, access: ClientAccess, adminUrl: String?, rootUrl: String?)

ClientScope

data class ClientScope(id: UUID, name: String, description: String?, protocol: String, attributes: Map<String, String>, protocolMappers: List<ProtocolMapper>?)

ClientScopeItem

data class ClientScopeItem(id: UUID, name: String)

ClientSecret

data class ClientSecret(type: String, value: String)

Flow

data class Flow(id: UUID, alias: String, description: String, providerId: String, topLevel: Boolean, builtIn: Boolean, authenticationExecutions: List<Flow.AuthenticationExecution>)

Group

data class Group(id: UUID, name: String, path: String, attributes: Map<String, List<String>>, realmRoles: List<String>, clientRoles: Map<String, List<String>>, subGroups: List<Group>, access: Map<String, Boolean>?)

GroupListItem

data class GroupListItem(id: UUID, name: String, path: String, subGroups: List<GroupListItem>)

IdentityProvider

data class IdentityProvider(providerId: String, internalId: UUID, alias: String, displayName: String?, enabled: Boolean, config: Map<String, String>, trustEmail: Boolean, storeToken: Boolean, linkOnly: Boolean, firstBrokerLoginFlowAlias: String, postBrokerLoginFlowAlias: String, updateProfileFirstLoginMode: String)

IdentityProviderItem

data class IdentityProviderItem(alias: String, displayName: String?, internalId: UUID)

IdentityProviderMapper

data class IdentityProviderMapper(id: String, name: String, identityProviderAlias: String, identityProviderMapper: String, config: Map<String, String>)

IdentityProviderMapperItem

data class IdentityProviderMapperItem(id: String, name: String, identityProviderAlias: String, identityProviderMapper: String, config: Map<String, String>)

ImportClient

data class ImportClient(import: String)

ImportClientRepresentation

class ImportClientRepresentation(rawJson: String)

ImportClientRepresentationSerializer

class ImportClientRepresentationSerializer : JsonSerializer<ImportClientRepresentation>

ImportFlow

data class ImportFlow(alias: String, description: String, providerId: String, topLevel: Boolean, buildIn: Boolean, authenticationExecutions: List<AuthenticationExecutionImport>)

Mapper

data class Mapper(id: UUID, name: String, protocol: String, protocolMapper: String, consentRequired: Boolean, config: Map<String, String>)

ProtocolMapper

data class ProtocolMapper(id: UUID?, name: String, protocol: String, protocolMapper: String, consentRequired: Boolean, config: Map<String, String>)

Realm

data class Realm(id: String, realm: String, displayName: String?, displayNameHtml: String?, notBefore: Int, revokeRefreshToken: Boolean, refreshTokenMaxReuse: Int, accessTokenLifespan: Int, accessTokenLifespanForImplicitFlow: Int, ssoSessionIdleTimeout: Int, ssoSessionMaxLifespan: Int, ssoSessionIdleTimeoutRememberMe: Int, ssoSessionMaxLifespanRememberMe: Int, offlineSessionIdleTimeout: Int, offlineSessionMaxLifespanEnabled: Boolean, offlineSessionMaxLifespan: Int, accessCodeLifespan: Int, accessCodeLifespanUserAction: Int, accessCodeLifespanLogin: Int, actionTokenGeneratedByAdminLifespan: Int, actionTokenGeneratedByUserLifespan: Int, enabled: Boolean, sslRequired: String, registrationAllowed: Boolean, registrationEmailAsUsername: Boolean, rememberMe: Boolean, verifyEmail: Boolean, loginWithEmailAllowed: Boolean, duplicateEmailsAllowed: Boolean, resetPasswordAllowed: Boolean, editUsernameAllowed: Boolean, bruteForceProtected: Boolean, permanentLockout: Boolean, maxFailureWaitSeconds: Int, minimumQuickLoginWaitSeconds: Int, waitIncrementSeconds: Int, quickLoginCheckMilliSeconds: Int, maxDeltaTimeSeconds: Int, failureFactor: Int, requiredCredentials: List<String>, passwordPolicy: String, otpPolicyType: String, otpPolicyAlgorithm: String, otpPolicyInitialCounter: Int, otpPolicyDigits: Int, otpPolicyLookAheadWindow: Int, otpPolicyPeriod: Int, otpSupportedApplications: List<String>, webAuthnPolicyRpEntityName: String, webAuthnPolicySignatureAlgorithms: List<String>, webAuthnPolicyRpId: String, webAuthnPolicyAttestationConveyancePreference: String, webAuthnPolicyAuthenticatorAttachment: String, webAuthnPolicyRequireResidentKey: String, webAuthnPolicyUserVerificationRequirement: String, webAuthnPolicyCreateTimeout: Int, webAuthnPolicyAvoidSameAuthenticatorRegister: Boolean, webAuthnPolicyAcceptableAaguids: List<String>, browserSecurityHeaders: Map<String, String>, smtpServer: Map<String, String>, eventsEnabled: Boolean, eventsListeners: List<String>, eventsExpiration: Int, enabledEventTypes: List<String>, identityProviders: List<IdentityProviderItem>, identityProviderMappers: List<IdentityProviderMapperItem>, adminEventsEnabled: Boolean, adminEventsDetailsEnabled: Boolean, internationalizationEnabled: Boolean, supportedLocales: List<String>, defaultLocale: String, browserFlow: String, registrationFlow: String, directGrantFlow: String, resetCredentialsFlow: String, clientAuthenticationFlow: String, dockerAuthenticationFlow: String, firstBrokerLoginFlow: String, attributes: Map<String, String>, userManagedAccessAllowed: Boolean, accountTheme: String?, adminTheme: String?, emailTheme: String?, loginTheme: String?, requiredActions: List<RequiredActionProviderItem>?, upConfig: RealmProfile?, clientProfiles: Map<String, List<String>>, clientPolicies: Map<String, List<String>>)

RealmAttribute

data class RealmAttribute(name: String, displayName: String?, validations: Map<String, Map<String, Int>>, permissions: Map<String, List<String>>, multivalued: Boolean)

RealmProfile

data class RealmProfile(attributes: List<RealmAttribute>, groups: List<Map<String, String>>, unmanagedAttributePolicy: String?)

RealmUpdateBuilder

class RealmUpdateBuilder(existingRealm: Realm)

RequiredActionProviderItem

data class RequiredActionProviderItem(alias: String, config: Map<String, String>?, defaultAction: Boolean, enabled: Boolean, name: String, priority: Int?, providerId: String)

ResetPassword

data class ResetPassword(value: String, temporary: Boolean, type: String)

Role

data class Role(id: UUID, name: String, description: String?, composite: Boolean, clientRole: Boolean, containerId: String, attributes: Map<String, List<String>>?)

RoleListItem

data class RoleListItem(id: UUID, name: String, description: String?, composite: Boolean, clientRole: Boolean, containerId: String)

UpdateClientBuilder

class UpdateClientBuilder(existingClient: Client)

UpdateFlow

data class UpdateFlow(id: UUID, alias: String, providerId: String, topLevel: Boolean, description: String)

UpdateFlowExecution

data class UpdateFlowExecution(id: UUID, requirement: Flow.Requirement, level: Int, index: Int, providerId: String)

UpdateFlowInPlace

data class UpdateFlowInPlace(newAlias: String, description: String, providerId: String, topLevel: Boolean, authenticationExecutions: List<AuthenticationExecutionImport>)

UpdateGroup

data class UpdateGroup(name: String, path: String, attributes: Map<String, List<String>>, access: Map<String, Boolean>, clientRoles: Map<String, List<String>>, realmRoles: List<String>, subGroups: List<Group>)

UpdateIdentityProvider

data class UpdateIdentityProvider(internalId: UUID, providerId: String, alias: String, displayName: String?, enabled: Boolean, config: Map<String, String>, trustEmail: Boolean, storeToken: Boolean, linkOnly: Boolean, firstBrokerLoginFlowAlias: String, postBrokerLoginFlowAlias: String, updateProfileFirstLoginMode: String)

UpdateUserBuilder

class UpdateUserBuilder(existingUser: User)

User

data class User(id: UUID, createdTimestamp: Long, username: String, enabled: Boolean, emailVerified: Boolean, attributes: Attributes?, notBefore: Long, totp: Boolean, access: UserAccess?, disableableCredentialTypes: List<String>, requiredActions: List<String>, email: String?, firstName: String?, lastName: String?, credentials: List<UserCredential>?, federationLink: String?)

UserAccess

data class UserAccess(impersonate: Boolean, manage: Boolean, manageGroupMembership: Boolean, mapRoles: Boolean, view: Boolean)

UserCredential

data class UserCredential(algorithm: String?, counter: Int?, createdDate: Long?, digits: Int?, hashIterations: Int?, hashedSaltedValue: String?, period: Int?, salt: String?, type: String?, config: Map<String, String>?)

UserFederation

data class UserFederation(id: UUID, name: String, providerId: String, providerType: String, parentId: String, config: Map<String, List<String>>)

UserFederationMapper

data class UserFederationMapper(id: UUID, name: String, config: Map<String, List<String>>, parentId: UUID, providerId: String, providerType: String)

UserGroupListItem

data class UserGroupListItem(id: UUID, name: String, path: String)

Functions

addClientScope

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

addKeycloakIdentityProvider

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

allowKerberosAuthentication

fun allowKerberosAuthentication(config: Map<String, String>): String

audienceMapper

fun audienceMapper(name: String, addToAccessToken: Boolean, addToIdToken: Boolean, clientAudience: String, customAudience: String): AddMapper

authenticationType

fun authenticationType(config: Map<String, String>): String

batchSize

fun batchSize(config: Map<String, String>): String

bindCredential

fun bindCredential(config: Map<String, String>): String

bindDN

fun bindDN(config: Map<String, String>): String

cachePolicy

fun cachePolicy(config: Map<String, String>): String

changedSyncPeriod

fun changedSyncPeriod(config: Map<String, String>): String

connectionPooling

fun connectionPooling(config: Map<String, String>): String

connectionTimeout

fun connectionTimeout(config: Map<String, String>): String

connectionUrl

fun connectionUrl(config: Map<String, String>): String

constructAdLdapConfig

fun constructAdLdapConfig(config: Map<String, String>): Map<String, List<String>>

constructUserFederationConfig

fun constructUserFederationConfig(config: Map<String, String>): Map<String, List<String>>

editMode

fun editMode(config: Map<String, String>): String

emailAddressMapper

fun emailAddressMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper

fromExisting

fun fromExisting(idp: IdentityProvider): UpdateIdentityProvider

fullNameMapper

fun fullNameMapper(name: String, parentId: UUID, ldapFullNameAttribute: String, readOnly: Boolean, writeOnly: Boolean): AddUserFederationMapper

fullSyncPeriod

fun fullSyncPeriod(config: Map<String, String>): String

givenNameMapper

fun givenNameMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper

groupMapper

fun groupMapper(name: String, parentId: UUID, 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

groupMembershipMapper

fun groupMembershipMapper(name: String, addToAccessToken: Boolean, addToIdToken: Boolean, fullGroupPath: Boolean, addToUserInfo: Boolean, claimName: String): AddMapper

hardcodedRoleMapper

fun hardcodedRoleMapper(name: String, role: String, parentId: UUID): AddUserFederationMapper

importUsers

fun importUsers(config: Map<String, String>): String

ldapFilter

fun ldapFilter(config: Map<String, String>): String

ldapMapper

fun ldapMapper(name: String, config: Map<String, String>, parentId: UUID, providerId: String): AddUserFederationMapper

nameMapper

fun nameMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper

pagination

fun pagination(config: Map<String, String>): String

patchIdentityProvider

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

patchIdpConfig

fun patchIdpConfig(existingIdp: IdentityProvider, newConfig: Map<String, String>?): Map<String, String>

patchKeycloakIdentityProvider

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

priority

fun priority(config: Map<String, String>): String

rdnLdapAttribute

fun rdnLdapAttribute(config: Map<String, String>): String

readTimeout

fun readTimeout(config: Map<String, String>): String

roleMapper

fun roleMapper(identityProviderAlias: String, name: String, attributeValue: String, role: String): AddIdentityProviderMapper

searchScope

fun searchScope(config: Map<String, String>): String

surnameMapper

fun surnameMapper(identityProviderAlias: String, name: String, attributeName: String): AddIdentityProviderMapper

translateConfig

fun translateConfig(config: Map<String, String>): Map<String, List<String>>

useKerberosAuthentication

fun useKerberosAuthentication(config: Map<String, String>): String

userAccountControlMapper

fun userAccountControlMapper(name: String, parentId: UUID): AddUserFederationMapper

userAttributeMapper

fun userAttributeMapper(name: String, parentId: UUID, 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

usernameLdapAttribute