Objects
AuthenticationVariable
Property | Type | Required | Description | Reference |
---|---|---|---|---|
name | string | True | The name of the variable | |
value | string | True | The value of the variable |
BasicPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[basic] | True | ||
users | BasicUserPreset | True | A list of users with basic credentials to create | BasicUserPreset |
BasicUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The Basic username of the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
password | string | True | The Basic password of the user. |
BrowserExtraction
Property | Type | Required | Description | Reference |
---|---|---|---|---|
location | BrowserLocation | True | The location of the browser where the value should be extracted | BrowserLocation |
origin | string | True | The origin of the local storage or session storage where the value should be extracted | |
key | string | True | The key to use for the extracted value, depending on the location | |
name | string | True | The name of the variable to store the extracted value into |
BrowserInjection
Property | Type | Required | Description | Reference |
---|---|---|---|---|
location | BrowserLocation | True | The location of the browser where the token should be injected | BrowserLocation |
origin | string | True | The origin of the local storage or session storage where the token should be injected | |
key | string | True | The key to use for the injected token. Its usage depends on the location. | |
variable | string | True | The name of a variable to retrieve to create the token's value. If not provided, the token will be infered as the first successful extraction of the procedure |
CognitoUserpassPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[cognito_userpass] | True | ||
users | CognitoUserpassUserPreset | True | A list of users to create | CognitoUserpassUserPreset |
region | AWSRegion | True | The region of the Cognito Service. | AWSRegion |
client_id | string | True | The client ID to use for the OAuth requests | |
client_secret | string | True | The client secret to use for the OAuth requests |
CognitoUserpassUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The username of the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
password | string | True | The password of the user. | |
scopes | string | False | A list of scopes to request for the user. If not specified, no scope will be requested. |
Credentials
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | False | The username to attach to the HTTP requests sent for this user. See developer.mozilla.org | |
password | string | False | The password to attach to the HTTP requests sent for this user. See developer.mozilla.org | |
headers | HTTPHeader | False | A list of headers to attach to every HTTP requests sent for this user | HTTPHeader |
cookies | HTTPCookie | False | A list of cookies to attach to every HTTP requests sent for this user | HTTPCookie |
queryParameters | HTTPQueryParameter | False | A list of query parameters to attach to every HTTP requests sent for this user | HTTPQueryParameter |
body | Any | False | A body to merge with the bodies of every HTTP requests sent for this user | |
local_storage | Dict[string, Dict[string, string]] | False | A dictionary of origins and key values for a local storage to attach to the user | |
session_storage | Dict[string, Dict[string, string]] | False | A dictionary of origins and key values for a session storage to attach to the user |
DigestOperation
Property | Type | Required | Description | Reference |
---|---|---|---|---|
tech | Const[digest] | True | ||
parameters | DigestRequestSequence | True | The parameters of the HTTP requests executed during the digest procedure.It features two HTTP requests: the first one is the one that returns the WWW-Authenticate header,and the second one is the one that uses the digest authentication. | DigestRequestSequence |
extractions | BrowserExtraction | True | BrowserExtraction |
DigestPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[digest] | True | ||
users | BasicUserPreset | True | The list of users to generate tokens for. | BasicUserPreset |
first_request | HTTPRequestPreset | True | The parameters of the first HTTP request executed during the digest procedure.It is the one that returns the WWW-Authenticate header. | HTTPRequestPreset |
second_request | DigestSecondRequestConfiguration | False | The parameters of the second HTTP request executed during the digest procedure.It is the one that uses the digest authentication. By default, parameters of the first request are used. | DigestSecondRequestConfiguration |
DigestRequestSequence
Property | Type | Required | Description | Reference |
---|---|---|---|---|
first_request | HTTPRequestParameters | True | The parameters of the first HTTP request executed during the digest procedure.It is the one that returns the WWW-Authenticate header. | HTTPRequestParameters |
second_request | DigestSecondRequestConfiguration | False | The parameters of the second HTTP request executed during the digest procedure.It is the one that uses the digest authentication. By default, parameters of the first request are used. | DigestSecondRequestConfiguration |
DigestSecondRequestConfiguration
Property | Type | Required | Description | Reference |
---|---|---|---|---|
url | string | False | The URL of the second HTTP request executed during the digest procedure.By default, the URL of the first request is used. | |
method | HTTPMethod | False | The method of the second HTTP request executed during the digest procedure.By default, the method of the first request is used. | HTTPMethod |
GraphQLPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[graphql] | True | ||
users | GraphQLUserPreset | True | A list of users with credentials contained in the GraphQL variables of the query | GraphQLUserPreset |
url | string | True | The URL of the GraphQL authentication endpoint. | |
query | string | True | The templated GraphQL inside the query field of the JSON body of the HTTP request. | |
extractions | TokenExtraction | False | The extractions of the GraphQL query containing the user credentials. | TokenExtraction |
injections | TokenInjection | False | The injections of the GraphQL query containing the user credentials. | TokenInjection |
GraphQLUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The name of the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
variables | Dict[string, string] | True | The variables of the GraphQL query containing the user credentials. |
HTTPCookie
Property | Type | Required | Description | Reference |
---|---|---|---|---|
name | string | True | ||
values | string | True |
HTTPHeader
Property | Type | Required | Description | Reference |
---|---|---|---|---|
name | string | True | ||
values | string | True |
HTTPOperation
Property | Type | Required | Description | Reference |
---|---|---|---|---|
tech | Const[http] | True | ||
parameters | HTTPRequestParameters | True | The parameters of the HTTP request to send. At least a URL and a method must be provided. | HTTPRequestParameters |
extractions | TokenExtraction | True | The list of extractions to run at the end of the operation.For HTTP operations, variables are extracted from the response. | TokenExtraction |
HTTPPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[http] | True | ||
users | HTTPUserPreset | True | The list of users to generate tokens for. | HTTPUserPreset |
request | HTTPRequestPreset | True | The parameters of the HTTP request used to fetch the access and refresh tokens. | HTTPRequestPreset |
extractions | TokenExtraction | True | The token extraction configuration used to extract the tokens from the HTTP response. | TokenExtraction |
injections | TokenInjection | True | The injection configuration used to inject the tokens into the HTTP requests. | TokenInjection |
HTTPQueryParameter
Property | Type | Required | Description | Reference |
---|---|---|---|---|
name | string | True | ||
values | string | True |
HTTPRequestParameters
Property | Type | Required | Description | Reference |
---|---|---|---|---|
url | string | True | The URL to send the request to | |
method | HTTPMethod | True | The HTTP method to use | HTTPMethod |
headers | HTTPHeader | True | The list of headers to attach to the request. Headers are merged with the user credentials headers. It is possible to attach mutliple values to a header. | HTTPHeader |
cookies | HTTPCookie | True | The list of cookies to attach to the request. Cookies are merged with the user credentials cookies. It is possible to attach mutliple values to a cookie. Cookie values are url-encoded before being sent. | HTTPCookie |
queryParameters | HTTPQueryParameter | True | The list of query parameters to attach to the request. Query parameters are merged with the user credentials query parameters. It is possible to attach mutliple values to a query parameter. Query parameter values are url-encoded before being sent. | HTTPQueryParameter |
body | Any | False | The body of the request. It can be a string or a JSON object. It is merged with the user credentials body if provided. If bodies of the HTTP request and of the user credentials are both JSON objects, they are merged. If the two bodies are strings, they are concatenated. If the two bodies are of different types, the body of the user credentials is used instead of this value. | |
proxy | string | False | An eventual proxy used for this request | |
timeout | integer | False | The timeout of the request in seconds | |
insecure | boolean | False | If the SSL certificate should be verified | |
follow_redirects | integer | False | The number of redirects to follow |
HTTPRequestPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
url | string | True | The URL to send the request to | |
method | HTTPMethod | True | The HTTP method to use | HTTPMethod |
headers | Dict[string, string] | False | The list of headers to attach to the request. Headers are merged with the user credentials headers. It is possible to attach mutliple values to a header. | |
cookies | Dict[string, string] | False | The list of cookies to attach to the request. Cookies are merged with the user credentials cookies. It is possible to attach mutliple values to a cookie. Cookie values are url-encoded before being sent. | |
query_parameters | Dict[string, string] | False | The list of query parameters to attach to the request. Query parameters are merged with the user credentials query parameters. It is possible to attach mutliple values to a query parameter. Query parameter values are url-encoded before being sent. | |
body | Any | False | The body of the request. It can be a string or a JSON object. It is merged with the user credentials body if provided. If bodies of the HTTP request and of the user credentials are both JSON objects, they are merged. If the two bodies are strings, they are concatenated. If the two bodies are of different types, the body of the user credentials is used instead of this value. |
HTTPUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The username to attach to the HTTP requests sent for this user. See developer.mozilla.org | |
headers | Dict[string, string] | False | A dict representing the headers to attach to every HTTP requests sent for this user | |
cookies | Dict[string, string] | False | A dict representing the cookies to attach to every HTTP requests sent for this user | |
password | string | False | The password to attach to the HTTP requests sent for this user. See developer.mozilla.org | |
queryParameters | Dict[string, string] | False | A dict of query parameters to attach to every HTTP requests sent for this user | |
body | Any | False | A body to merge with the bodies of every HTTP requests sent for this user |
HeadersPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[headers] | True | ||
users | HeadersUserPreset | True | A list of users with basic credentials to create | HeadersUserPreset |
HeadersUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The name of the user. | |
headers | Dict[string, string] | True | The headers of the user. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. |
OAuthClientCredentialsPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[oauth_client_credentials] | True | ||
users | OAuthClientCredentialsUserPreset | True | A list of users to create | OAuthClientCredentialsUserPreset |
url | string | True | The URL of the token endpoint of the OpenIDConnect server |
OAuthClientCredentialsUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The arbitrary username given to the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
client_id | string | True | The client ID to use for the OAuth requests | |
client_secret | string | True | The client secret to use for the OAuth requests | |
scopes | string | False | A list of scopes to request for the user. If not specified, no scope will be requested. |
OAuthUserpassPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[oauth_userpass] | True | ||
users | OAuthUserpassUserPreset | True | A list of users to create | OAuthUserpassUserPreset |
url | string | True | The URL of the token endpoint of the OpenIDConnect server | |
client_id | string | True | The client ID to use for the OAuth requests | |
client_secret | string | True | The client secret to use for the OAuth requests |
OAuthUserpassUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The username of the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
password | string | True | The password of the user. | |
scopes | string | False | A list of scopes to request for the user. If not specified, no scope will be requested. |
PlaywrightOperation
Property | Type | Required | Description | Reference |
---|---|---|---|---|
tech | Const[playwright] | True | ||
parameters | PlaywrightOperationParameters | True | The parameters of the operation. | PlaywrightOperationParameters |
extractions | BrowserExtraction | True | BrowserExtraction |
PlaywrightOperationParameters
Property | Type | Required | Description | Reference |
---|---|---|---|---|
login_url | string | True | The url that presents the login form | |
username | string | True | The username that will be used to auto login | |
password | string | True | The password that will be used to auto login | |
string | True | The email that will be used to auto login |
PlaywrightPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[playwright] | True | ||
users | PlaywrightUserPreset | True | The list of users to generate tokens for. | PlaywrightUserPreset |
login_url | string | True | The url that presents the login form | |
extractions | BrowserExtraction | False | The token extraction configuration used to extract the tokens | |
from the HTTP response or the browser storage itself. | BrowserExtraction | |||
injections | TokenInjection | False | The injection configuration used to inject the tokens into the HTTP requests. | TokenInjection |
PlaywrightUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The arbitrary name that identifies the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
string | True | The email that will be used to auto login | ||
password | string | True | The password that will be used to auto login |
Procedure
Property | Type | Required | Description | Reference |
---|---|---|---|---|
name | string | True | The name of the procedure. It must be unique and is used to reference the procedure in users. | |
operations | `DigestOperation | HTTPOperation | PlaywrightOperation` | True |
injections | TokenInjection | True | The list of injections to perform at the end of the procedure. Injections are used to inject the variables extracted from the procedure into the user authentication. | TokenInjection |
TokenExtraction
Property | Type | Required | Description | Reference |
---|---|---|---|---|
location | HTTPLocation | True | The location of the HTTP request where the value should be extracted | HTTPLocation |
key | string | True | The key to use for the extracted value, depending on the location | |
regex | string | False | The regex to use to extract the token from the key value. By default the entire value is taken. | |
name | string | True | The name of the variable to store the extracted value into |
TokenInjection
Property | Type | Required | Description | Reference |
---|---|---|---|---|
location | HTTPLocation | True | The location of the HTTP request where the token should be injected | HTTPLocation |
key | string | True | The key to use for the injected token. Its usage depends on the location. For headers, cookies,and query parameters, this key describes the name of the header, cookie or query parameter. For a body location, the key is the field where the token should be injected within the request bodies | |
prefix | string | False | A prefix to prepend to the token before it is injected | |
variable | string | True | The name of a variable to retrieve to create the token's value. If not provided, the token will be infered as the first successful extraction of the procedure |
User
Property | Type | Required | Description | Reference |
---|---|---|---|---|
name | string | True | The name of the user | |
credentials | Credentials | False | A set of HTTP parameters used to customize requests sent for the user. | Credentials |
procedure | string | False | The name of the procedure to use to authenticate the user.This name MUST match the name field of a procedure in the procedures list in the multiauth configuration. | |
variables | AuthenticationVariable | False | List of variables that will be injected at the beginning of the user's authentication procedure. | AuthenticationVariable |
refresh | UserRefresh | False | An optional refresh procedure to follow for the user. | UserRefresh |
repeater_mtls | boolean | False | Pass this field to true if you want to use your repeater mTLS certificates. |
UserRefresh
Property | Type | Required | Description | Reference |
---|---|---|---|---|
procedure | string | False | An optional custom procedure to use to refresh the authentication of the user. Defaults to the user procedure if not provided. This name MUST match the name field of a procedure in the procedures list in the multiauth configuration. | |
sessionSeconds | integer | False | Number of seconds to wait before refreshing the authentication. If not provided, multiauth willtry to infer the session duration from the returned variables | |
keep | boolean | True | If true, multiauth will keep the current tokens and use a merge of the refreshed authenticationand the current one. | |
credentials | Credentials | False | Credentials to use to refresh the authentication. If not provided, the user credentials will be used. | Credentials |
variables | AuthenticationVariable | False | List of variables that will be injected at the beginning of the user'srefresh procedure. If not provided, the user's variables will be used instead. | AuthenticationVariable |
cURLPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[curl] | True | ||
users | cURLUserPreset | True | The list of users to generate tokens for. | cURLUserPreset |
extractions | TokenExtraction | True | The token extraction configuration used to extract the tokens from the HTTP response. | TokenExtraction |
injections | TokenInjection | True | The injection configuration used to inject the tokens into the HTTP requests. | TokenInjection |
cURLSequencePreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
type | Const[curl_sequence] | True | ||
users | cURLSequenceUserPreset | True | The list of users to generate tokens for. | cURLSequenceUserPreset |
requests | cURLSequenceRequestPreset | True | A sequence of curl templates used to make requests and extract variables. | cURLSequenceRequestPreset |
injections | TokenInjection | False | Final variables injected into the authentified requests. | TokenInjection |
cURLSequenceRequestPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
curl | string | True | A curl template used to make a request. | |
extractions | TokenExtraction | False | Variables extracted from the response that can be templated in further requests. | TokenExtraction |
cURLSequenceUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The arbitrary name that identifies the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
variables | Dict[string, string] | False | A dict of variables to inject into the cURL sequences. |
cURLUserPreset
Property | Type | Required | Description | Reference |
---|---|---|---|---|
username | string | True | The arbitrary name that identifies the user. | |
headers | Dict[string, string] | False | Optional headers injected during the authentication process and in authentified requests. | |
cookies | Dict[string, string] | False | Optional cookies injected during the authentication process and in authentified requests. | |
curl | string | True | The curl command that is used to fetch the tokens for this user. |
Enums
AWSRegion
us-east-2
us-east-1
us-west-1
us-west-2
af-south-1
ap-east-1
ap-south-1
ap-northeast-3
ap-northeast-2
ap-southeast-1
ap-southeast-2
ap-northeast-1
ca-central-1
cn-north-1
cn-northwest-1
eu-central-1
eu-west-1
eu-west-2
eu-south-1
eu-west-3
eu-north-1
me-south-1
sa-east-1
BrowserLocation
browser_local_storage
browser_session_storage
HTTPLocation
header
cookie
body
query
HTTPMethod
CONNECT
DELETE
GET
HEAD
OPTIONS
PATCH
POST
PUT
TRACE