ID で組織を更新

名前、表示名、ブランディングオプション、メタデータなど、特定の組織の詳細を更新します。

PATCH https://{tenantDomain}/api/v2/organizations/{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.UpdateOrganizationRequestContent{}
    client.Organizations.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "branding": {
    "colors": {
      "page_background": "<string>",
      "primary": "<string>"
    },
    "logo_url": "<string>"
  },
  "display_name": "Acme Users",
  "id": "<string>",
  "metadata": {},
  "name": "organization-1",
  "token_quota": {
    "client_credentials": {
      "enforce": true,
      "per_day": 1073741824,
      "per_hour": 1073741824
    }
  }
}

承認

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

branding · object

テーマは、ログインページのスタイルを定義します。

Show child attributes

display_name · string · デフォルト: Acme Users

この組織のフレンドリ名。

Required string length: 1 - 255

metadata · object

組織に関連付けられたメタデータ。文字列値を持つオブジェクト形式です（最大 255 文字）。メタデータプロパティは最大 25 個まで指定できます。

Show child attributes

name · string<organization-name> · デフォルト: organization-1

この組織の名前。

Required string length: 1 - 50

token_quota · object · EA

Show child attributes

レスポンス

200

application/json

組織を正常に更新しました。

branding · object

テーマは、ログインページのスタイルを定義します。

Show child attributes

display_name · string · デフォルト: Acme Users

この組織のフレンドリ名。

Required string length: 1 - 255

id · string<organization-id>

組織の識別子。

Maximum string length: 50

metadata · object

組織に関連付けられたメタデータ。文字列値を持つオブジェクト形式です（最大 255 文字）。メタデータプロパティは最大 25 個まで指定できます。

Show child attributes

name · string<organization-name> · デフォルト: organization-1

この組織の名前。

Required string length: 1 - 50

token_quota · object · EA

Show child attributes