Create a verifiable credential template.

Create a verifiable credential template.

POST https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates

C#

C#

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

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.VerifiableCredentials.Verification.Templates.CreateAsync(
            new CreateVerifiableCredentialTemplateRequestContent {
                Name = "name",
                Type = "type",
                Dialect = "dialect",
                Presentation = new MdlPresentationRequest {
                    OrgIso1801351MDl = new MdlPresentationRequestProperties {
                        OrgIso1801351 = new MdlPresentationProperties()
                    }
                },
                WellKnownTrustedIssuers = "well_known_trusted_issuers"
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &verification.CreateVerifiableCredentialTemplateRequestContent{
        Name: "name",
        Type: "type",
        Dialect: "dialect",
        Presentation: &management.MdlPresentationRequest{
            OrgIso1801351MDl: &management.MdlPresentationRequestProperties{
                OrgIso1801351: &management.MdlPresentationProperties{},
            },
        },
        WellKnownTrustedIssuers: "well_known_trusted_issuers",
    }
    mgmt.VerifiableCredentials.Verification.Templates.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.MdlPresentationProperties;
import com.auth0.client.mgmt.types.MdlPresentationRequest;
import com.auth0.client.mgmt.types.MdlPresentationRequestProperties;
import com.auth0.client.mgmt.verifiablecredentials.verification.types.CreateVerifiableCredentialTemplateRequestContent;

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

        client.verifiableCredentials().verification().templates().create(
            CreateVerifiableCredentialTemplateRequestContent
                .builder()
                .name("name")
                .type("type")
                .dialect("dialect")
                .presentation(
                    MdlPresentationRequest
                        .builder()
                        .orgIso1801351MDl(
                            MdlPresentationRequestProperties
                                .builder()
                                .orgIso1801351(
                                    MdlPresentationProperties
                                        .builder()
                                        .build()
                                )
                                .build()
                        )
                        .build()
                )
                .wellKnownTrustedIssuers("well_known_trusted_issuers")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\VerifiableCredentials\Verification\Templates\Requests\CreateVerifiableCredentialTemplateRequestContent;
use Auth0\SDK\API\Management\Types\MdlPresentationRequest;
use Auth0\SDK\API\Management\Types\MdlPresentationRequestProperties;
use Auth0\SDK\API\Management\Types\MdlPresentationProperties;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->verifiableCredentials->verification->templates->create(
    new CreateVerifiableCredentialTemplateRequestContent([
        'name' => 'name',
        'type' => 'type',
        'dialect' => 'dialect',
        'presentation' => new MdlPresentationRequest([
            'orgIso1801351MDl' => new MdlPresentationRequestProperties([
                'orgIso1801351' => new MdlPresentationProperties([]),
            ]),
        ]),
        'wellKnownTrustedIssuers' => 'well_known_trusted_issuers',
    ]),
);

from auth0.management import ManagementClient, MdlPresentationRequest, MdlPresentationRequestProperties, MdlPresentationProperties

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

client.verifiable_credentials.verification.templates.create(
    name="name",
    type="type",
    dialect="dialect",
    presentation=MdlPresentationRequest(
        org_iso_18013_5_1_m_dl=MdlPresentationRequestProperties(
            org_iso_18013_5_1=MdlPresentationProperties(),
        ),
    ),
    well_known_trusted_issuers="well_known_trusted_issuers",
)

require "auth0"

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

client.verifiable_credentials.verification.templates.create(
  name: "name",
  type: "type",
  dialect: "dialect",
  presentation: {
    org_iso_18013_5_1_m_dl: {
      org_iso_18013_5_1: {}
    }
  },
  well_known_trusted_issuers: "well_known_trusted_issuers"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.verifiableCredentials.verification.templates.create({
        name: "name",
        type: "type",
        dialect: "dialect",
        presentation: {
            orgIso1801351MDl: {
                orgIso1801351: {},
            },
        },
        wellKnownTrustedIssuers: "well_known_trusted_issuers",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.verifiableCredentials.verification.templates.create({
        name: "name",
        type: "type",
        dialect: "dialect",
        presentation: {
            orgIso1801351MDl: {
                orgIso1801351: {},
            },
        },
        wellKnownTrustedIssuers: "well_known_trusted_issuers",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "dialect": "<string>",
  "presentation": {
    "org.iso.18013.5.1.mDL": {
      "org.iso.18013.5.1": {
        "family_name": true,
        "given_name": true,
        "birth_date": true,
        "issue_date": true,
        "expiry_date": true,
        "issuing_country": true,
        "issuing_authority": true,
        "portrait": true,
        "driving_privileges": true,
        "resident_address": true,
        "portrait_capture_date": true,
        "age_in_years": true,
        "age_birth_year": true,
        "issuing_jurisdiction": true,
        "nationality": true,
        "resident_city": true,
        "resident_state": true,
        "resident_postal_code": true,
        "resident_country": true,
        "family_name_national_character": true,
        "given_name_national_character": true
      }
    }
  },
  "well_known_trusted_issuers": "<string>",
  "custom_certificate_authority": "<string>"
}
'

201

{
  "id": "vct_0000000000000001",
  "name": "<string>",
  "type": "mdl",
  "dialect": "simplified/1.0",
  "presentation": {
    "org.iso.18013.5.1.mDL": {
      "org.iso.18013.5.1": {
        "family_name": true,
        "given_name": true,
        "birth_date": true,
        "issue_date": true,
        "expiry_date": true,
        "issuing_country": true,
        "issuing_authority": true,
        "portrait": true,
        "driving_privileges": true,
        "resident_address": true,
        "portrait_capture_date": true,
        "age_in_years": true,
        "age_birth_year": true,
        "issuing_jurisdiction": true,
        "nationality": true,
        "resident_city": true,
        "resident_state": true,
        "resident_postal_code": true,
        "resident_country": true,
        "family_name_national_character": true,
        "given_name_national_character": true
      }
    }
  },
  "custom_certificate_authority": "<string>",
  "well_known_trusted_issuers": "<string>",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

name · string · 必須

Required string length: 1 - 255

type · string · 必須

Required string length: 1 - 255

dialect · string · 必須

Maximum string length: 255

Pattern: ^simplified/1.0$

presentation · object · 必須

A simplified presentation request

Show child attributes

well_known_trusted_issuers · string · 必須

Required string length: 1 - 255

Pattern: ^aamva$

custom_certificate_authority · string | null

Required string length: 1 - 4096

レスポンス

201

application/json

Template successfully created.

id · string · デフォルト: vct_0000000000000001

The id of the template.

name · string

The name of the template.

type · string · デフォルト: mdl

The type of the template.

dialect · string · デフォルト: simplified/1.0

The dialect of the template.

Maximum string length: 255

presentation · object

A simplified presentation request

Show child attributes

custom_certificate_authority · string | null

The custom certificate authority.

Required string length: 1 - 4096

well_known_trusted_issuers · string | null

The well-known trusted issuers, comma separated.

Required string length: 1 - 255

created_at · string<date-time> · デフォルト: 2021-01-01T00:00:00Z

The date and time the template was created.

updated_at · string<date-time> · デフォルト: 2021-01-01T00:00:00Z

The date and time the template was created.