Get Flows Vault connection list

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Flows.Vault.Connections.ListAsync(
            new ListFlowsVaultConnectionsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.flows.vault.connections.requests.ListFlowsVaultConnectionsRequestParameters;

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

        client.flows().vault().connections().list(
            ListFlowsVaultConnectionsRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Flows\Vault\Connections\Requests\ListFlowsVaultConnectionsRequestParameters;

$client = new Management(
    token: '<token>',
);
$client->flows->vault->connections->list(
    new ListFlowsVaultConnectionsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.flows.vault.connections.list(
    page=1,
    per_page=1,
    include_totals=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.flows.vault.connections.list(
  page: 1,
  per_page: 1,
  include_totals: true
)

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/flows/vault/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

200

[
  {
    "id": "<string>",
    "app_id": "<string>",
    "name": "<string>",
    "ready": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "fingerprint": "<string>",
    "account_name": "<string>",
    "refreshed_at": "2023-11-07T05:31:56Z"
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

page · integer

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

Plage requise: 0 <= x <= 1000

per_page · integer

Number of results per page. Defaults to 50.

Plage requise: 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).

Réponse

200

application/json

Vault connections successfully retrieved.

object[]

object

id · string<flows-vault-connections-id> · requis

Flows Vault Connection identifier.

Maximum string length: 30

app_id · string · requis

Flows Vault Connection app identifier.

Required string length: 1 - 55

name · string · requis

Flows Vault Connection name.

Required string length: 1 - 150

ready · boolean · requis

Whether the Flows Vault Connection is configured.

created_at · string<date-time> · requis

The ISO 8601 formatted date when this Flows Vault Connection was created.

updated_at · string<date-time> · requis

The ISO 8601 formatted date when this Flows Vault Connection was updated.

fingerprint · string · requis

Minimum string length: 1

account_name · string

Flows Vault Connection custom account name.

Required string length: 1 - 150

refreshed_at · string<date-time>

The ISO 8601 formatted date when this Flows Vault Connection was refreshed.