The cl-keycloak Reference Manual

This is the cl-keycloak Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:09:22 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-keycloak

Describe cl-keycloak here

Author

Your Name <>

License

GPLv3

Version

0.0.1

Dependencies
  • drakma (system).
  • flexi-streams (system).
  • yason (system).
Source

cl-keycloak.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-keycloak/cl-keycloak.asd

Source

cl-keycloak.asd.

Parent Component

cl-keycloak (system).

ASDF Systems

cl-keycloak.


3.1.2 cl-keycloak/package.lisp

Source

cl-keycloak.asd.

Parent Component

cl-keycloak (system).

Packages

cl-keycloak.


3.1.3 cl-keycloak/authenticate.lisp

Dependency

package.lisp (file).

Source

cl-keycloak.asd.

Parent Component

cl-keycloak (system).

Public Interface
Internals

3.1.4 cl-keycloak/url-encode.lisp

Dependency

authenticate.lisp (file).

Source

cl-keycloak.asd.

Parent Component

cl-keycloak (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 cl-keycloak

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Macros

Macro: with-client (name args &body body)
Package

cl-keycloak.

Source

authenticate.lisp.


5.1.2 Ordinary functions

Function: get-auth-redirect (client &key scope redirect)
Package

cl-keycloak.

Source

authenticate.lisp.

Function: get-user-info (client token)
Package

cl-keycloak.

Source

authenticate.lisp.

Function: get-well-known (client well-known)
Package

cl-keycloak.

Source

authenticate.lisp.

Function: logout-user (client token)
Package

cl-keycloak.

Source

authenticate.lisp.

Function: register-client (&key client-id client-secret server-url key-realm)
Package

cl-keycloak.

Source

authenticate.lisp.

Function: request-token (client code redirect)
Package

cl-keycloak.

Source

authenticate.lisp.


5.1.3 Generic functions

Generic Reader: client-id (object)
Package

cl-keycloak.

Methods
Reader Method: client-id ((client client))

automatically generated reader method

Source

authenticate.lisp.

Target Slot

client-id.

Generic Writer: (setf client-id) (object)
Package

cl-keycloak.

Methods
Writer Method: (setf client-id) ((client client))

automatically generated writer method

Source

authenticate.lisp.

Target Slot

client-id.

Generic Reader: client-secret (object)
Package

cl-keycloak.

Methods
Reader Method: client-secret ((client client))

automatically generated reader method

Source

authenticate.lisp.

Target Slot

client-secret.

Generic Writer: (setf client-secret) (object)
Package

cl-keycloak.

Methods
Writer Method: (setf client-secret) ((client client))

automatically generated writer method

Source

authenticate.lisp.

Target Slot

client-secret.

Generic Reader: key-realm (object)
Package

cl-keycloak.

Methods
Reader Method: key-realm ((client client))

automatically generated reader method

Source

authenticate.lisp.

Target Slot

key-realm.

Generic Writer: (setf key-realm) (object)
Package

cl-keycloak.

Methods
Writer Method: (setf key-realm) ((client client))

automatically generated writer method

Source

authenticate.lisp.

Target Slot

key-realm.

Generic Reader: server-url (object)
Package

cl-keycloak.

Methods
Reader Method: server-url ((client client))

automatically generated reader method

Source

authenticate.lisp.

Target Slot

server-url.

Generic Writer: (setf server-url) (object)
Package

cl-keycloak.

Methods
Writer Method: (setf server-url) ((client client))

automatically generated writer method

Source

authenticate.lisp.

Target Slot

server-url.


5.2 Internals


5.2.1 Ordinary functions

Function: char-encode (char)
Package

cl-keycloak.

Source

url-encode.lisp.

Function: char-encode-p (char)
Package

cl-keycloak.

Source

url-encode.lisp.

Function: request-configuration (client)
Package

cl-keycloak.

Source

authenticate.lisp.

Function: string-encode (string)
Package

cl-keycloak.

Source

url-encode.lisp.

Function: url-encode (&rest args)
Package

cl-keycloak.

Source

url-encode.lisp.


5.2.2 Generic functions

Generic Reader: server-settings (object)
Package

cl-keycloak.

Methods
Reader Method: server-settings ((client client))

automatically generated reader method

Source

authenticate.lisp.

Target Slot

server-settings.

Generic Writer: (setf server-settings) (object)
Package

cl-keycloak.

Methods
Writer Method: (setf server-settings) ((client client))

automatically generated writer method

Source

authenticate.lisp.

Target Slot

server-settings.


5.2.3 Classes

Class: client
Package

cl-keycloak.

Source

authenticate.lisp.

Direct methods
Direct slots
Slot: client-id
Initargs

:client-id

Readers

client-id.

Writers

(setf client-id).

Slot: client-secret
Initargs

:client-secret

Readers

client-secret.

Writers

(setf client-secret).

Slot: server-url
Initargs

:server-url

Readers

server-url.

Writers

(setf server-url).

Slot: key-realm
Initargs

:key-realm

Readers

key-realm.

Writers

(setf key-realm).

Slot: server-settings
Initargs

nil

Readers

server-settings.

Writers

(setf server-settings).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   F   G   K   L   M   R   S   U   W  
Index Entry  Section

(
(setf client-id): Public generic functions
(setf client-id): Public generic functions
(setf client-secret): Public generic functions
(setf client-secret): Public generic functions
(setf key-realm): Public generic functions
(setf key-realm): Public generic functions
(setf server-settings): Private generic functions
(setf server-settings): Private generic functions
(setf server-url): Public generic functions
(setf server-url): Public generic functions

C
char-encode: Private ordinary functions
char-encode-p: Private ordinary functions
client-id: Public generic functions
client-id: Public generic functions
client-secret: Public generic functions
client-secret: Public generic functions

F
Function, char-encode: Private ordinary functions
Function, char-encode-p: Private ordinary functions
Function, get-auth-redirect: Public ordinary functions
Function, get-user-info: Public ordinary functions
Function, get-well-known: Public ordinary functions
Function, logout-user: Public ordinary functions
Function, register-client: Public ordinary functions
Function, request-configuration: Private ordinary functions
Function, request-token: Public ordinary functions
Function, string-encode: Private ordinary functions
Function, url-encode: Private ordinary functions

G
Generic Function, (setf client-id): Public generic functions
Generic Function, (setf client-secret): Public generic functions
Generic Function, (setf key-realm): Public generic functions
Generic Function, (setf server-settings): Private generic functions
Generic Function, (setf server-url): Public generic functions
Generic Function, client-id: Public generic functions
Generic Function, client-secret: Public generic functions
Generic Function, key-realm: Public generic functions
Generic Function, server-settings: Private generic functions
Generic Function, server-url: Public generic functions
get-auth-redirect: Public ordinary functions
get-user-info: Public ordinary functions
get-well-known: Public ordinary functions

K
key-realm: Public generic functions
key-realm: Public generic functions

L
logout-user: Public ordinary functions

M
Macro, with-client: Public macros
Method, (setf client-id): Public generic functions
Method, (setf client-secret): Public generic functions
Method, (setf key-realm): Public generic functions
Method, (setf server-settings): Private generic functions
Method, (setf server-url): Public generic functions
Method, client-id: Public generic functions
Method, client-secret: Public generic functions
Method, key-realm: Public generic functions
Method, server-settings: Private generic functions
Method, server-url: Public generic functions

R
register-client: Public ordinary functions
request-configuration: Private ordinary functions
request-token: Public ordinary functions

S
server-settings: Private generic functions
server-settings: Private generic functions
server-url: Public generic functions
server-url: Public generic functions
string-encode: Private ordinary functions

U
url-encode: Private ordinary functions

W
with-client: Public macros