Get an execution

Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.

GET https://{tenantDomain}/api/v2/actions/executions/{id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Actions.Executions.GetAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.Actions.Executions.Get(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.actions().executions().get("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->executions->get(
    'id',
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.actions.executions.get(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.actions.executions.get(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.executions.get("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.executions.get("id");
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/actions/executions/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "c5b35bb1-c67d-40bb-9b0d-700b6fe33dd9",
  "status": "final",
  "results": [
    {
      "action_name": "my-action",
      "error": {
        "id": "<string>",
        "msg": "<string>",
        "url": "<string>"
      },
      "started_at": "2021-01-01T00:00:00.000Z",
      "ended_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "created_at": "2021-01-01T00:00:00.000Z",
  "updated_at": "2021-01-01T00:00:00.000Z"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The ID of the execution to retrieve.

Response

200

application/json

The execution was retrieved.

The result of a specific execution of a trigger.

id · string · default: c5b35bb1-c67d-40bb-9b0d-700b6fe33dd9

ID identifies this specific execution simulation. These IDs would resemble real executions in production.

trigger_id · enum<string>

An actions extensibility point.

Available options: post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-phone-provider, custom-email-provider, password-reset-post-challenge, custom-token-exchange, event-stream, password-hash-migration, login-post-identifier, signup-post-identifier

status · enum<string> · default: final

The overall status of an execution.

Available options: unspecified, pending, final, partial, canceled, suspended

results · object[]

Show child attributes

created_at · string<date-time> · default: 2021-01-01T00:00:00.000Z

The time that the execution was started.

updated_at · string<date-time> · default: 2021-01-01T00:00:00.000Z

The time that the exeution finished executing.