Supprimer un tenant

Afficher en Markdown
Supprime un tenant existant. Réservé aux administrateurs. <Note title="Rôle requis"> Administrateur de la plateforme (back-office Goodflag). Inaccessible aux utilisateurs du tenant. </Note>

Authentification

AuthorizationBasic

Identifiants d’administration, requis pour les endpoints /admin/api et /experimental/admin/api.

Paramètres de chemin

tenantIdstringRequis
L'identifiant du tenant.

En-têtes

If-MatchstringRequis

L’ETag de la ressource, pour le contrôle de concurrence optimiste.

Réponse

L’entité Tenant supprimée.

activateExternalArchiveboolean

Indique si les fichiers de preuve sont versés dans un système d’archivage externe lors de l’archivage du parapheur.

allowCommentsInStepsboolean

Indique si l’autorisation des commentaires est gérée par le gestionnaire du parapheur.

allowConsolidationboolean

Indique si la consolidation du parapheur est activée.

allowExternalArchiveboolean

Indique si le tenant est autorisé à verser dans un système d’archivage externe.

allowWatchersboolean

Indique si l’autorisation des observateurs est gérée par le gestionnaire du parapheur.

allowedTenantStatuslist of strings

Les statuts vers lesquels le tenant est autorisé à basculer.

attachmentExtensionslist of strings

Les extensions de fichier autorisées pour les pièces jointes des parapheurs.

certificateEvidenceLanguagestring
La langue du certificat de preuve.
createUserOnLoginboolean

Indique si les utilisateurs sont créés automatiquement à la première connexion.

createdlong

La date de création de l’entité.

darkColorstring
La couleur sombre du portail.
defaultAllowCommentsboolean

La valeur par défaut de l’autorisation des commentaires dans les étapes.

defaultCountrystring

Le pays par défaut des nouveaux utilisateurs, lorsque le fournisseur d’identité ne le fournit pas. Sans valeur spécifiée, le pays par défaut est FR.

defaultGroupIdstring

L’identifiant du groupe par défaut du tenant.

domainNamestring
Le nom de domaine du tenant.
downloadLinkTokenValidityDayslongPar défaut 3650

Durée de validité du jeton de lien de téléchargement, en jours.

forceFlattenPdfboolean
Indique si les champs de signature existants sont aplatis lors de l'envoi des PDF.
idstring
L'identifiant du tenant.
idpBaseUrlstring

URL de base du fournisseur d’identité OpenID Connect.

idpClientIdstring

Identifiant client (client ID) du fournisseur d’identité OpenID Connect.

idpClientSecretstring

Secret client du fournisseur d’identité OpenID Connect.

idpScopestring

Scope du fournisseur d’identité OpenID Connect.

idpTypestring

Type de fournisseur d’identité.

lockDocumentsAfterFirstValidationboolean

Indique si les documents sont verrouillés après la première validation.

loginTokenTtllong>=600000

La durée de validité du jeton de connexion au portail, en millisecondes.

maxAttachmentslongPar défaut 10

Le nombre maximal de pièces jointes autorisé par le portail.

maxDocumentSizelongPar défaut 10485760

La taille maximale de document autorisée par le portail, en octets. Au-delà de 104857600 octets, une option payante est nécessaire.

maxDocumentslongPar défaut 200

Le nombre maximal de documents à signer autorisé par le portail.

primaryColorstring
La couleur principale du portail.
secondaryColorstring
La couleur secondaire du portail.
smtpSenderNamestring

Le nom d’expéditeur des emails de notification.

technicalContactUrlstring

L’URL du contact technique affichée dans le portail.

updatedlong

La date de dernière modification de l’entité.

allowSignatureOnHigherSignatureLevelbooleanOptionnel

Autorise la signature d’un document qui porte déjà une signature de niveau supérieur. Par exemple, permet de cosigner en LT un document portant une signature LTA.

allowSingleSignerModebooleanOptionnel

Indique si le mode signataire unique est autorisé pour les parapheurs de ce tenant.

allowSupportingDocumentsRequestbooleanOptionnel

Indique si les pièces justificatives sont autorisées.

consentVersionstringOptionnel
createUserOnLoginGroupIdstringOptionnel

Identifiant du groupe sélectionné lorsque l’option de création de l’utilisateur à la première connexion est activée.

logoResourceIdstringOptionnel
L'identifiant de la ressource image du logo.
requireSupportingDocumentsbooleanOptionnel

Indique si les pièces justificatives sont requises pour les parapheurs de ce tenant.

tenantStatusstringOptionnel
Le statut du tenant.
visualobjectOptionnel
organizationNamestringOptionnel
Le nom de l'organisation du tenant.
externalArchivingParametersobjectOptionnel

Paramètres d’archivage externe du parapheur archivé.

jobOperationstringOptionnel

L’opération de tâche en cours d’exécution.

Erreurs

403
Forbidden Error
404
Not Found Error
409
Conflict Error
412
Precondition Failed Error