The cl-cognito Reference Manual

This is the cl-cognito Reference Manual, version 2.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:49:37 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-cognito

Amazon Cognito Utilities

Author

Bob Felts <>

License

BSD

Version

2.4

Dependencies
  • aws-foundation (system).
  • cl-json-helper (system).
  • local-time (system).
  • ironclad (system).
  • cl-base64 (system).
Source

cl-cognito.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-cognito/cl-cognito.asd

Source

cl-cognito.asd.

Parent Component

cl-cognito (system).

ASDF Systems

cl-cognito.


3.1.2 cl-cognito/package.lisp

Source

cl-cognito.asd.

Parent Component

cl-cognito (system).

Packages

cl-cognito.


3.1.3 cl-cognito/cl-cognito.lisp

Dependency

package.lisp (file).

Source

cl-cognito.asd.

Parent Component

cl-cognito (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-cognito

Source

package.lisp.

Nickname

cognito

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 Ordinary functions

Function: admin-create-user (username pool-id temporary-password access-key secret-key &key service delivery force-alias message-action user-attributes validation-data)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: admin-delete-user (username pool-id access-key secret-key &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: admin-get-user (username pool-id access-key secret-key &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: admin-reset-user-password (username pool-id access-key secret-key &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: admin-update-user-attributes (username pool-id attributes access-key secret-key &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: authenticate-user (username password pool-id client-id &key service client-secret user-email new-password new-full-name new-phone new-email)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: change-password (access-token pool-id old-password new-password &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: confirm-forgot-password (username confirmation-code new-password pool-id client-id &key service client-secret)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: forgot-password (username pool-id client-id &key service client-secret)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: list-users (pool-id access-key secret-key &key service pagination-token)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: new-password-attributes (result_js)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: new-password-required? (result_js)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: reauthenticate-user (username refresh-token pool-id client-id &key service client-secret)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: sign-out (access-token pool-id &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *g*
Package

cl-cognito.

Source

cl-cognito.lisp.

Special Variable: *n*
Package

cl-cognito.

Source

cl-cognito.lisp.


5.2.2 Ordinary functions

Function: admin-delete-user-attributes (username pool-id attributes access-key secret-key &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: attribute (required-attributes attribute-name attribute-value)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: authenticate-change-password (service pool-id username_s client-id session-id secret-hash_s64 new-password_s required-attributes new-full-name_s new-phone_s new-email_s)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: authenticate-verify-password (service pool-id the-time password_s large-a small-a k client-id_s secret-hash_s64 user-email_s challenge-parameters)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: calculate-a (small-a)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: calculate-u (big-a srp-b)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: check-client-secret-parameters (client-secret_s user-email_s)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: client-secret-hash/s64 (username client-id_s client-secret_s)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: cognito-admin-op (operation username pool-id access-key secret-key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: delivery-mediums (delivery)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: do-authenticate-user (the-time username password pool-id client-id service client-secret user-email new-password new-full-name new-phone new-email)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: ensure-even-length (s)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: ensure-leading-00 (s)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: generate-random-small-a ()
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: get-big-random ()
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: get-user (pool-id access-token &key service)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: hash-hex-string (string_hs)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: hex-string-to-integer (s)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: hkdf (ikm salt)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: integer-to-hex-string (n)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: integer-to-padded-hex-string (n)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: make-client-secret/s64 (client-secret client-id username)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: name-value-list (attributes)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: name-value-object (tag attributes)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: password-authentication-key/ba (password_s large-a small-a k pool_s user-id-for-srp srp-b salt)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: power-mod (base exp modulus)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: signature-string/b64s (hkdf_ba pool-id_s user-id_for-srp_s secret-block_ba timestamp_s)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: timestamp-result (the-time result_js result-code response_js)
Package

cl-cognito.

Source

cl-cognito.lisp.

Function: timestamp/s (time)
Package

cl-cognito.

Source

cl-cognito.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   D   E   F   G   H   I   L   M   N   P   R   S   T  
Index Entry  Section

A
admin-create-user: Public ordinary functions
admin-delete-user: Public ordinary functions
admin-delete-user-attributes: Private ordinary functions
admin-get-user: Public ordinary functions
admin-reset-user-password: Public ordinary functions
admin-update-user-attributes: Public ordinary functions
attribute: Private ordinary functions
authenticate-change-password: Private ordinary functions
authenticate-user: Public ordinary functions
authenticate-verify-password: Private ordinary functions

C
calculate-a: Private ordinary functions
calculate-u: Private ordinary functions
change-password: Public ordinary functions
check-client-secret-parameters: Private ordinary functions
client-secret-hash/s64: Private ordinary functions
cognito-admin-op: Private ordinary functions
confirm-forgot-password: Public ordinary functions

D
delivery-mediums: Private ordinary functions
do-authenticate-user: Private ordinary functions

E
ensure-even-length: Private ordinary functions
ensure-leading-00: Private ordinary functions

F
forgot-password: Public ordinary functions
Function, admin-create-user: Public ordinary functions
Function, admin-delete-user: Public ordinary functions
Function, admin-delete-user-attributes: Private ordinary functions
Function, admin-get-user: Public ordinary functions
Function, admin-reset-user-password: Public ordinary functions
Function, admin-update-user-attributes: Public ordinary functions
Function, attribute: Private ordinary functions
Function, authenticate-change-password: Private ordinary functions
Function, authenticate-user: Public ordinary functions
Function, authenticate-verify-password: Private ordinary functions
Function, calculate-a: Private ordinary functions
Function, calculate-u: Private ordinary functions
Function, change-password: Public ordinary functions
Function, check-client-secret-parameters: Private ordinary functions
Function, client-secret-hash/s64: Private ordinary functions
Function, cognito-admin-op: Private ordinary functions
Function, confirm-forgot-password: Public ordinary functions
Function, delivery-mediums: Private ordinary functions
Function, do-authenticate-user: Private ordinary functions
Function, ensure-even-length: Private ordinary functions
Function, ensure-leading-00: Private ordinary functions
Function, forgot-password: Public ordinary functions
Function, generate-random-small-a: Private ordinary functions
Function, get-big-random: Private ordinary functions
Function, get-user: Private ordinary functions
Function, hash-hex-string: Private ordinary functions
Function, hex-string-to-integer: Private ordinary functions
Function, hkdf: Private ordinary functions
Function, integer-to-hex-string: Private ordinary functions
Function, integer-to-padded-hex-string: Private ordinary functions
Function, list-users: Public ordinary functions
Function, make-client-secret/s64: Private ordinary functions
Function, name-value-list: Private ordinary functions
Function, name-value-object: Private ordinary functions
Function, new-password-attributes: Public ordinary functions
Function, new-password-required?: Public ordinary functions
Function, password-authentication-key/ba: Private ordinary functions
Function, power-mod: Private ordinary functions
Function, reauthenticate-user: Public ordinary functions
Function, sign-out: Public ordinary functions
Function, signature-string/b64s: Private ordinary functions
Function, timestamp-result: Private ordinary functions
Function, timestamp/s: Private ordinary functions

G
generate-random-small-a: Private ordinary functions
get-big-random: Private ordinary functions
get-user: Private ordinary functions

H
hash-hex-string: Private ordinary functions
hex-string-to-integer: Private ordinary functions
hkdf: Private ordinary functions

I
integer-to-hex-string: Private ordinary functions
integer-to-padded-hex-string: Private ordinary functions

L
list-users: Public ordinary functions

M
make-client-secret/s64: Private ordinary functions

N
name-value-list: Private ordinary functions
name-value-object: Private ordinary functions
new-password-attributes: Public ordinary functions
new-password-required?: Public ordinary functions

P
password-authentication-key/ba: Private ordinary functions
power-mod: Private ordinary functions

R
reauthenticate-user: Public ordinary functions

S
sign-out: Public ordinary functions
signature-string/b64s: Private ordinary functions

T
timestamp-result: Private ordinary functions
timestamp/s: Private ordinary functions


A.3 Variables