Mettre à jour les Organizations par ID

Met à jour les détails d’une organisation précise, comme son nom, son nom d’affichage, ses options d’image de marque et ses métadonnées.

PATCH https://{tenantDomain}/api/v2/organizations/{id}

C#

C#

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.Organizations.UpdateAsync(
            id: "id",
            request: new UpdateOrganizationRequestContent()
        );
    }

}

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

ID de l’organisation à mettre à jour.

Corps

application/jsonapplication/x-www-form-urlencoded

branding · object

Theme définit le style des pages de connexion.

Show child attributes

display_name · string · défaut: Acme Users

Nom convivial de cette organisation.

Required string length: 1 - 255

is_app_entitlement_active · boolean · EA

Indique si le droit d’accès à l’application est actif pour cette organisation.

metadata · object

Métadonnées associées à l’organisation, sous la forme d’un objet contenant des valeurs de type String (max. 255 caractères). Un maximum de 25 propriétés de métadonnées est autorisé.

Show child attributes

name · string<organization-name> · défaut: organization-1

Le nom de cette organisation.

Required string length: 1 - 50

third_party_client_access · enum<string> · GA

Détermine si cette organisation peut être utilisée dans les flux utilisateur avec des clients tiers. La valeur par défaut est block.

Options disponibles: block, allow

token_quota · object | null · EA

Show child attributes

Réponse

200

application/json

Organisation mise à jour avec succès.

branding · object

Theme définit le style des pages de connexion.

Show child attributes

client · object · EA

L’association de l’organisation avec le client transmis dans le paramètre de requête include_client_association_for.

Show child attributes

display_name · string · défaut: Acme Users

Nom convivial de cette organisation.

Required string length: 1 - 255

id · string<organization-id>

Identifiant de l’organisation.

Maximum string length: 50

is_app_entitlement_active · boolean · EA

Indique si le droit d’accès à l’application est actif pour cette organisation.

metadata · object

Métadonnées associées à l’organisation, sous la forme d’un objet contenant des valeurs de type String (max. 255 caractères). Un maximum de 25 propriétés de métadonnées est autorisé.

Show child attributes

name · string<organization-name> · défaut: organization-1

Le nom de cette organisation.

Required string length: 1 - 50

third_party_client_access · enum<string> · GA

Détermine si cette organisation peut être utilisée dans les flux utilisateur avec des clients tiers. La valeur par défaut est block.

Options disponibles: block, allow

token_quota · object · EA

Show child attributes