Keycloak.Client

Permissions

checkPermission :: ResourceId -> ScopeName -> Token -> Keycloak ()

Checks is a scope is permitted on a resource. An HTTP Exception 403 will be thrown if not.

isAuthorized :: ResourceId -> ScopeName -> Token -> Keycloak Bool

Returns true id the resource is authorized under the given scope.

getAllPermissions :: [ScopeName] -> Token -> Keycloak [Permission]

Return the permissions for all resources, under the given scopes.

Tokens

getUserAuthToken :: Username -> Password -> Keycloak Token

Retrieve the user's token

getClientAuthToken :: Keycloak Token

return a Client token

decodeToken :: Token -> Either String TokenDec

getUsername :: Token -> Maybe Username

Extract user name from a token

Resource

createResource :: Resource -> Token -> Keycloak ResourceId

Create a resource.

deleteResource :: ResourceId -> Token -> Keycloak ()

Delete the resource

Users

getUsers :: Maybe Max -> Maybe First -> Token -> Keycloak [User]

Get users. Default number of users is 100. Parameters max and first allow to paginate and retrieve more than 100 users.

getUser :: UserId -> Token -> Keycloak User

Get a single user, based on his Id

Keycloak basic requests

keycloakPost :: (Postable dat, Show dat) => Path -> dat -> Token -> Keycloak ByteString

Perform post to Keycloak.

keycloakPost' :: (Postable dat, Show dat) => Path -> dat -> Keycloak ByteString

Perform post to Keycloak, without token.

keycloakDelete :: Path -> Token -> Keycloak ()

Perform delete to Keycloak.

keycloakAdminGet :: Path -> Token -> Keycloak ByteString

Perform get to Keycloak on admin API

Helpers

debug :: MonadIO m => String -> m ()

warn :: MonadIO m => String -> m ()

info :: MonadIO m => String -> m ()

err :: MonadIO m => String -> m ()

getErrorStatus :: KCError -> Maybe Status

try :: MonadError a m => m b -> m (Either a b)