セルフサービスプロファイルを取得

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.SelfServiceProfiles.ListAsync(
            new ListSelfServiceProfilesRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true
            }
        );
    }

}

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.ListSelfServiceProfilesRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    mgmt.SelfServiceProfiles.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

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

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

        client.selfServiceProfiles().list(
            ListSelfServiceProfilesRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\SelfServiceProfiles\Requests\ListSelfServiceProfilesRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->selfServiceProfiles->list(
    new ListSelfServiceProfilesRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.self_service_profiles.list(
    page=1,
    per_page=1,
    include_totals=True,
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

[
  {
    "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>"
      }
    ]
  }
]

GET

https://{tenantDomain}/api/v2

self-service-profiles

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.SelfServiceProfiles.ListAsync(
            new ListSelfServiceProfilesRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true
            }
        );
    }

}

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.ListSelfServiceProfilesRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    mgmt.SelfServiceProfiles.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

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

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

        client.selfServiceProfiles().list(
            ListSelfServiceProfilesRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\SelfServiceProfiles\Requests\ListSelfServiceProfilesRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->selfServiceProfiles->list(
    new ListSelfServiceProfilesRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.self_service_profiles.list(
    page=1,
    per_page=1,
    include_totals=True,
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

[
  {
    "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.

クエリパラメータ

page

integer

返される結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

per_page

integer

1 ページあたりの結果数。デフォルトは 50 です。

必須範囲: 1 <= x <= 100

include_totals

boolean

結果の総数を含むオブジェクト内に結果を返す（true）か、結果の array を直接返す（false、デフォルト）かを指定します。

レスポンス

既存のプロファイルの一覧。

object[]
object

allowed_strategies

enum<string>[]

Self-Service Enterprise Configurationフローでユーザーに表示されるIdP strategyの一覧。指定可能な値: [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

Show child attributes

created_at

string<date-time>

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

このセルフサービスプロファイルが作成された日時。

description

string

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

string

デフォルト:ssp_n7SNCL8seoyV1TuSTCnAeo

セルフサービスプロファイルの一意のID。

name

string

セルフサービスプロファイルの名前。

updated_at

string<date-time>

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

このセルフサービスプロファイルが更新された日時。

user_attribute_profile_id

string<user-attribute-profile-id>

このセルフサービスプロファイルに関連付けるuser-attribute-profileのID。

user_attributes

object[]

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

Show child attributes