Skip to main content

Objects

AuthenticationVariable

PropertyTypeRequiredDescriptionReference
namestringTrueThe name of the variable
valuestringTrueThe value of the variable

BasicPreset

PropertyTypeRequiredDescriptionReference
typeConst[basic]True
usersBasicUserPresetTrueA list of users with basic credentials to createBasicUserPreset

BasicUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe Basic username of the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
passwordstringTrueThe Basic password of the user.

CognitoUserpassPreset

PropertyTypeRequiredDescriptionReference
typeConst[cognito_userpass]True
usersCognitoUserpassUserPresetTrueA list of users to createCognitoUserpassUserPreset
regionAWSRegionTrueThe region of the Cognito Service.AWSRegion
client_idstringTrueThe client ID to use for the OAuth requests
client_secretstringTrueThe client secret to use for the OAuth requests

CognitoUserpassUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe username of the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
passwordstringTrueThe password of the user.
scopesstringFalseA list of scopes to request for the user. If not specified, no scopes will be requested.

Credentials

PropertyTypeRequiredDescriptionReference
usernamestringFalseThe username to attach to the HTTP requests sent for this user. See developer.mozilla.org
passwordstringFalseThe password to attach to the HTTP requests sent for this user. See developer.mozilla.org
headersHTTPHeaderFalseA list of headers to attach to every HTTP requests sent for this userHTTPHeader
cookiesHTTPCookieFalseA list of cookies to attach to every HTTP requests sent for this userHTTPCookie
queryParametersHTTPQueryParameterFalseA list of query parameters to attach to every HTTP requests sent for this userHTTPQueryParameter
bodyAnyFalseA body to merge with the bodies of every HTTP requests sent for this user

DigestOperation

PropertyTypeRequiredDescriptionReference
techConst[digest]True
parametersDigestRequestSequenceTrueThe 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
extractionsTokenExtractionTrueTokenExtraction

DigestPreset

PropertyTypeRequiredDescriptionReference
typeConst[digest]True
usersBasicUserPresetTrueThe list of users to generate tokens for.BasicUserPreset
first_requestHTTPRequestPresetTrueThe parameters of the first HTTP request executed during the digest procedure.It is the one that returns the WWW-Authenticate header.HTTPRequestPreset
second_requestDigestSecondRequestConfigurationFalseThe 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

PropertyTypeRequiredDescriptionReference
first_requestHTTPRequestParametersTrueThe parameters of the first HTTP request executed during the digest procedure.It is the one that returns the WWW-Authenticate header.HTTPRequestParameters
second_requestDigestSecondRequestConfigurationFalseThe 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

PropertyTypeRequiredDescriptionReference
urlstringFalseThe URL of the second HTTP request executed during the digest procedure.By default, the URL of the first request is used.
methodHTTPMethodFalseThe method of the second HTTP request executed during the digest procedure.By default, the method of the first request is used.HTTPMethod

GraphQLPreset

PropertyTypeRequiredDescriptionReference
typeConst[graphql]True
usersGraphQLUserPresetTrueA list of users with credentials contained in the GraphQL variables of the queryGraphQLUserPreset
urlstringTrueThe URL of the GraphQL authentication endpoint.
querystringTrueThe templated GraphQL inside the query field of the JSON body of the HTTP request.
extractionsTokenExtractionFalseThe extractions of the GraphQL query containing the user credentials.TokenExtraction
injectionsTokenInjectionFalseThe injections of the GraphQL query containing the user credentials.TokenInjection

GraphQLUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe name of the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
variablesDict[string, string]TrueThe variables of the GraphQL query containing the user credentials.

HTTPCookie

PropertyTypeRequiredDescriptionReference
namestringTrue
valuesstringTrue

HTTPHeader

PropertyTypeRequiredDescriptionReference
namestringTrue
valuesstringTrue

HTTPOperation

PropertyTypeRequiredDescriptionReference
techConst[http]True
parametersHTTPRequestParametersTrueThe parameters of the HTTP request to send. At least a URL and a method must be provided.HTTPRequestParameters
extractionsTokenExtractionTrueThe list of extractions to run at the end of the operation.For HTTP operations, variables are extracted from the response.TokenExtraction

HTTPPreset

PropertyTypeRequiredDescriptionReference
typeConst[http]True
usersHTTPUserPresetTrueThe list of users to generate tokens for.HTTPUserPreset
requestHTTPRequestPresetTrueThe parameters of the HTTP request used to fetch the access and refresh tokens.HTTPRequestPreset
extractionsTokenExtractionTrueThe token extraction configuration used to extract the tokens from the HTTP response.TokenExtraction
injectionsTokenInjectionTrueThe injection configuration used to inject the tokens into the HTTP requests.TokenInjection

HTTPQueryParameter

PropertyTypeRequiredDescriptionReference
namestringTrue
valuesstringTrue

HTTPRequestParameters

PropertyTypeRequiredDescriptionReference
urlstringTrueThe URL to send the request to
methodHTTPMethodTrueThe HTTP method to useHTTPMethod
headersHTTPHeaderTrueThe 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
cookiesHTTPCookieTrueThe 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
queryParametersHTTPQueryParameterTrueThe 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
bodyAnyFalseThe 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.
proxystringFalseAn eventual proxy used for this request

HTTPRequestPreset

PropertyTypeRequiredDescriptionReference
urlstringTrueThe URL to send the request to
methodHTTPMethodTrueThe HTTP method to useHTTPMethod
headersDict[string, string]FalseThe 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.
cookiesDict[string, string]FalseThe 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_parametersDict[string, string]FalseThe 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.
bodyAnyFalseThe 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

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe username to attach to the HTTP requests sent for this user. See developer.mozilla.org
headersDict[string, string]FalseA dict representing the headers to attach to every HTTP requests sent for this user
cookiesDict[string, string]FalseA dict representing the cookies to attach to every HTTP requests sent for this user
passwordstringFalseThe password to attach to the HTTP requests sent for this user. See developer.mozilla.org
queryParametersDict[string, string]FalseA dict of query parameters to attach to every HTTP requests sent for this user
bodyAnyFalseA body to merge with the bodies of every HTTP requests sent for this user

HeadersPreset

PropertyTypeRequiredDescriptionReference
typeConst[headers]True
usersHeadersUserPresetTrueA list of users with basic credentials to createHeadersUserPreset

HeadersUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe name of the user.
headersDict[string, string]TrueThe headers of the user.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.

OAuthClientCredentialsPreset

PropertyTypeRequiredDescriptionReference
typeConst[oauth_client_credentials]True
usersOAuthClientCredentialsUserPresetTrueA list of users to createOAuthClientCredentialsUserPreset
urlstringTrueThe URL of the token endpoint of the OpenIDConnect server

OAuthClientCredentialsUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe arbitrary username given to the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
client_idstringTrueThe client ID to use for the OAuth requests
client_secretstringTrueThe client secret to use for the OAuth requests
scopesstringFalseA list of scopes to request for the user. If not specified, no scopes will be requested.

OAuthUserpassPreset

PropertyTypeRequiredDescriptionReference
typeConst[oauth_userpass]True
usersOAuthUserpassUserPresetTrueA list of users to createOAuthUserpassUserPreset
urlstringTrueThe URL of the token endpoint of the OpenIDConnect server
client_idstringTrueThe client ID to use for the OAuth requests
client_secretstringTrueThe client secret to use for the OAuth requests

OAuthUserpassUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe username of the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
passwordstringTrueThe password of the user.
scopesstringFalseA list of scopes to request for the user. If not specified, no scopes will be requested.

Procedure

PropertyTypeRequiredDescriptionReference
namestringTrueThe name of the procedure. It must be unique and is used to reference the procedure in users.
operations`DigestOperationSeleniumOperationHTTPOperation`True
injectionsTokenInjectionTrueThe 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

SeleniumCommand

PropertyTypeRequiredDescriptionReference
idstringTrue
commandstringTrueThe command of the test.
targetstringTrueThe target of the test.
targetsstringTrueThe targets of the test.
valuestringTrueThe value of the test.

SeleniumOperation

PropertyTypeRequiredDescriptionReference
techConst[selenium]True
parametersSeleniumOperationParametersTrueThe parameters of the Selenium operation.SeleniumOperationParameters
extractionsTokenExtractionTrueTokenExtraction

SeleniumOperationParameters

PropertyTypeRequiredDescriptionReference
projectSeleniumProjectTrueThe Selenium project used to run the script. It is the one that contains the tests and commands to run. The project script can be generated using the Selenium IDE. See selenium.devSeleniumProject
optionsSeleniumScriptOptionsTrueThe options of the Selenium script.SeleniumScriptOptions

SeleniumProject

PropertyTypeRequiredDescriptionReference
testsSeleniumTestTrueThe tests of the Selenium script.SeleniumTest

SeleniumScriptOptions

PropertyTypeRequiredDescriptionReference
wait_for_secondsintegerFalseThe number of seconds to wait at various steps of the script. For example when waiting for a page to load.
proxystringFalseThe proxy used to run the script.

SeleniumTest

PropertyTypeRequiredDescriptionReference
idstringTrueThe id of the test.
namestringTrueThe name of the test.
commandsSeleniumCommandTrueThe commands of the test.SeleniumCommand

TokenExtraction

PropertyTypeRequiredDescriptionReference
locationHTTPLocationTrueThe location of the HTTP request where the value should be extractedHTTPLocation
keystringTrueThe key to use for the extracted value, depending on the location
regexstringFalseThe regex to use to extract the token from the key value. By default the entire value is taken.
namestringTrueThe name of the variable to store the extracted value into

TokenInjection

PropertyTypeRequiredDescriptionReference
locationHTTPLocationTrueThe location of the HTTP request where the token should be injectedHTTPLocation
keystringTrueThe 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
prefixstringFalseA prefix to prepend to the token before it is injected
variablestringTrueThe 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

PropertyTypeRequiredDescriptionReference
namestringTrueThe name of the user
credentialsCredentialsFalseA set of HTTP parameters used to customize requests sent for the user.Credentials
procedurestringFalseThe 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.
variablesAuthenticationVariableFalseList of variables that will be injected at the beginning of the user's authentication procedure.AuthenticationVariable
refreshUserRefreshFalseAn optional refresh procedure to follow for the user.UserRefresh

UserRefresh

PropertyTypeRequiredDescriptionReference
procedurestringFalseAn 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.
sessionSecondsintegerFalseNumber of seconds to wait before refreshing the authentication. If not provided, multiauth willtry to infer the session duration from the returned variables
keepbooleanTrueIf true, multiauth will keep the current tokens and use a merge of the refreshed authenticationand the current one.
credentialsCredentialsFalseCredentials to use to refresh the authentication. If not provided, the user credentials will be used.Credentials
variablesAuthenticationVariableFalseList 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

WebdriverPreset

PropertyTypeRequiredDescriptionReference
typeConst[webdriver]True
usersWebdriverUserPresetTrueThe list of users to generate tokens for.WebdriverUserPreset
wait_for_secondsintegerFalseThe number of seconds to wait at various steps of the script. For example when waiting for a page to load.
extractionsTokenExtractionFalseThe token extraction configuration used to extract the tokens from the HTTP response.TokenExtraction
injectionsTokenInjectionFalseThe injection configuration used to inject the tokens into the HTTP requests.TokenInjection

WebdriverUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe arbitrary name that identifies the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
projectSeleniumProjectTrueThe Selenium project used to run the script. It is the one that contains the tests and commands to run. The project script can be generated using the Selenium IDE. See selenium.devSeleniumProject

cURLPreset

PropertyTypeRequiredDescriptionReference
typeConst[curl]True
userscURLUserPresetTrueThe list of users to generate tokens for.cURLUserPreset
extractionsTokenExtractionTrueThe token extraction configuration used to extract the tokens from the HTTP response.TokenExtraction
injectionsTokenInjectionTrueThe injection configuration used to inject the tokens into the HTTP requests.TokenInjection

cURLSequencePreset

PropertyTypeRequiredDescriptionReference
typeConst[curl_sequence]True
userscURLSequenceUserPresetTrueThe list of users to generate tokens for.cURLSequenceUserPreset
requestscURLSequenceRequestPresetTrueA sequence of curl templates used to make requests and extract variables.cURLSequenceRequestPreset
injectionsTokenInjectionFalseFinal variables injected into the authentified requests.TokenInjection

cURLSequenceRequestPreset

PropertyTypeRequiredDescriptionReference
curlstringTrueA curl template used to make a request.
extractionsTokenExtractionFalseVariables extracted from the response that can be templated in further requests.TokenExtraction

cURLSequenceUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe arbitrary name that identifies the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
variablesDict[string, string]FalseA dict of variables to inject into the cURL sequences.

cURLUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe arbitrary name that identifies the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
curlstringTrueThe 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

HTTPLocation

  • header

  • cookie

  • body

  • query

HTTPMethod

  • CONNECT

  • DELETE

  • GET

  • HEAD

  • OPTIONS

  • PATCH

  • POST

  • PUT

  • TRACE

  • AuthenticationVariable
  • BasicPreset
  • BasicUserPreset
  • CognitoUserpassPreset
  • CognitoUserpassUserPreset
  • Credentials
  • DigestOperation
  • DigestPreset
  • DigestRequestSequence
  • DigestSecondRequestConfiguration
  • GraphQLPreset
  • GraphQLUserPreset
  • HTTPCookie
  • HTTPHeader
  • HTTPOperation
  • HTTPPreset
  • HTTPQueryParameter
  • HTTPRequestParameters
  • HTTPRequestPreset
  • HTTPUserPreset
  • HeadersPreset
  • HeadersUserPreset
  • OAuthClientCredentialsPreset
  • OAuthClientCredentialsUserPreset
  • OAuthUserpassPreset
  • OAuthUserpassUserPreset
  • Procedure
  • SeleniumCommand
  • SeleniumOperation
  • SeleniumOperationParameters
  • SeleniumProject
  • SeleniumScriptOptions
  • SeleniumTest
  • TokenExtraction
  • TokenInjection
  • User
  • UserRefresh
  • WebdriverPreset
  • WebdriverUserPreset
  • cURLPreset
  • cURLSequencePreset
  • cURLSequenceRequestPreset
  • cURLSequenceUserPreset
  • cURLUserPreset
  • AWSRegion
  • HTTPLocation
  • HTTPMethod