Créer un tenant | Goodflag Docs

curl -X POST https://workflow-manager/admin/api/tenants \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "domainName": "johnston.name",
  "idpType": "google",
  "idpBaseUrl": "https://accounts.google.com/",
  "idpScope": "openid email profile",
  "idpClientId": "4192",
  "idpClientSecret": "C4T7PgV8TFzbdXwzHNQWEeoK",
  "logo": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA...",
  "primaryColor": "#208cdf",
  "secondaryColor": "#4ca3e5",
  "darkColor": "#104670",
  "smtpSenderName": "My application",
  "technicalContactUrl": "https://support.lex-persona.com",
  "loginTokenTtl": 3600000,
  "maxDocumentSize": 10485760,
  "maxDocuments": 200,
  "maxAttachments": 10,
  "downloadLinkTokenValidityDays": 90,
  "defaultCountry": "FR",
  "allowCommentsInSteps": false,
  "allowWatchers": true,
  "defaultAllowComments": false,
  "forceFlattenPdf": false,
  "createUserOnLogin": true,
  "createUserOnLoginGroupId": "grp_BTsBTqgZuePSmmPz5ynWM2nN",
  "certificateEvidenceLanguage": "en",
  "attachmentExtensions": [
    "pdf",
    "word"
  ],
  "lockDocumentsAfterFirstValidation": false,
  "allowConsolidation": true,
  "allowSingleSignerMode": true,
  "allowSupportingDocumentsRequest": false,
  "visual": {
    "allowVisual": false
  },
  "allowSignatureOnHigherSignatureLevel": false
}'

{
  "activateExternalArchive": false,
  "allowCommentsInSteps": false,
  "allowConsolidation": true,
  "allowExternalArchive": false,
  "allowWatchers": true,
  "allowedTenantStatus": [
    "active",
    "inactive",
    "trial"
  ],
  "attachmentExtensions": [
    "pdf",
    "word"
  ],
  "certificateEvidenceLanguage": "en",
  "createUserOnLogin": true,
  "created": 1782821859835,
  "darkColor": "#104670",
  "defaultAllowComments": false,
  "defaultCountry": "FR",
  "defaultGroupId": "grp_KVeAkf49W4eQAzztQKtwN2ji",
  "domainName": "johnston.name",
  "downloadLinkTokenValidityDays": 90,
  "forceFlattenPdf": false,
  "id": "ten_P367j8DWNsDRcamZwByH4XvU",
  "idpBaseUrl": "https://accounts.google.com/",
  "idpClientId": "4192",
  "idpClientSecret": "****************",
  "idpScope": "openid email profile",
  "idpType": "google",
  "lockDocumentsAfterFirstValidation": false,
  "loginTokenTtl": 3600000,
  "maxAttachments": 10,
  "maxDocumentSize": 10485760,
  "maxDocuments": 200,
  "primaryColor": "#208cdf",
  "secondaryColor": "#4ca3e5",
  "smtpSenderName": "My application",
  "technicalContactUrl": "https://support.lex-persona.com",
  "updated": 1782821859835,
  "allowSignatureOnHigherSignatureLevel": false,
  "allowSingleSignerMode": true,
  "allowSupportingDocumentsRequest": false,
  "consentVersion": "V2",
  "createUserOnLoginGroupId": "grp_BTsBTqgZuePSmmPz5ynWM2nN",
  "logoResourceId": "res_GHgiG3XHT8fTqckLX4yTb8YL",
  "requireSupportingDocuments": false,
  "tenantStatus": "trial",
  "visual": {
    "allowVisual": false
  }
}

Crée un nouveau tenant. Réservé aux administrateurs.

Rôle requis

Administrateur de la plateforme (back-office Goodflag). Inaccessible aux utilisateurs du tenant.

Crée un nouveau tenant. 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.

Requête

This endpoint expects an object.

domainNamestringRequis

Le nom de domaine du tenant.

idpTypestringRequis

Type de fournisseur d’identité.

idpBaseUrlstringRequis

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

idpScopestringRequis

Scope du fournisseur d’identité OpenID Connect.

idpClientIdstringRequis

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

idpClientSecretstringRequis

Secret client du fournisseur d’identité OpenID Connect.

logostringOptionnel

L'image de logo du portail, sous forme de data URI.

primaryColorstringOptionnel

La couleur principale du portail.

secondaryColorstringOptionnel

La couleur secondaire du portail.

darkColorstringOptionnel

La couleur sombre du portail.

smtpSenderNamestringOptionnel

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

technicalContactUrlstringOptionnel

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

loginTokenTtllongOptionnel>=600000

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

maxDocumentSizelongOptionnelPar 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.

maxDocumentslongOptionnelPar défaut 200

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

maxAttachmentslongOptionnelPar défaut 10

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

downloadLinkTokenValidityDayslongOptionnelPar défaut 3650

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

defaultCountrystringOptionnel

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.

allowCommentsInStepsbooleanOptionnel

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

allowWatchersbooleanOptionnel

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

defaultAllowCommentsbooleanOptionnel

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

forceFlattenPdfbooleanOptionnel

Indique si les champs de signature existants sont aplatis lors de l'envoi des PDF.

createUserOnLoginbooleanOptionnel

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

createUserOnLoginGroupIdstringOptionnel

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

certificateEvidenceLanguagestringOptionnel

La langue du certificat de preuve.

attachmentExtensionslist of stringsOptionnel

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

lockDocumentsAfterFirstValidationbooleanOptionnel

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

allowConsolidationbooleanOptionnel

Indique si la consolidation du parapheur est activée.

allowSingleSignerModebooleanOptionnel

Indique si le mode signataire unique est autorisé.

allowSupportingDocumentsRequestbooleanOptionnel

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

visualobjectOptionnel

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.

organizationNamestringOptionnel

Le nom de l'organisation du tenant.

requireSupportingDocumentsbooleanOptionnel

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

Réponse

L’entité Tenant créé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

400

Bad Request Error

403

Forbidden Error