リソースサーバーを作成

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

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.ResourceServers.CreateAsync(
            new CreateResourceServerRequestContent {
                Identifier = "identifier"
            }
        );
    }

}

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.CreateResourceServerRequestContent{
        Identifier: "identifier",
    }
    mgmt.ResourceServers.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateResourceServerRequestContent;

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

        client.resourceServers().create(
            CreateResourceServerRequestContent
                .builder()
                .identifier("identifier")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ResourceServers\Requests\CreateResourceServerRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->resourceServers->create(
    new CreateResourceServerRequestContent([
        'identifier' => 'identifier',
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.create({
        identifier: "identifier",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.create({
        identifier: "identifier",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/resource-servers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "authorization_details": [
    "<unknown>"
  ],
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "enforce_policies": true,
  "name": "<string>",
  "proof_of_possession": {
    "required": true
  },
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "skip_consent_for_verifiable_first_party_clients": true,
  "subject_type_authorization": {
    "client": {},
    "user": {}
  },
  "token_encryption": {
    "encryption_key": {
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "kid": "<string>",
      "name": "<string>"
    },
    "format": "compact-nested-jwe"
  },
  "token_lifetime": 1296000
}
'

{
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "authorization_details": [
    "<unknown>"
  ],
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "client_id": "<string>",
  "enforce_policies": true,
  "id": "<string>",
  "identifier": "<string>",
  "is_system": true,
  "name": "<string>",
  "proof_of_possession": {
    "required": true
  },
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "skip_consent_for_verifiable_first_party_clients": true,
  "subject_type_authorization": {
    "client": {},
    "user": {}
  },
  "token_encryption": {
    "encryption_key": {
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "kid": "<string>",
      "name": "<string>"
    },
    "format": "compact-nested-jwe"
  },
  "token_lifetime": 123,
  "token_lifetime_for_web": 123
}

POST

https://{tenantDomain}/api/v2

resource-servers

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

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.ResourceServers.CreateAsync(
            new CreateResourceServerRequestContent {
                Identifier = "identifier"
            }
        );
    }

}

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.CreateResourceServerRequestContent{
        Identifier: "identifier",
    }
    mgmt.ResourceServers.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateResourceServerRequestContent;

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

        client.resourceServers().create(
            CreateResourceServerRequestContent
                .builder()
                .identifier("identifier")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ResourceServers\Requests\CreateResourceServerRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->resourceServers->create(
    new CreateResourceServerRequestContent([
        'identifier' => 'identifier',
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.create({
        identifier: "identifier",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.create({
        identifier: "identifier",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/resource-servers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "authorization_details": [
    "<unknown>"
  ],
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "enforce_policies": true,
  "name": "<string>",
  "proof_of_possession": {
    "required": true
  },
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "skip_consent_for_verifiable_first_party_clients": true,
  "subject_type_authorization": {
    "client": {},
    "user": {}
  },
  "token_encryption": {
    "encryption_key": {
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "kid": "<string>",
      "name": "<string>"
    },
    "format": "compact-nested-jwe"
  },
  "token_lifetime": 1296000
}
'

{
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "authorization_details": [
    "<unknown>"
  ],
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "client_id": "<string>",
  "enforce_policies": true,
  "id": "<string>",
  "identifier": "<string>",
  "is_system": true,
  "name": "<string>",
  "proof_of_possession": {
    "required": true
  },
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "skip_consent_for_verifiable_first_party_clients": true,
  "subject_type_authorization": {
    "client": {},
    "user": {}
  },
  "token_encryption": {
    "encryption_key": {
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "kid": "<string>",
      "name": "<string>"
    },
    "format": "compact-nested-jwe"
  },
  "token_lifetime": 123,
  "token_lifetime_for_web": 123
}

承認

Authorization

string

header

必須

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

ボディ

identifier

string

必須

認可リクエストで audience パラメーターとして使用されるAPIの一意の識別子。設定後は変更できません。

Required string length: 1 - 600

allow_offline_access

boolean

この API でリフレッシュトークンを発行できるかどうかを示します（true の場合は発行可、false の場合は不可）。

allow_online_access

boolean

この API で Online Refresh Tokens を発行できるかどうかを示します（true の場合は発行可、false の場合は不可）。

allow_online_access_with_ephemeral_sessions

boolean

セッションがエフェメラルに設定されている場合でも、この API で Online Refresh Tokens を発行できるかどうかを示します（true の場合は発行可、false の場合は不可）。

authorization_details

any[] | null

authorization_policy

object | null

リソースサーバーの認可ポリシー。

Show child attributes

利用可能なオプション:

transactional-authorization-with-mfa,

null

enforce_policies

boolean

認可ポリシーを適用するか、無視するかを示します（true の場合は適用、false の場合は無視）。

name

string

このリソースサーバーの表示名。< または > は使用できません。

Maximum string length: 200

Pattern: ^[^<>]+$

proof_of_possession

object | null

アクセストークンの Proof-of-Possession 設定

Show child attributes

scopes

object[]

このAPIで使用するpermissions（scopes）の一覧。

Show child attributes

signing_alg

enum<string>

デフォルト:HS256

JWTの署名に使用するアルゴリズム。HS256（デフォルト）または RS256 を指定できます。PS256 は addon で利用できます。

利用可能なオプション:

HS256,

RS256,

RS512,

PS256

signing_secret

string

対称algorithms（HS256）を使用する場合にtokenの署名に使用するSecret。

Minimum string length: 16

ファーストパーティとしてフラグ付けされたアプリケーションで、ユーザーの同意をスキップするかどうかを示します（true の場合はスキップ、false の場合はスキップしません）。

subject_type_authorization

object

リソースサーバーに対するアプリケーションのアクセス権限を定義します

Show child attributes

token_dialect

enum<string>

発行されるアクセストークンのトークンダイアレクト。access_token は標準の Auth0 クレームを含む JWT、rfc9068_profile は IETF JWT Access Token Profile に準拠した JWT です。access_token_authz と rfc9068_profile_authz には、さらに RBAC の permissions クレームが含まれます。

利用可能なオプション:

access_token,

access_token_authz,

rfc9068_profile,

rfc9068_profile_authz

token_encryption

object | null

Show child attributes

token_lifetime

integer

トークンエンドポイントからこの API 用に発行されるアクセストークンの有効期限（秒）。

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

レスポンス

リソースサーバーの作成に成功しました。

allow_offline_access

boolean

この API でリフレッシュトークンを発行できるかどうかを示します（true の場合は発行可、false の場合は不可）。

allow_online_access

boolean

この API で Online Refresh Tokens を発行できるかどうかを示します（true の場合は発行可、false の場合は不可）。

allow_online_access_with_ephemeral_sessions

boolean

authorization_details

any[] | null

authorization_policy

object | null

リソースサーバーの認可ポリシー。

Show child attributes

client_id

string<client-id>

このリソースサーバーにリンクされているクライアントの client ID

利用可能なオプション:

transactional-authorization-with-mfa,

null

enforce_policies

boolean

認可ポリシーが適用されるかどうかを示します（true の場合は適用、false の場合は未適用）。

string

API の ID（リソースサーバー）。

identifier

string

認可リクエストで audience パラメーターとして使用される API の一意の識別子。設定後は変更できません。

is_system

boolean

これが Auth0 システム API（true）か、カスタム API（false）かを示します。

name

string

このリソースサーバーの表示名。< または > の文字は使用できません。

proof_of_possession

object | null

アクセストークンの Proof-of-Possession 設定

Show child attributes

scopes

object[]

この API で使用する権限（scopes）の一覧。

Show child attributes

signing_alg

enum<string>

デフォルト:HS256

JWTの署名に使用するアルゴリズム。HS256（デフォルト）または RS256 を指定できます。PS256 は addon で利用できます。

利用可能なオプション:

HS256,

RS256,

RS512,

PS256

signing_secret

string

対称アルゴリズム（HS256）の使用時にトークンの署名に使用する Secret。

Minimum string length: 16

subject_type_authorization

object

リソースサーバーに対するアプリケーションのアクセス権限を定義します

Show child attributes

token_dialect

enum<string>

発行するアクセストークンのトークンダイアレクト。access_token は標準の Auth0 クレームを含む JWT、rfc9068_profile は IETF JWT Access Token Profile に準拠した JWT です。access_token_authz と rfc9068_profile_authz には、さらに RBAC の permissions クレームが含まれます。

利用可能なオプション:

access_token,

access_token_authz,

rfc9068_profile,

rfc9068_profile_authz

token_encryption

object | null

Show child attributes

token_lifetime

integer

トークンエンドポイントからこの API 用に発行されるアクセストークンの有効期限（秒）。

token_lifetime_for_web

integer

Implicit またはハイブリッドフローを介してこの API 用に発行されるアクセストークンの有効期限（秒）。token_lifetime の値を超えることはできません。