User Attribute Profile を作成

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.userAttributeProfiles.create({
        name: "name",
        user_attributes: {
            key: {
                description: "description",
                label: "label",
                profile_required: true,
                auth0_mapping: "auth0_mapping",
            },
        },
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.userAttributeProfiles.create({
        name: "name",
        user_attributes: {
            key: {
                description: "description",
                label: "label",
                profile_required: true,
                auth0_mapping: "auth0_mapping",
            },
        },
    });
}
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.CreateUserAttributeProfileRequestContent{
        Name: "name",
        UserAttributes: map[string]*management.UserAttributeProfileUserAttributeAdditionalProperties{
            "key": &management.UserAttributeProfileUserAttributeAdditionalProperties{
                Description: "description",
                Label: "label",
                ProfileRequired: true,
                Auth0Mapping: "auth0_mapping",
            },
        },
    }
    mgmt.UserAttributeProfiles.Create(
        context.TODO(),
        request,
    )
}

# Ensure you're logged in: auth0 login
auth0 api post "user-attribute-profiles" --data '{
  "name": "name",
  "user_attributes": {
    "key": {
      "description": "description",
      "label": "label",
      "profile_required": true,
      "auth0_mapping": "auth0_mapping"
    }
  }
}'

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

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.UserAttributeProfiles.CreateAsync(
            new CreateUserAttributeProfileRequestContent {
                Name = "name",
                UserAttributes = new Dictionary<string, UserAttributeProfileUserAttributeAdditionalProperties>(){
                    ["key"] = new UserAttributeProfileUserAttributeAdditionalProperties {
                        Description = "description",
                        Label = "label",
                        ProfileRequired = true,
                        Auth0Mapping = "auth0_mapping"
                    },
                }

            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateUserAttributeProfileRequestContent;
import com.auth0.client.mgmt.types.UserAttributeProfileUserAttributeAdditionalProperties;
import java.util.HashMap;

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

        client.userAttributeProfiles().create(
            CreateUserAttributeProfileRequestContent
                .builder()
                .name("name")
                .userAttributes(
                    new HashMap<String, UserAttributeProfileUserAttributeAdditionalProperties>() {{
                        put("key", UserAttributeProfileUserAttributeAdditionalProperties
                            .builder()
                            .description("description")
                            .label("label")
                            .profileRequired(true)
                            .auth0Mapping("auth0_mapping")
                            .build());
                    }}
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\UserAttributeProfiles\Requests\CreateUserAttributeProfileRequestContent;
use Auth0\SDK\API\Management\Types\UserAttributeProfileUserAttributeAdditionalProperties;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->userAttributeProfiles->create(
    new CreateUserAttributeProfileRequestContent([
        'name' => 'name',
        'userAttributes' => [
            'key' => new UserAttributeProfileUserAttributeAdditionalProperties([
                'description' => 'description',
                'label' => 'label',
                'profileRequired' => true,
                'auth0Mapping' => 'auth0_mapping',
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, UserAttributeProfileUserAttributeAdditionalProperties

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

client.user_attribute_profiles.create(
    name="name",
    user_attributes={
        "key": UserAttributeProfileUserAttributeAdditionalProperties(
            description="description",
            label="label",
            profile_required=True,
            auth_0_mapping="auth0_mapping",
        )
    },
)

require "auth0"

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

client.user_attribute_profiles.create(
  name: "name",
  user_attributes: {
    key: {
      description: "description",
      label: "label",
      profile_required: true,
      auth0mapping: "auth0_mapping"
    }
  }
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/user-attribute-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "user_attributes": {},
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "pingfederate": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "ad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "pingfederate": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "ad": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  },
  "user_attributes": {}
}

POST

https://{tenantDomain}/api/v2

user-attribute-profiles

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.userAttributeProfiles.create({
        name: "name",
        user_attributes: {
            key: {
                description: "description",
                label: "label",
                profile_required: true,
                auth0_mapping: "auth0_mapping",
            },
        },
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.userAttributeProfiles.create({
        name: "name",
        user_attributes: {
            key: {
                description: "description",
                label: "label",
                profile_required: true,
                auth0_mapping: "auth0_mapping",
            },
        },
    });
}
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.CreateUserAttributeProfileRequestContent{
        Name: "name",
        UserAttributes: map[string]*management.UserAttributeProfileUserAttributeAdditionalProperties{
            "key": &management.UserAttributeProfileUserAttributeAdditionalProperties{
                Description: "description",
                Label: "label",
                ProfileRequired: true,
                Auth0Mapping: "auth0_mapping",
            },
        },
    }
    mgmt.UserAttributeProfiles.Create(
        context.TODO(),
        request,
    )
}

# Ensure you're logged in: auth0 login
auth0 api post "user-attribute-profiles" --data '{
  "name": "name",
  "user_attributes": {
    "key": {
      "description": "description",
      "label": "label",
      "profile_required": true,
      "auth0_mapping": "auth0_mapping"
    }
  }
}'

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

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.UserAttributeProfiles.CreateAsync(
            new CreateUserAttributeProfileRequestContent {
                Name = "name",
                UserAttributes = new Dictionary<string, UserAttributeProfileUserAttributeAdditionalProperties>(){
                    ["key"] = new UserAttributeProfileUserAttributeAdditionalProperties {
                        Description = "description",
                        Label = "label",
                        ProfileRequired = true,
                        Auth0Mapping = "auth0_mapping"
                    },
                }

            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateUserAttributeProfileRequestContent;
import com.auth0.client.mgmt.types.UserAttributeProfileUserAttributeAdditionalProperties;
import java.util.HashMap;

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

        client.userAttributeProfiles().create(
            CreateUserAttributeProfileRequestContent
                .builder()
                .name("name")
                .userAttributes(
                    new HashMap<String, UserAttributeProfileUserAttributeAdditionalProperties>() {{
                        put("key", UserAttributeProfileUserAttributeAdditionalProperties
                            .builder()
                            .description("description")
                            .label("label")
                            .profileRequired(true)
                            .auth0Mapping("auth0_mapping")
                            .build());
                    }}
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\UserAttributeProfiles\Requests\CreateUserAttributeProfileRequestContent;
use Auth0\SDK\API\Management\Types\UserAttributeProfileUserAttributeAdditionalProperties;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->userAttributeProfiles->create(
    new CreateUserAttributeProfileRequestContent([
        'name' => 'name',
        'userAttributes' => [
            'key' => new UserAttributeProfileUserAttributeAdditionalProperties([
                'description' => 'description',
                'label' => 'label',
                'profileRequired' => true,
                'auth0Mapping' => 'auth0_mapping',
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, UserAttributeProfileUserAttributeAdditionalProperties

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

client.user_attribute_profiles.create(
    name="name",
    user_attributes={
        "key": UserAttributeProfileUserAttributeAdditionalProperties(
            description="description",
            label="label",
            profile_required=True,
            auth_0_mapping="auth0_mapping",
        )
    },
)

require "auth0"

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

client.user_attribute_profiles.create(
  name: "name",
  user_attributes: {
    key: {
      description: "description",
      label: "label",
      profile_required: true,
      auth0mapping: "auth0_mapping"
    }
  }
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/user-attribute-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "user_attributes": {},
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "pingfederate": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "ad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "pingfederate": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "ad": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  },
  "user_attributes": {}
}

承認

Authorization

string

header

必須

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

ボディ

name

string

必須

ユーザー属性プロファイルの名前。

Required string length: 1 - 128

user_attributes

object

必須

ユーザー属性の設定マップ。キーは属性名、値は各属性のマッピング設定です。

Show child attributes

user_id

object

ユーザーIDのマッピング設定

Show child attributes

レスポンス

ユーザー属性が正常に作成されました。

string<user-attribute-profile-id>

User Attribute Profile の識別子。

name

string

ユーザー属性プロファイルの名前。

Required string length: 1 - 128

user_id

object

ユーザーIDのマッピング設定

Show child attributes

user_attributes

object

ユーザー属性の設定マップ。キーは属性名、値は各属性のマッピング設定です。

Show child attributes