Get flows

GET https://{tenantDomain}/api/v2/flows

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.FlowsListRequest{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Synchronous: management.Bool(
            true,
        ),
    }
    client.Flows.List(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.flows.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        synchronous: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.flows.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        synchronous: true,
    });
}
main();

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

import requests

url = "https://{tenantDomain}/api/v2/flows"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/flows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/flows")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/flows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "executed_at": "2023-12-25"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

page · integer

Page index of the results to return. First page is 0.

必須範囲: 0 <= x <= 1000

per_page · integer

Number of results per page. Defaults to 50.

必須範囲: 1 <= x <= 100

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

hydrate · enum<string>[]

hydration param

利用可能なオプション: form_count

Maximum string length: 50

synchronous · boolean

flag to filter by sync/async flows

レスポンス

200

application/json

Flows successfully retrieved.

object[]

object

id · string<flow-id> · 必須

Maximum string length: 30

name · string · 必須

Required string length: 1 - 150

created_at · string<date-time> · 必須

updated_at · string<date-time> · 必須

executed_at · string<date>