keycloakapi/de.klg71.keycloakmigration.keycloakapi/KeycloakClient

KeycloakClient

interface KeycloakClient

Interface access resources on keycloak. Build with initKeycloakClient

Functions

addChildGroup

abstract fun addChildGroup(addGroup: AddGroup, parentGroupId: UUID, realm: String): Response

addClient

abstract fun addClient(addClient: AddClient, realm: String): Response

addClientMapper

abstract fun addClientMapper(clientId: UUID, addMapper: AddMapper, realm: String): Response

addClientRole

abstract fun addClientRole(addRole: AddRole, clientId: UUID, realm: String)

addClientRoleScopeMappingToClient

abstract fun addClientRoleScopeMappingToClient(roleScopeMapping: List<RoleListItem>, realm: String, id: UUID, roleClientId: UUID): Response

addClientScope

abstract fun addClientScope(realm: String, addClientScope: AddClientScope): Response

addClientScopeMapper

abstract fun addClientScopeMapper(clientScopeId: UUID, addMapper: AddMapper, realm: String): Response

addCompositeToRole

abstract fun addCompositeToRole(roles: List<RoleListItem>, roleId: UUID, realm: String): Response

addFlow

abstract fun addFlow(realm: String, addFlow: AddFlow): Response

addFlowExecution

abstract fun addFlowExecution(realm: String, alias: String, addFlowExecution: AddFlowExecution): Response

addGroup

abstract fun addGroup(addGroup: AddGroup, realm: String): Response

addIdentityProvider

abstract fun addIdentityProvider(addIdentityProvider: AddIdentityProvider, realm: String): Response

addIdentityProviderMapper

abstract fun addIdentityProviderMapper(addIdentityProviderMapper: AddIdentityProviderMapper, realm: String, alias: String): Response

addMapper

abstract fun ~~addMapper~~(clientId: UUID, addMapper: AddMapper, realm: String): Response

addRealm

abstract fun addRealm(addRealm: AddRealm)

addRealmRoleScopeMappingToClient

abstract fun addRealmRoleScopeMappingToClient(roleScopeMapping: List<RoleListItem>, realm: String, id: UUID): Response

addRole

abstract fun addRole(addRole: AddRole, realm: String)

addSimpleClient

abstract fun addSimpleClient(addSimpleClient: AddSimpleClient, realm: String): Response

addUser

abstract fun addUser(user: AddUser, realm: String): Response

addUserFederation

abstract fun addUserFederation(addUserFederation: AddUserFederation, realm: String)

addUserFederationMapper

abstract fun addUserFederationMapper(addUserFederationMapper: AddUserFederationMapper, realm: String): Response

assignClientRoles

abstract fun assignClientRoles(roles: List<AssignRole>, realm: String, userId: UUID, clientId: UUID)

assignClientRolesToGroup

abstract fun assignClientRolesToGroup(roles: List<AssignRole>, realm: String, groupId: UUID, clientId: UUID)

assignClientRoleToClientScope

abstract fun assignClientRoleToClientScope(roles: List<AssignRole>, realm: String, clientScopeId: UUID, clientId: UUID): Response

assignDefaultClientScope

abstract fun assignDefaultClientScope(realm: String, clientId: UUID, clientScopeId: UUID, assignClientScope: AssignClientScope): Response

assignGroup

abstract fun assignGroup(assignGroup: AssignGroup, realm: String, userId: UUID, groupId: UUID)

assignOptionalClientScope

abstract fun assignOptionalClientScope(realm: String, clientId: UUID, clientScopeId: UUID, assignClientScope: AssignClientScope): Response

assignRealmRoles

abstract fun assignRealmRoles(roles: List<AssignRole>, realm: String, userId: UUID)

assignRealmRolesToGroup

abstract fun assignRealmRolesToGroup(roles: List<AssignRole>, realm: String, groupId: UUID)

assignRealmRoleToClientScope

abstract fun assignRealmRoleToClientScope(roles: List<AssignRole>, realm: String, clientScopeId: UUID)

client

abstract fun client(clientId: UUID, realm: String): Client

clientById

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

clientMapperExistsByName

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

clientMappers

abstract fun clientMappers(clientId: UUID, realm: String): List<Mapper>

clientRole

abstract fun clientRole(roleId: UUID, realm: String, clientId: UUID): Role

clientRoleByName

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

clientRoles

abstract fun clientRoles(realm: String, clientId: UUID): List<RoleListItem>

clientRoleScopeMappingsOfClient

abstract fun clientRoleScopeMappingsOfClient(realm: String, id: UUID, roleClientId: UUID): List<RoleListItem>

clients

abstract fun clients(realm: String): List<ClientListItem>

clientScopeByName

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

clientScopeClientRoles

abstract fun clientScopeClientRoles(realm: String, clientScopeId: UUID, clientId: UUID): List<RoleListItem>

clientScopeMapperExistsByName

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

clientScopeMappers

abstract fun clientScopeMappers(clientScopeId: UUID, realm: String): List<Mapper>

clientScopeRealmRoles

abstract fun clientScopeRealmRoles(realm: String, clientScopeId: UUID): List<RoleListItem>

clientScopes

abstract fun clientScopes(realm: String): List<ClientScope>

clientScopeUUID

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

clientSecret

abstract fun clientSecret(clientId: UUID, realm: String): ClientSecret

clientServiceAccount

abstract fun clientServiceAccount(clientId: UUID, realm: String): User

clientUUID

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

defaultClientScopes

abstract fun defaultClientScopes(realm: String, clientId: UUID): List<ClientScopeItem>

deleteClient

abstract fun deleteClient(clientId: UUID, realm: String)

deleteClientMapper

abstract fun deleteClientMapper(clientId: UUID, mapperId: UUID, realm: String)

deleteClientRoleScopeMappingOfClient

abstract fun deleteClientRoleScopeMappingOfClient(roleScopeMapping: List<RoleListItem>, realm: String, id: UUID, roleClientId: UUID): Response

deleteClientScope

abstract fun deleteClientScope(realm: String, clientScopeId: UUID): Response

deleteClientScopeMapper

abstract fun deleteClientScopeMapper(clientScopeId: UUID, mapperId: UUID, realm: String)

deleteFlow

abstract fun deleteFlow(realm: String, flowId: UUID)

deleteFlowExecution

abstract fun deleteFlowExecution(realm: String, executionId: UUID)

deleteGroup

abstract fun deleteGroup(groupUUID: UUID, realm: String): Response

deleteIdentityProvider

abstract fun deleteIdentityProvider(realm: String, alias: String)

deleteIdentityProviderMapper

abstract fun deleteIdentityProviderMapper(realm: String, alias: String, id: String)

deleteMapper

abstract fun ~~deleteMapper~~(clientId: UUID, mapperId: UUID, realm: String)

deleteRealm

abstract fun deleteRealm(id: String)

deleteRealmRoleScopeMappingOfClient

abstract fun deleteRealmRoleScopeMappingOfClient(roleScopeMapping: List<RoleListItem>, realm: String, id: UUID): Response

deleteRequiredAction

abstract fun deleteRequiredAction(realm: String, alias: String): Response

deleteRole

abstract fun deleteRole(roleId: UUID, realm: String)

deleteUser

abstract fun deleteUser(userId: UUID, realm: String)

deleteUserFederation

abstract fun deleteUserFederation(realm: String, userFederationId: String)

deleteUserFederationMapper

abstract fun deleteUserFederationMapper(realm: String, mapperId: UUID): Response

executionsToImport

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

existsClient

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

existsGroup

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

existsRole

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

existsUser

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

flowExecutions

abstract fun flowExecutions(realm: String, alias: String): List<AuthenticationExecution>

flows

abstract fun flows(realm: String): List<Flow>

getAuthenticatorConfiguration

abstract fun getAuthenticatorConfiguration(realm: String, configurationId: String): AuthenticatorConfig

getCompositeChildRoles

abstract fun getCompositeChildRoles(roleId: UUID, realm: String): List<RoleListItem>

group

abstract fun group(realm: String, groupId: UUID): Group

groupByName

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

groupClientRoles

abstract fun groupClientRoles(realm: String, id: UUID, clientId: UUID): List<RoleListItem>

groupRoles

abstract fun groupRoles(realm: String, id: UUID): List<RoleListItem>

groupUUID

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

identityProvider

abstract fun identityProvider(realm: String, alias: String): IdentityProvider

identityProviderByAlias

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

identityProviderExistsByAlias

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

identityProviderMapper

abstract fun identityProviderMapper(realm: String, alias: String, name: String): IdentityProviderMapper

identityProviderMapperByName

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

identityProviderMapperExistsByName

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

identityProviderMappers

abstract fun identityProviderMappers(realm: String, alias: String): List<IdentityProviderMapper>

identityProviders

abstract fun identityProviders(realm: String): List<IdentityProvider>

importClient

abstract fun importClient(importClientRepresentation: ImportClientRepresentation, realm: String): Response

importFlow

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

ldapMapperByName

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

ldapMapperExistsByName

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

ldapMappers

abstract fun ldapMappers(realm: String, ldapId: String): List<UserFederationMapper>

mappers

abstract fun ~~mappers~~(clientId: UUID, realm: String): List<Mapper>

optionalClientScopes

abstract fun optionalClientScopes(realm: String, clientId: UUID): List<ClientScopeItem>

realmById

fun KeycloakClient.realmById(id: String): Realm

realmExistsById

fun KeycloakClient.realmExistsById(id: String): Boolean

realmNames

abstract fun realmNames(): List<RealmName>

realmRoleScopeMappingsOfClient

abstract fun realmRoleScopeMappingsOfClient(realm: String, id: UUID): List<RoleListItem>

realms

abstract fun realms(): List<Realm>

realmUserProfile

abstract fun realmUserProfile(realm: String): RealmProfile

requiredAction

abstract fun requiredAction(realm: String, alias: String): RequiredActionProviderItem

requiredActions

abstract fun requiredActions(realm: String): List<RequiredActionProviderItem>

revokeClientRoleFromClientScope

abstract fun revokeClientRoleFromClientScope(roles: List<AssignRole>, realm: String, clientScopeId: UUID, clientId: UUID): Response

revokeClientRoles

abstract fun revokeClientRoles(roles: List<AssignRole>, realm: String, userId: UUID, clientId: UUID)

revokeClientRolesFromGroup

abstract fun revokeClientRolesFromGroup(roles: List<AssignRole>, realm: String, groupId: UUID, clientId: UUID)

revokeGroup

abstract fun revokeGroup(realm: String, userId: UUID, groupId: UUID)

revokeRealmRoleFromClientScope

abstract fun revokeRealmRoleFromClientScope(roles: List<AssignRole>, realm: String, clientScopeId: UUID): Response

revokeRealmRoles

abstract fun revokeRealmRoles(roles: List<AssignRole>, realm: String, userId: UUID)

revokeRealmRolesFromGroup

abstract fun revokeRealmRolesFromGroup(roles: List<AssignRole>, realm: String, groupId: UUID)

role

abstract fun role(roleId: UUID, realm: String): Role

roleByName

abstract fun roleByName(name: String, realm: String): Role

roleByNameResponse

abstract fun roleByNameResponse(name: String, realm: String): Response

roleExistsByName

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

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

roles

abstract fun roles(realm: String): List<RoleListItem>

searchByUsername

abstract fun searchByUsername(username: String, realm: String, exact: Boolean = false, from: Int = 0, max: Int = 100): List<User>

searchGroup

abstract fun searchGroup(search: String, realm: String): List<GroupListItem>

searchUser

abstract fun searchUser(search: String, realm: String, max: Int = 100): List<User>

searchUserByQuery

abstract fun searchUserByQuery(query: String, realm: String, from: Int = 0, max: Int = 100): List<User>

sendEmail

abstract fun sendEmail(actions: List<EmailActions>, realm: String, userId: UUID, lifespan: Int = 43200)

Sends an email with the specified actions to the user if smtp is configured for this realm

tryUser

abstract fun tryUser(userId: UUID, realm: String): Response

updateClient

abstract fun updateClient(clientId: UUID, updateClient: Client, realm: String): Response

updateFlow

abstract fun updateFlow(realm: String, flowId: UUID, updateFlow: UpdateFlow)

updateFlowExecution

abstract fun updateFlowExecution(realm: String, alias: String, updateFlowExecution: UpdateFlowExecution): Response

updateFlowExecutionWithNewConfiguration

abstract fun updateFlowExecutionWithNewConfiguration(realm: String, executionId: String, authenticatorConfig: AuthenticatorConfig): Response

updateFlowInPlace

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

updateGroup

abstract fun updateGroup(updateGroup: UpdateGroup, realm: String, groupId: UUID): Response

updateIdentityProvider

abstract fun updateIdentityProvider(updateIdentityProvider: UpdateIdentityProvider, realm: String, alias: String): Response

updateRealm

abstract fun updateRealm(realmId: String, realm: Realm)

updateRequiredAction

abstract fun updateRequiredAction(realm: String, alias: String, requiredActionProviderItem: RequiredActionProviderItem): Response

updateRole

abstract fun updateRole(role: Role, roleId: UUID, realm: String)

updateUser

abstract fun updateUser(userId: UUID, user: User, realm: String)

updateUserPassword

abstract fun updateUserPassword(userId: UUID, resetPassword: ResetPassword, realm: String)

user

abstract fun user(userId: UUID, realm: String): User

userByName

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

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

userClientRoles

abstract fun userClientRoles(realm: String, userId: UUID, clientId: UUID): List<RoleListItem>

userExists

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

userFederations

abstract fun userFederations(realm: String): List<UserFederation>

userGroups

abstract fun userGroups(realm: String, id: UUID): List<UserGroupListItem>

userRoles

abstract fun userRoles(realm: String, id: UUID): List<RoleListItem>

users

abstract fun users(realm: String, max: Int = 100): List<User>

userUUID

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

withdrawDefaultClientScope

abstract fun withdrawDefaultClientScope(realm: String, clientId: UUID, clientScopeId: UUID): Response

withdrawOptionalClientScope

abstract fun withdrawOptionalClientScope(realm: String, clientId: UUID, clientScopeId: UUID): Response