Create a Flows Vault connection

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

C#

C#

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

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

        await client.Flows.Vault.Connections.CreateAsync(
            new CreateFlowsVaultConnectionActivecampaignApiKey {
                Name = "name",
                AppId = "ACTIVECAMPAIGN",
                Setup = new FlowsVaultConnectioSetupApiKeyWithBaseUrl {
                    Type = "API_KEY",
                    ApiKey = "api_key",
                    BaseUrl = "base_url"
                }
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateFlowsVaultConnectionActivecampaign;
import com.auth0.client.mgmt.types.CreateFlowsVaultConnectionActivecampaignApiKey;
import com.auth0.client.mgmt.types.CreateFlowsVaultConnectionRequestContent;
import com.auth0.client.mgmt.types.FlowsVaultConnectioSetupApiKeyWithBaseUrl;

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

        client.flows().vault().connections().create(
            CreateFlowsVaultConnectionRequestContent.of(
                CreateFlowsVaultConnectionActivecampaign.of(
                    CreateFlowsVaultConnectionActivecampaignApiKey
                        .builder()
                        .name("name")
                        .appId("ACTIVECAMPAIGN")
                        .setup(
                            FlowsVaultConnectioSetupApiKeyWithBaseUrl
                                .builder()
                                .type("API_KEY")
                                .apiKey("api_key")
                                .baseUrl("base_url")
                                .build()
                        )
                        .build()
                )
            )
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Types\CreateFlowsVaultConnectionActivecampaignApiKey;
use Auth0\SDK\API\Management\Types\FlowsVaultConnectioSetupApiKeyWithBaseUrl;

$client = new Management(
    token: '<token>',
);
$client->flows->vault->connections->create(
    new CreateFlowsVaultConnectionActivecampaignApiKey([
        'name' => 'name',
        'appId' => 'ACTIVECAMPAIGN',
        'setup' => new FlowsVaultConnectioSetupApiKeyWithBaseUrl([
            'type' => 'API_KEY',
            'apiKey' => 'api_key',
            'baseUrl' => 'base_url',
        ]),
    ]),
);

from auth0.management import ManagementClient, CreateFlowsVaultConnectionActivecampaignApiKey, FlowsVaultConnectioSetupApiKeyWithBaseUrl

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

client.flows.vault.connections.create(
    request=CreateFlowsVaultConnectionActivecampaignApiKey(
        name="name",
        app_id="ACTIVECAMPAIGN",
        setup=FlowsVaultConnectioSetupApiKeyWithBaseUrl(
            type="API_KEY",
            api_key="api_key",
            base_url="base_url",
        ),
    ),
)

require "auth0"

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

client.flows.vault.connections.create(request: {
  name: "name",
  app_id: "ACTIVECAMPAIGN",
  setup: {
    type: "API_KEY",
    api_key: "api_key",
    base_url: "base_url"
  }
})

curl --request POST \
  --url https://{tenantDomain}/api/v2/flows/vault/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "app_id": "ACTIVECAMPAIGN",
  "setup": {
    "type": "API_KEY",
    "api_key": "<string>",
    "base_url": "<string>"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    app_id: 'ACTIVECAMPAIGN',
    setup: {type: 'API_KEY', api_key: '<string>', base_url: '<string>'}
  })
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"app_id\": \"ACTIVECAMPAIGN\",\n  \"setup\": {\n    \"type\": \"API_KEY\",\n    \"api_key\": \"<string>\",\n    \"base_url\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

201

{
  "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>",
  "environment": "<string>",
  "account_name": "<string>",
  "refreshed_at": "2023-11-07T05:31:56Z"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Option 26

Option 27

Option 28

Option 29

Option 30

Option 31

Option 32

Option 33

Option 34

Option 35

Option 36

Option 37

Option 38

Option 39

Option 40

Option 41

Option 42

Option 43

Option 44

Option 45

Option 46

Option 47

Option 48

Option 49

Option 50

name · string · 必須

Flows Vault Connection name.

Required string length: 1 - 150

app_id · enum<string> · 必須

Flows Vault Connection app identifier.

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

Required string length: 1 - 55

setup · object · 必須

Show child attributes

レスポンス

201

application/json

Connection successfully created.

id · string<flows-vault-connections-id> · 必須

Flows Vault Connection identifier.

Maximum string length: 30

app_id · string · 必須

Flows Vault Connection app identifier.

Required string length: 1 - 55

name · string · 必須

Flows Vault Connection name.

Required string length: 1 - 150

ready · boolean · 必須

Whether the Flows Vault Connection is configured.

created_at · string<date-time> · 必須

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

updated_at · string<date-time> · 必須

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

fingerprint · string · 必須

Minimum string length: 1

environment · string

Flows Vault Connection environment.

Required string length: 1 - 55

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.