Keycloak.Client

Permissions

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

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

getPermissions :: [PermReq] -> Token -> Keycloak [Permission]

Return the permissions for the permission requests.

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

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

Tokens

getUserAuthToken :: Username -> Password -> Keycloak Token

Retrieve the user's token. This token will be used for every other Keycloak calls.

getClientAuthToken :: Keycloak Token

return a Client token. It is useful to create Resources.

getUsername :: Token -> Username

Extract user name from a token

Resource

createResource :: Resource -> Token -> Keycloak ResourceId

Create an authorization resource in Keycloak, under the configured client.

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

Delete the resource

deleteAllResources :: Token -> Keycloak ()

Delete all resources in Keycloak

getResource :: ResourceId -> Token -> Keycloak Resource

get a single resource

getAllResourceIds :: Keycloak [ResourceId]

get all resources IDs

updateResource :: Resource -> Token -> Keycloak ResourceId

Update a resource

Users

getUsers :: Maybe Max -> Maybe First -> Maybe Username -> 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

createUser :: User -> Token -> Keycloak UserId

Create a user

updateUser :: UserId -> User -> Token -> Keycloak ()

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.

keycloakGet :: Path -> Token -> Keycloak ByteString

Perform get to Keycloak on admin API

keycloakAdminGet :: Path -> Token -> Keycloak ByteString

Perform get to Keycloak on admin API

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

Perform post to Keycloak.

keycloakAdminPut :: (Putable dat, Show dat) => Path -> dat -> Token -> Keycloak ()

Perform put to Keycloak.

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)