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

セルフサービスプロファイルを更新します。

PATCH https://{tenantDomain}/api/v2/self-service-profiles/{id}

Go

Go

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,
    )
}

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

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

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 · EA

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

user_attributes · object[] | null

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

Show child attributes

レスポンス

200

application/json

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

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

Show child attributes

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

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

description · string

self-service profile の説明。

id · 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> · EA

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

user_attributes · object[]

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

Show child attributes