id でセルフサービスプロファイルを部分更新

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateSelfServiceProfileRequestContent{}
    client.SelfServiceProfiles.Update(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.selfServiceProfiles.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.selfServiceProfiles.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/self-service-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowed_strategies": [],
  "branding": {
    "logo_url": "<string>"
  },
  "description": "<string>",
  "name": "<string>",
  "user_attribute_profile_id": "<string>",
  "user_attributes": [
    {
      "description": "<string>",
      "is_optional": true,
      "name": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/self-service-profiles/{id}"

payload = {
    "allowed_strategies": [],
    "branding": { "logo_url": "<string>" },
    "description": "<string>",
    "name": "<string>",
    "user_attribute_profile_id": "<string>",
    "user_attributes": [
        {
            "description": "<string>",
            "is_optional": True,
            "name": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/self-service-profiles/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'allowed_strategies' => [
        
    ],
    'branding' => [
        'logo_url' => '<string>'
    ],
    'description' => '<string>',
    'name' => '<string>',
    'user_attribute_profile_id' => '<string>',
    'user_attributes' => [
        [
                'description' => '<string>',
                'is_optional' => true,
                'name' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/self-service-profiles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowed_strategies\": [],\n  \"branding\": {\n    \"logo_url\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"user_attribute_profile_id\": \"<string>\",\n  \"user_attributes\": [\n    {\n      \"description\": \"<string>\",\n      \"is_optional\": true,\n      \"name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/self-service-profiles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowed_strategies\": [],\n  \"branding\": {\n    \"logo_url\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"user_attribute_profile_id\": \"<string>\",\n  \"user_attributes\": [\n    {\n      \"description\": \"<string>\",\n      \"is_optional\": true,\n      \"name\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "allowed_strategies": [],
  "branding": {
    "colors": {
      "primary": "<string>"
    },
    "logo_url": "<string>"
  },
  "created_at": "2021-01-01T00:00:00.000Z",
  "description": "<string>",
  "id": "ssp_n7SNCL8seoyV1TuSTCnAeo",
  "name": "<string>",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "user_attribute_profile_id": "<string>",
  "user_attributes": [
    {
      "description": "<string>",
      "is_optional": true,
      "name": "<string>"
    }
  ]
}

PATCH

https://{tenantDomain}/api/v2

self-service-profiles

{id}

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateSelfServiceProfileRequestContent{}
    client.SelfServiceProfiles.Update(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.selfServiceProfiles.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.selfServiceProfiles.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/self-service-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowed_strategies": [],
  "branding": {
    "logo_url": "<string>"
  },
  "description": "<string>",
  "name": "<string>",
  "user_attribute_profile_id": "<string>",
  "user_attributes": [
    {
      "description": "<string>",
      "is_optional": true,
      "name": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/self-service-profiles/{id}"

payload = {
    "allowed_strategies": [],
    "branding": { "logo_url": "<string>" },
    "description": "<string>",
    "name": "<string>",
    "user_attribute_profile_id": "<string>",
    "user_attributes": [
        {
            "description": "<string>",
            "is_optional": True,
            "name": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/self-service-profiles/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'allowed_strategies' => [
        
    ],
    'branding' => [
        'logo_url' => '<string>'
    ],
    'description' => '<string>',
    'name' => '<string>',
    'user_attribute_profile_id' => '<string>',
    'user_attributes' => [
        [
                'description' => '<string>',
                'is_optional' => true,
                'name' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/self-service-profiles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowed_strategies\": [],\n  \"branding\": {\n    \"logo_url\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"user_attribute_profile_id\": \"<string>\",\n  \"user_attributes\": [\n    {\n      \"description\": \"<string>\",\n      \"is_optional\": true,\n      \"name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/self-service-profiles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowed_strategies\": [],\n  \"branding\": {\n    \"logo_url\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"user_attribute_profile_id\": \"<string>\",\n  \"user_attributes\": [\n    {\n      \"description\": \"<string>\",\n      \"is_optional\": true,\n      \"name\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "allowed_strategies": [],
  "branding": {
    "colors": {
      "primary": "<string>"
    },
    "logo_url": "<string>"
  },
  "created_at": "2021-01-01T00:00:00.000Z",
  "description": "<string>",
  "id": "ssp_n7SNCL8seoyV1TuSTCnAeo",
  "name": "<string>",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "user_attribute_profile_id": "<string>",
  "user_attributes": [
    {
      "description": "<string>",
      "is_optional": true,
      "name": "<string>"
    }
  ]
}

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

更新するセルフサービスプロファイルの id

ボディ

allowed_strategies

enum<string>[]

Self-Service Enterprise Configuration フロー中にユーザーに表示される IdP 戦略の一覧。指定可能な値: [oidc, samlp, waad, google-apps, adfs, okta, auth0-samlp, okta-samlp, keycloak-samlp, pingfederate]

Minimum array length: 1

利用可能なオプション:

oidc,

samlp,

waad,

google-apps,

adfs,

okta,

auth0-samlp,

okta-samlp,

keycloak-samlp,

pingfederate

branding

object | null

Show child attributes

description

string | null

セルフサービスプロファイルの説明。

Required string length: 1 - 140

name

string

self-service profile の名前。

Required string length: 1 - 100

user_attribute_profile_id

string<user-attribute-profile-id> | null

この self-service profile に関連付ける user-attribute-profile の ID。

user_attributes

object[] | null

Self-Service Enterprise Configuration フロー中にユーザーに表示される、マッピング対象の属性の一覧。

Show child attributes

レスポンス

セルフサービスプロファイルが正常に更新されました。

allowed_strategies

enum<string>[]

Minimum array length: 1

利用可能なオプション:

oidc,

samlp,

waad,

google-apps,

adfs,

okta,

auth0-samlp,

okta-samlp,

keycloak-samlp,

pingfederate

branding

object

Show child attributes

created_at

string<date-time>

デフォルト:2021-01-01T00:00:00.000Z

この self-service profile が作成された日時。

description

string

self-service profile の説明。

string

デフォルト:ssp_n7SNCL8seoyV1TuSTCnAeo

self-service profile の一意の ID。

name

string

self-service profile の名前。

updated_at

string<date-time>

デフォルト:2021-01-01T00:00:00.000Z

この self-service profile が更新された日時。

user_attribute_profile_id

string<user-attribute-profile-id>

この self-service profile に関連付ける user-attribute-profile の ID。

user_attributes

object[]

Self-Service Enterprise Configuration フロー中にユーザーに表示される、マッピングする属性の一覧。

Show child attributes

id でセルフサービスプロファイルを削除

セルフサービスプロファイルのカスタムテキストを取得