フォームを取得

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

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.Forms.ListAsync(
            new ListFormsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Hydrate = new List<FormsRequestParametersHydrateEnum>(){
                    FormsRequestParametersHydrateEnum.FlowCount,
                }

            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ListFormsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    mgmt.Forms.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.FormsRequestParametersHydrateEnum;
import com.auth0.client.mgmt.types.ListFormsRequestParameters;
import java.util.Arrays;

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

        client.forms().list(
            ListFormsRequestParameters
                .builder()
                .hydrate(
                    Arrays.asList(FormsRequestParametersHydrateEnum.FLOW_COUNT)
                )
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Forms\Requests\ListFormsRequestParameters;
use Auth0\SDK\API\Management\Types\FormsRequestParametersHydrateEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->forms->list(
    new ListFormsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'hydrate' => [
            FormsRequestParametersHydrateEnum::FlowCount->value,
        ],
    ]),
);

from auth0.management import ManagementClient

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

client.forms.list(
    page=1,
    per_page=1,
    include_totals=True,
    hydrate=[
        "flow_count"
    ],
)

require "auth0"

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

client.forms.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  hydrate: ["flow_count"]
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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

GET

https://{tenantDomain}/api/v2

forms

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

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.Forms.ListAsync(
            new ListFormsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Hydrate = new List<FormsRequestParametersHydrateEnum>(){
                    FormsRequestParametersHydrateEnum.FlowCount,
                }

            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ListFormsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    mgmt.Forms.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.FormsRequestParametersHydrateEnum;
import com.auth0.client.mgmt.types.ListFormsRequestParameters;
import java.util.Arrays;

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

        client.forms().list(
            ListFormsRequestParameters
                .builder()
                .hydrate(
                    Arrays.asList(FormsRequestParametersHydrateEnum.FLOW_COUNT)
                )
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Forms\Requests\ListFormsRequestParameters;
use Auth0\SDK\API\Management\Types\FormsRequestParametersHydrateEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->forms->list(
    new ListFormsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'hydrate' => [
            FormsRequestParametersHydrateEnum::FlowCount->value,
        ],
    ]),
);

from auth0.management import ManagementClient

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

client.forms.list(
    page=1,
    per_page=1,
    include_totals=True,
    hydrate=[
        "flow_count"
    ],
)

require "auth0"

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

client.forms.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  hydrate: ["flow_count"]
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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

承認

Authorization

string

header

必須

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

クエリパラメータ

page

integer

返される結果のページ index です。最初のページは 0 です。

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

per_page

integer

1 ページあたりの結果数です。既定値は 50 です。

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

include_totals

boolean

結果を、合計結果件数を含むオブジェクト内に返すか（true）、結果の配列を直接返すか（false、既定値）を指定します。

hydrate

enum<string>[]

追加データでレスポンスを補完するためのクエリパラメータ

利用可能なオプション:

flow_count,

links

Maximum string length: 50

レスポンス

フォームを正常に取得しました。

object[]
object

created_at

string<date-time>

必須

string<form-id>

必須

Maximum string length: 30

name

string

必須

Required string length: 1 - 150

updated_at

string<date-time>

必須

embedded_at

string<date>

submitted_at

string<date>