0.2.76-SNAPSHOT

keycloakapi/de.klg71.keycloakmigration.keycloakapi

Package-level declarations

Types

enum EmailActions : Enum<EmailActions>

KeycloakApiException

class KeycloakApiException(message: String, statusCode: Int? = null) : RuntimeException

interface KeycloakClient

Interface access resources on keycloak. Build with initKeycloakClient

KeycloakLoginClient

interface KeycloakLoginClient

Interface to get acquire tokens from keycloak. Build with initKeycloakLoginClient

data class RealmName(val realm: String)

Functions

fun KeycloakClient.clientById(clientId: String, realm: String): Client

clientMapperExistsByName

fun KeycloakClient.clientMapperExistsByName(clientId: String, mapperName: String, realm: String): Boolean

clientRoleByName

fun KeycloakClient.clientRoleByName(name: String, clientId: String, realm: String): Role

clientScopeByName

fun KeycloakClient.clientScopeByName(name: String, realm: String): ClientScope

clientScopeMapperExistsByName

fun KeycloakClient.clientScopeMapperExistsByName(clientScopeName: String, mapperName: String, realm: String): Boolean

clientScopeUUID

fun KeycloakClient.clientScopeUUID(clientScopeName: String, realm: String): UUID

fun KeycloakClient.clientUUID(clientId: String, realm: String): UUID

executionsToImport

fun KeycloakClient.executionsToImport(realm: String, flowAlias: String): List<AuthenticationExecutionImport>

fun KeycloakClient.existsClient(clientId: String, realm: String): Boolean

existsClientRole

fun KeycloakClient.existsClientRole(name: String, realm: String, clientId: String): Boolean

existsClientScope

fun KeycloakClient.existsClientScope(name: String, realm: String): Boolean

fun KeycloakClient.existsGroup(name: String, realm: String): Boolean

fun KeycloakClient.existsRole(name: String, realm: String): Boolean

fun KeycloakClient.existsUser(name: String, realm: String): Boolean

extractLocationUUID

fun Response.extractLocationUUID(): UUID

fun KeycloakClient.groupByName(name: String, realm: String): Group

fun KeycloakClient.groupUUID(group: String, realm: String): UUID

identityProviderByAlias

fun KeycloakClient.identityProviderByAlias(alias: String, realm: String): IdentityProvider

identityProviderExistsByAlias

fun KeycloakClient.identityProviderExistsByAlias(alias: String, realm: String): Boolean

identityProviderMapperByName

fun KeycloakClient.identityProviderMapperByName(identityProviderAlias: String, name: String, realm: String): IdentityProviderMapper

identityProviderMapperExistsByName

fun KeycloakClient.identityProviderMapperExistsByName(identityProviderAlias: String, name: String, realm: String): Boolean

fun KeycloakClient.importFlow(realm: String, importFlow: ImportFlow): UUID

initKeycloakClient

fun initKeycloakClient(baseUrl: String, adminUser: String, adminPassword: String, adminUseOauth: Boolean, adminUseOauthLocalPort: Int, realm: String, clientId: String, logger: Logger? = null, totp: String = "", tokenOffsetMs: Long = 1000): KeycloakClient

Builds the KeycloakClient

initKeycloakLoginClient

fun initKeycloakLoginClient(baseUrl: String, logger: Logger? = null): KeycloakLoginClient

Builds the KeycloakLoginClient Only build this if you just need a token and don't need any other keycloak resources. initKeycloakClient automatically acquires tokens.

fun Response.isSuccessful(): Boolean

ldapMapperByName

fun KeycloakClient.ldapMapperByName(ldapName: String, name: String, realm: String): UserFederationMapper

ldapMapperExistsByName

fun KeycloakClient.ldapMapperExistsByName(ldapName: String, name: String, realm: String): Boolean

fun KeycloakClient.realmById(id: String): Realm

realmExistsById

fun KeycloakClient.realmExistsById(id: String): Boolean

retryDefaultConfig

fun retryDefaultConfig(): RetryConfig

roleExistsByName

fun KeycloakClient.roleExistsByName(name: String, realm: String): Boolean

fun KeycloakClient.roleExistsByName(name: String, realm: String, client: String): Boolean

updateFlowInPlace

fun KeycloakClient.updateFlowInPlace(realm: String, alias: String, updateFlow: UpdateFlowInPlace)

fun KeycloakClient.userByName(name: String, realm: String): User

File contains a lot of convenience functions when interacting with the keycloak client

fun KeycloakClient.userExists(user: UUID, realm: String): Boolean

userFederationByName

fun KeycloakClient.userFederationByName(name: String, realm: String): UserFederation

userFederationExistsByName

fun KeycloakClient.userFederationExistsByName(name: String, realm: String): Boolean

fun KeycloakClient.userUUID(user: String, realm: String): UUID