Auth0

Use auth0 in twins and put this configuration under seed_config.auth0. Auth0 customer identity tenant, distinct from Okta Workforce Identity.

Example seed

This is the complete Scenario request body for creating a Scenario. You can also import it with arga test-runner scenarios import --file scenario.json.

{
  "name": "Auth0 eval fixture",
  "twins": [
    "auth0"
  ],
  "seed_config": {
    "auth0": {
      "domain": "auth0-twin.us.auth0.com",
      "clients": [
        {
          "client_id": "scenario-client",
          "client_secret": "scenario-client-secret",
          "name": "Customer portal",
          "app_type": "regular_web",
          "callbacks": [
            "http://localhost:3000/callback"
          ],
          "allowed_logout_urls": [
            "http://localhost:3000"
          ],
          "grant_types": [
            "authorization_code",
            "refresh_token",
            "client_credentials"
          ]
        }
      ],
      "connections": [
        {
          "id": "con_customers",
          "name": "Username-Password-Authentication",
          "strategy": "auth0",
          "enabled_clients": [
            "scenario-client"
          ]
        }
      ],
      "resource_servers": [
        {
          "id": "api_customer_portal",
          "name": "Customer API",
          "identifier": "https://api.example.test",
          "signing_alg": "RS256",
          "scopes": [
            {
              "value": "read:orders",
              "description": "Read customer orders"
            }
          ]
        }
      ],
      "roles": [
        {
          "id": "rol_customer",
          "name": "Customer",
          "description": "Customer portal member",
          "permissions": [
            {
              "permission_name": "read:orders",
              "resource_server_identifier": "https://api.example.test"
            }
          ]
        }
      ],
      "users": [
        {
          "user_id": "auth0|customer-ada",
          "email": "ada@example.test",
          "name": "Ada Lovelace",
          "password": "ScenarioPassword123!",
          "email_verified": true,
          "connection": "Username-Password-Authentication",
          "roles": [
            "rol_customer"
          ],
          "app_metadata": {
            "plan": "team"
          },
          "user_metadata": {
            "locale": "en"
          }
        }
      ],
      "organizations": [
        {
          "id": "org_acme",
          "name": "acme",
          "display_name": "Acme",
          "members": [
            "auth0|customer-ada"
          ],
          "enabled_connections": [
            {
              "connection_id": "con_customers",
              "assign_membership_on_login": false
            }
          ]
        }
      ],
      "client_grants": [
        {
          "id": "cgr_customer_api",
          "client_id": "scenario-client",
          "audience": "https://api.example.test",
          "scope": [
            "read:orders"
          ]
        }
      ],
      "actions": [
        {
          "id": "act_customer_portal",
          "name": "Customer portal claim",
          "supported_triggers": [
            {
              "id": "credentials-exchange",
              "version": "v2"
            }
          ],
          "runtime": "node22",
          "code": "exports.onExecuteCredentialsExchange = (event, api) => { api.accessToken.setCustomClaim('https://api.example.test/portal', true); };",
          "deployed_version": {
            "id": "ver_customer_portal"
          },
          "all_changes_deployed": true
        }
      ],
      "action_versions": {
        "ver_customer_portal": {
          "action_id": "act_customer_portal",
          "number": 1,
          "deployed": true,
          "supported_triggers": [
            {
              "id": "credentials-exchange",
              "version": "v2"
            }
          ],
          "runtime": "node22",
          "code": "exports.onExecuteCredentialsExchange = (event, api) => { api.accessToken.setCustomClaim('https://api.example.test/portal', true); };"
        }
      },
      "action_bindings": {
        "credentials-exchange": {
          "bindings": [
            {
              "action": {
                "id": "act_customer_portal"
              }
            }
          ]
        }
      },
      "log_streams": [
        {
          "id": "lst_customer_audit",
          "name": "Customer audit logs",
          "type": "http",
          "status": "active",
          "sink": {
            "httpEndpoint": "https://logs.example.test/auth0",
            "httpContentType": "application/json",
            "httpContentFormat": "JSONLINES"
          }
        }
      ]
    }
  }
}

Parameters

The following fields belong directly inside seed_config.auth0. Required nested fields are marked in their tables. Provider-native objects can contain service-specific fields beyond the representative record shapes below.

Parameter	Type	Description
`domain`	`string`	Domain.
`clients`	`object[]`	Clients fixtures in provider-native format.
`connections`	`object[]`	Connections fixtures in provider-native format.
`resource_servers`	`object[]`	Resource servers fixtures in provider-native format.
`roles`	`object[]`	Role definitions and their supported relationships.
`users`	`object[]`	Users fixtures in provider-native format.
`organizations`	`object[]`	Organizations fixtures in provider-native format.
`client_grants`	`object[]`	Client grants fixtures in provider-native format.
`actions`	`object[]`	Actions fixtures in provider-native format.
`action_versions`	`object`	Action versions.
`action_bindings`	`object`	Action bindings.
`log_streams`	`object[]`	Log streams fixtures in provider-native format.
`issuer`	`string or null`	Issuer.
`management_audience`	`string or null`	Management audience.
`management_token`	`string`	Management token.
`client_id`	`string`	Test OAuth client identifier.
`client_secret`	`string`	Test OAuth client secret.
`bootstrap_client_enabled`	`boolean`	Enable or set bootstrap client enabled behavior.
`callbacks`	`string[]`	Callbacks fixtures in provider-native format.
`allowed_logout_urls`	`string[]`	Allowed logout urls fixtures in provider-native format.
`default_directory`	`string`	Default directory.
`enforce_auth`	`boolean`	Enable or set enforce auth behavior.
`fixed_time`	`string or null`	Fixed time.
`token_lifetime_seconds`	`integer`	Token lifetime seconds, in seconds. Minimum: 1.
`refresh_token_lifetime_seconds`	`integer`	Refresh token lifetime seconds, in seconds. Minimum: 1.
`authorization_code_lifetime_seconds`	`integer`	Authorization code lifetime seconds, in seconds. Minimum: 1.
`session_lifetime_seconds`	`integer`	Session lifetime seconds, in seconds. Minimum: 1.
`rate_limiting_enabled`	`boolean`	Enable request rate limiting.
`rate_limit_per_minute`	`integer`	Rate limit per minute. Minimum: 1.
`resources`	`object`	Provider resource collections keyed by collection name. Preserve their native record fields and references.
`failure_rules`	`object[]`	Deterministic failure-injection rules.

Seeding behavior

Supplying clients replaces the starter OAuth application unless bootstrap_client_enabled is explicitly retained. Seed at least one OAuth client when disabling the bootstrap client. Relationship IDs in roles, grants, organizations, and connections must match the declared resources.

Resource fields

These tables describe the record shapes used by the example. Keep native field names and casing. Map keys such as property names, IDs, and metadata keys are supplied by your fixture.

`clients[]`

Parameter	Type	Description
`client_id`	`string`	Test OAuth client identifier.
`client_secret`	`string`	Test OAuth client secret.
`name`	`string`	Human-readable name.
`app_type`	`string`	App type.
`callbacks`	`string[]`	Callbacks fixtures in provider-native format.
`allowed_logout_urls`	`string[]`	Allowed logout urls fixtures in provider-native format.
`grant_types`	`string[]`	Grant types fixtures in provider-native format.

`connections[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`name`	`string`	Human-readable name.
`strategy`	`string`	Strategy.
`enabled_clients`	`string[]`	Enabled clients fixtures in provider-native format.

`resource_servers[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`name`	`string`	Human-readable name.
`identifier`	`string`	Identifier.
`signing_alg`	`string`	Signing alg.
`scopes`	`object[]`	Scopes fixtures in provider-native format.

`resource_servers[].scopes[]`

Parameter	Type	Description
`value`	`string`	Value.
`description`	`string`	Description.

`roles[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`name`	`string`	Human-readable name.
`description`	`string`	Description.
`permissions`	`object[]`	Permissions fixtures in provider-native format.

`roles[].permissions[]`

Parameter	Type	Description
`permission_name`	`string`	Permission name.
`resource_server_identifier`	`string`	Resource server identifier.

`users[]`

Parameter	Type	Description
`user_id`	`string`	User id.
`email`	`string`	Main account email address.
`name`	`string`	Human-readable name.
`password`	`string`	Password.
`email_verified`	`boolean`	Enable or set email verified behavior.
`connection`	`string`	Connection.
`roles`	`string[]`	Role definitions and their supported relationships.
`app_metadata`	`object`	App metadata.
`user_metadata`	`object`	User metadata.

`organizations[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`name`	`string`	Human-readable name.
`display_name`	`string`	Display name.
`members`	`string[]`	Members fixtures in provider-native format.
`enabled_connections`	`object[]`	Enabled connections fixtures in provider-native format.

`organizations[].enabled_connections[]`

Parameter	Type	Description
`connection_id`	`string`	Connection id.
`assign_membership_on_login`	`boolean`	Enable or set assign membership on login behavior.

`client_grants[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`client_id`	`string`	Test OAuth client identifier.
`audience`	`string`	Audience.
`scope`	`string[]`	Scope fixtures in provider-native format.

`actions[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`name`	`string`	Human-readable name.
`supported_triggers`	`object[]`	Supported triggers fixtures in provider-native format.
`runtime`	`string`	Runtime.
`code`	`string`	Code.
`deployed_version`	`object`	Deployed version.
`all_changes_deployed`	`boolean`	Enable or set all changes deployed behavior.

`actions[].supported_triggers[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`version`	`string`	Version.

`log_streams[]`

Parameter	Type	Description
`id`	`string`	Explicit resource identifier, when supported.
`name`	`string`	Human-readable name.
`type`	`string`	Type.
`status`	`string`	Status.
`sink`	`object`	Sink.

See Scenario seeding for saving, provisioning, and resetting fixtures.

Get started

Digital twins

Tests

Setup

Integrations

Resources

Example seed

Parameters

Seeding behavior

Resource fields

`clients[]`

`connections[]`

`resource_servers[]`

`resource_servers[].scopes[]`

`roles[]`

`roles[].permissions[]`

`users[]`

`organizations[]`

`organizations[].enabled_connections[]`

`client_grants[]`

`actions[]`

`actions[].supported_triggers[]`

`log_streams[]`

​Example seed

​Parameters

​Seeding behavior

​Resource fields

​clients[]

​connections[]

​resource_servers[]

​resource_servers[].scopes[]

​roles[]

​roles[].permissions[]

​users[]

​organizations[]

​organizations[].enabled_connections[]

​client_grants[]

​actions[]

​actions[].supported_triggers[]

​log_streams[]

Example seed

Parameters

Seeding behavior

Resource fields

`clients[]`

`connections[]`

`resource_servers[]`

`resource_servers[].scopes[]`

`roles[]`

`roles[].permissions[]`

`users[]`

`organizations[]`

`organizations[].enabled_connections[]`

`client_grants[]`

`actions[]`

`actions[].supported_triggers[]`

`log_streams[]`