Create a Network ACL key

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.keys.networkAcls.create({
        name: "name",
        alg: "hmac-sha256",
        value: "value",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.keys.networkAcls.create({
        name: "name",
        alg: "hmac-sha256",
        value: "value",
    });
}
main();

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.CreateKeysNetworkACLsRequestContent{
        Name: "name",
        Alg: management.NetworkACLKeyAlgorithmEnumHmacSha256,
        Value: "value",
    }
    mgmt.Keys.NetworkACLs.Create(
        context.TODO(),
        request,
    )
}

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

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.Keys.NetworkAcls.CreateAsync(
            new CreateKeysNetworkAclsRequestContent {
                Name = "name",
                Alg = NetworkAclKeyAlgorithmEnum.HmacSha256,
                Value = "value"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.keys.types.CreateKeysNetworkAclsRequestContent;
import com.auth0.client.mgmt.types.NetworkAclKeyAlgorithmEnum;

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

        client.keys().networkAcls().create(
            CreateKeysNetworkAclsRequestContent
                .builder()
                .name("name")
                .alg(NetworkAclKeyAlgorithmEnum.HMAC_SHA256)
                .value("value")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Keys\NetworkAcls\Requests\CreateKeysNetworkAclsRequestContent;
use Auth0\SDK\API\Management\Types\NetworkAclKeyAlgorithmEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->keys->networkAcls->create(
    new CreateKeysNetworkAclsRequestContent([
        'name' => 'name',
        'alg' => NetworkAclKeyAlgorithmEnum::HmacSha256->value,
        'value' => 'value',
    ]),
);

from auth0.management import ManagementClient

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

client.keys.network_acls.create(
    name="name",
    alg="hmac-sha256",
    value="value",
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/keys/network-acls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "alg": "hmac-sha256",
  "value": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "alg": "hmac-sha256",
  "fingerprint": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "message": "<string>",
  "statusCode": 400,
  "error": "Bad Request"
}

{
  "message": "<string>",
  "statusCode": 401,
  "error": "Unauthorized"
}

{
  "message": "<string>",
  "statusCode": 403,
  "error": "Forbidden"
}

{
  "message": "<string>",
  "statusCode": 409,
  "error": "Conflict"
}

{
  "message": "<string>",
  "statusCode": 429,
  "error": "Too Many Requests"
}

POST

https://{tenantDomain}/api/v2

keys

network-acls

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.keys.networkAcls.create({
        name: "name",
        alg: "hmac-sha256",
        value: "value",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.keys.networkAcls.create({
        name: "name",
        alg: "hmac-sha256",
        value: "value",
    });
}
main();

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.CreateKeysNetworkACLsRequestContent{
        Name: "name",
        Alg: management.NetworkACLKeyAlgorithmEnumHmacSha256,
        Value: "value",
    }
    mgmt.Keys.NetworkACLs.Create(
        context.TODO(),
        request,
    )
}

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

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.Keys.NetworkAcls.CreateAsync(
            new CreateKeysNetworkAclsRequestContent {
                Name = "name",
                Alg = NetworkAclKeyAlgorithmEnum.HmacSha256,
                Value = "value"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.keys.types.CreateKeysNetworkAclsRequestContent;
import com.auth0.client.mgmt.types.NetworkAclKeyAlgorithmEnum;

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

        client.keys().networkAcls().create(
            CreateKeysNetworkAclsRequestContent
                .builder()
                .name("name")
                .alg(NetworkAclKeyAlgorithmEnum.HMAC_SHA256)
                .value("value")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Keys\NetworkAcls\Requests\CreateKeysNetworkAclsRequestContent;
use Auth0\SDK\API\Management\Types\NetworkAclKeyAlgorithmEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->keys->networkAcls->create(
    new CreateKeysNetworkAclsRequestContent([
        'name' => 'name',
        'alg' => NetworkAclKeyAlgorithmEnum::HmacSha256->value,
        'value' => 'value',
    ]),
);

from auth0.management import ManagementClient

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

client.keys.network_acls.create(
    name="name",
    alg="hmac-sha256",
    value="value",
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/keys/network-acls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "alg": "hmac-sha256",
  "value": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "alg": "hmac-sha256",
  "fingerprint": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "message": "<string>",
  "statusCode": 400,
  "error": "Bad Request"
}

{
  "message": "<string>",
  "statusCode": 401,
  "error": "Unauthorized"
}

{
  "message": "<string>",
  "statusCode": 403,
  "error": "Forbidden"
}

{
  "message": "<string>",
  "statusCode": 409,
  "error": "Conflict"
}

{
  "message": "<string>",
  "statusCode": 429,
  "error": "Too Many Requests"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

The Network ACL key to create.

name

string

required

Customer-supplied label with no cryptographic meaning. Must be unique across all Network ACL keys for the tenant.

Maximum string length: 255

Pattern: ^[^\u0000]*$

alg

enum<string>

required

Signing algorithm used to verify the signature. Currently only HMAC-SHA256 is supported.

Available options:

hmac-sha256

value

string<hmac_sha256_key_value>

required

Base64-encoded raw key material. Constraints on the decoded value depend on the algorithm specified. Currently only HMAC-SHA256 is supported.

Maximum string length: 1024

Response

The Network ACL key was created.

string

required

Auth0-generated identifier for the key. Used to reference the key from a Network ACL and to identify it in Tenant Logs.

name

string

required

Customer-supplied label with no cryptographic meaning.

Maximum string length: 255

alg

enum<string>

required

Signing algorithm used to verify the signature. Currently only HMAC-SHA256 is supported.

Available options:

hmac-sha256

fingerprint

string

required

Fingerprint of the key material, determined by the algorithm specified. Currently only HMAC-SHA256 is supported.

Maximum string length: 1024

created_at

string

required

Time when the key was created.

updated_at

string

required

Time when the key was last updated.