The cl-keycloak Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-keycloak Reference Manual

This is the cl-keycloak Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 14:58:19 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-keycloak

A basic Common Lisp library to connect with Keycloak OIDC and request user info.

License

This project is licensed under GPLv3.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-keycloak

Author

Your Name <your.name@example.com>

License

GPLv3

Description

Describe cl-keycloak here

Version

0.0.1

Dependencies
Source

cl-keycloak.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-keycloak.asd

Location

cl-keycloak.asd

Systems

cl-keycloak (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-keycloak/package.lisp

Parent

cl-keycloak (system)

Location

package.lisp

Packages

cl-keycloak


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-keycloak/authenticate.lisp

Dependency

package.lisp (file)

Parent

cl-keycloak (system)

Location

authenticate.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-keycloak/url-encode.lisp

Dependency

authenticate.lisp (file)

Parent

cl-keycloak (system)

Location

url-encode.lisp

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-keycloak

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: with-client NAME ARGS &body BODY
Package

cl-keycloak

Source

authenticate.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: get-auth-redirect CLIENT &key SCOPE REDIRECT
Package

cl-keycloak

Source

authenticate.lisp (file)

Function: get-user-info CLIENT TOKEN
Package

cl-keycloak

Source

authenticate.lisp (file)

Function: get-well-known CLIENT WELL-KNOWN
Package

cl-keycloak

Source

authenticate.lisp (file)

Function: logout-user CLIENT TOKEN
Package

cl-keycloak

Source

authenticate.lisp (file)

Function: register-client &key CLIENT-ID CLIENT-SECRET SERVER-URL KEY-REALM
Package

cl-keycloak

Source

authenticate.lisp (file)

Function: request-token CLIENT CODE REDIRECT
Package

cl-keycloak

Source

authenticate.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: client-id OBJECT
Generic Function: (setf client-id) NEW-VALUE OBJECT
Package

cl-keycloak

Methods
Method: client-id (CLIENT client)

automatically generated reader method

Source

authenticate.lisp (file)

Method: (setf client-id) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

authenticate.lisp (file)

Generic Function: client-secret OBJECT
Generic Function: (setf client-secret) NEW-VALUE OBJECT
Package

cl-keycloak

Methods
Method: client-secret (CLIENT client)

automatically generated reader method

Source

authenticate.lisp (file)

Method: (setf client-secret) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

authenticate.lisp (file)

Generic Function: key-realm OBJECT
Generic Function: (setf key-realm) NEW-VALUE OBJECT
Package

cl-keycloak

Methods
Method: key-realm (CLIENT client)

automatically generated reader method

Source

authenticate.lisp (file)

Method: (setf key-realm) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

authenticate.lisp (file)

Generic Function: server-url OBJECT
Generic Function: (setf server-url) NEW-VALUE OBJECT
Package

cl-keycloak

Methods
Method: server-url (CLIENT client)

automatically generated reader method

Source

authenticate.lisp (file)

Method: (setf server-url) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

authenticate.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: char-encode CHAR
Package

cl-keycloak

Source

url-encode.lisp (file)

Function: char-encode-p CHAR
Package

cl-keycloak

Source

url-encode.lisp (file)

Function: request-configuration CLIENT
Package

cl-keycloak

Source

authenticate.lisp (file)

Function: string-encode STRING
Package

cl-keycloak

Source

url-encode.lisp (file)

Function: url-encode &rest ARGS
Package

cl-keycloak

Source

url-encode.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Generic functions

Generic Function: server-settings OBJECT
Generic Function: (setf server-settings) NEW-VALUE OBJECT
Package

cl-keycloak

Methods
Method: server-settings (CLIENT client)

automatically generated reader method

Source

authenticate.lisp (file)

Method: (setf server-settings) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

authenticate.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Classes

Class: client ()
Package

cl-keycloak

Source

authenticate.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: client-id
Initargs

:client-id

Readers

client-id (generic function)

Writers

(setf client-id) (generic function)

Slot: client-secret
Initargs

:client-secret

Readers

client-secret (generic function)

Writers

(setf client-secret) (generic function)

Slot: server-url
Initargs

:server-url

Readers

server-url (generic function)

Writers

(setf server-url) (generic function)

Slot: key-realm
Initargs

:key-realm

Readers

key-realm (generic function)

Writers

(setf key-realm) (generic function)

Slot: server-settings
Initargs

nil

Readers

server-settings (generic function)

Writers

(setf server-settings) (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-keycloak.asd: The cl-keycloak<dot>asd file
cl-keycloak/authenticate.lisp: The cl-keycloak/authenticate<dot>lisp file
cl-keycloak/package.lisp: The cl-keycloak/package<dot>lisp file
cl-keycloak/url-encode.lisp: The cl-keycloak/url-encode<dot>lisp file

F
File, Lisp, cl-keycloak.asd: The cl-keycloak<dot>asd file
File, Lisp, cl-keycloak/authenticate.lisp: The cl-keycloak/authenticate<dot>lisp file
File, Lisp, cl-keycloak/package.lisp: The cl-keycloak/package<dot>lisp file
File, Lisp, cl-keycloak/url-encode.lisp: The cl-keycloak/url-encode<dot>lisp file

L
Lisp File, cl-keycloak.asd: The cl-keycloak<dot>asd file
Lisp File, cl-keycloak/authenticate.lisp: The cl-keycloak/authenticate<dot>lisp file
Lisp File, cl-keycloak/package.lisp: The cl-keycloak/package<dot>lisp file
Lisp File, cl-keycloak/url-encode.lisp: The cl-keycloak/url-encode<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

(
(setf client-id): Exported generic functions
(setf client-id): Exported generic functions
(setf client-secret): Exported generic functions
(setf client-secret): Exported generic functions
(setf key-realm): Exported generic functions
(setf key-realm): Exported generic functions
(setf server-settings): Internal generic functions
(setf server-settings): Internal generic functions
(setf server-url): Exported generic functions
(setf server-url): Exported generic functions

C
char-encode: Internal functions
char-encode-p: Internal functions
client-id: Exported generic functions
client-id: Exported generic functions
client-secret: Exported generic functions
client-secret: Exported generic functions

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

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

K
key-realm: Exported generic functions
key-realm: Exported generic functions

L
logout-user: Exported functions

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

R
register-client: Exported functions
request-configuration: Internal functions
request-token: Exported functions

S
server-settings: Internal generic functions
server-settings: Internal generic functions
server-url: Exported generic functions
server-url: Exported generic functions
string-encode: Internal functions

U
url-encode: Internal functions

W
with-client: Exported macros

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   C   K   S  
Index Entry  Section

C
client-id: Internal classes
client-secret: Internal classes

K
key-realm: Internal classes

S
server-settings: Internal classes
server-url: Internal classes
Slot, client-id: Internal classes
Slot, client-secret: Internal classes
Slot, key-realm: Internal classes
Slot, server-settings: Internal classes
Slot, server-url: Internal classes

Jump to:   C   K   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-keycloak: The cl-keycloak system
cl-keycloak: The cl-keycloak package
Class, client: Internal classes
client: Internal classes

P
Package, cl-keycloak: The cl-keycloak package

S
System, cl-keycloak: The cl-keycloak system

Jump to:   C   P   S