Liking cljdoc? Tell your friends :D

auth0-automation.core


-mainclj

(-main & args)

This program assumes no other users are changing the current Auth0 environment, and makes no attempt to detect simultaneous use. Make sure no one else is updating the environment while running this script!

This program assumes no other users are changing the current Auth0 environment,
and makes no attempt to detect simultaneous use. Make sure no one else is updating
the environment while running this script!
sourceraw docstring

ABORTclj

source

abort-interceptorclj

Ensure that the case where a user decides to quit can be handled. If at any decision point the user chooses to abort, capture it in ::abort.

Ensure that the case where a user decides to quit can be handled.
If at any decision point the user chooses to abort, capture it in `::abort`.
sourceraw docstring

args->optsclj

(args->opts args)

Turn command-line arguments into an opts hashmap, used to control program behavior

Turn command-line arguments into an opts hashmap, used to control program behavior
sourceraw docstring

cli-optionsclj

The parse-opts cli options to provide the program

The `parse-opts` cli options to provide the program
sourceraw docstring

confirm-api-actionsclj

When :interactive? is true, confirm api-actions with user, giving them a chance to abort.

When `:interactive?` is true, confirm `api-actions` with user, giving them a chance to abort.
sourceraw docstring

determine-api-actionsclj

Create a data structure that represents the actions that are needed to create the desired Auth0 environment based on the current one.

Create a data structure that represents the actions that are needed to create
the desired Auth0 environment based on the current one.
sourceraw docstring

determine-exit-codeclj

(determine-exit-code ctx)

A function to use the result interceptor context to determine an exit-code.

A function to use the result interceptor context to determine an exit-code.
sourceraw docstring

determine-outputclj

(determine-output ctx)

Use the exit-code, ::exception, ::errors, and ::abort to determine how to communicate results to the user.

Use the exit-code, ::exception, ::errors, and ::abort to determine how to communicate results to the user.
sourceraw docstring

ensure-edn-configurationclj

Reads the edn-configuration file that describes the desired Auth0 environment

If passed in through opts, use that, otherwise attempt to load file using environment variable.

Reads the `edn-configuration` file that describes the desired Auth0 environment

If passed in through `opts`, use that, otherwise attempt to load file using environment variable.
sourceraw docstring

ensure-entity-manipulation-configurationclj

Reads the entity-manipulation-configuration file that describes entity-specific configuration details for concerns of interacting with the Auth0 Management API

If passed in through opts, use that, otherwise attempt to load the resource file

Reads the `entity-manipulation-configuration` file that describes entity-specific configuration
details for concerns of interacting with the Auth0 Management API

If passed in through `opts`, use that, otherwise attempt to load the resource file
sourceraw docstring

ensure-env-configclj

Adds env-config to the context.

If passed in through opts, use that, otherwise use the environment variables.

Adds `env-config` to the context.

If passed in through `opts`, use that, otherwise use the environment variables.
sourceraw docstring

env-configclj

A convenient representation of the environment variables that are needed

A convenient representation of the environment variables that are needed
sourceraw docstring

ERRORSclj

source

errors-interceptorclj

Ensures that this program's errors can be defined and respected as part of the interceptor chain. If any expected errors occurs during the process, capture them in ::errors.

Ensures that this program's errors can be defined and respected as part of the interceptor chain.
If any expected errors occurs during the process, capture them in `::errors`.
sourceraw docstring

EXCEPTIONclj

source

exception-interceptorclj

If an unexpected exception occurs during the process, capture it in ::exception.

If an unexpected exception occurs during the process, capture it in `::exception`.
sourceraw docstring

format-outputclj

(format-output {:keys [summary details ctx] :as edn-output}
               {{:keys [output-format verbose?]} :opts :as ctx})

Based on output-format and other options, determine the program output.

Based on `output-format` and other options, determine the program output.
sourceraw docstring

get-api-action-errorclj

(get-api-action-error {:keys [node-type]} {:keys [error] :as api-response})

Return an error if there was an error, else nil

When there are errors, the status-code, error, error-code, and message keys are available.

Return an error if there was an error, else nil

When there are errors, the `status-code`, `error`, `error-code`, and `message` keys are
available.
sourceraw docstring

get-api-action-transact-errorsclj

(get-api-action-transact-errors api-actions api-responses)

Detects and collects any errors that occurred while transacting api-actions, based on api-responses.

Detects and collects any errors that occurred while transacting `api-actions`, based on `api-responses`.
sourceraw docstring

get-auth0-tokenclj

Attempts to get an Auth0 Management API token

Attempts to get an Auth0 Management API token
sourceraw docstring

get-edn-outputcljmultimethod

Use the exit-code to chose how to contruct the program output

Use the `exit-code` to chose how to contruct the program output
sourceraw docstring

interceptor-pipelineclj

The pipeline of interceptors used to perform the Auth0 environment update

The pipeline of interceptors used to perform the Auth0 environment update
sourceraw docstring

report-resultsclj

(report-results {:keys [output]})

Print output

Print `output`
sourceraw docstring

runclj

(run {:keys [exit?] :as opts :or {exit? true}})

Run the Auth0 environment update, report results, and exit.

Run the Auth0 environment update, report results, and exit.
sourceraw docstring

run-pipelineclj

(run-pipeline opts)
(run-pipeline opts pipeline)

Perform the Auth0 environment update to match the desired configuration

Perform the Auth0 environment update to match the desired configuration
sourceraw docstring

SUCCESSclj

source

transact-api-actions!clj

Performs the actions identified by ::api-actions against the Auth0 environment

Performs the actions identified by `::api-actions` against the Auth0 environment
sourceraw docstring

usageclj

(usage options-summary)

Print out the usage for run

Print out the usage for run
sourceraw docstring

verbose-ctxclj

(verbose-ctx ctx)

Removes some keys from the context that don't provide value to the user.

Removes some keys from the context that don't provide value to the user.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close