Créer un groupe | Goodflag Docs

curl -X POST https://workflow-manager/api/tenants/tenantId/groups \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Sharable optimizing website",
  "description": "7 étage, 528 Passage de Caumartin, 27892 Toulouse",
  "isDisabled": false,
  "hideWorkflowRecipients": false,
  "userRoles": [
    "tenantManager",
    "groupManager",
    "userViewer",
    "workflowViewer",
    "workflowEvidenceDownloader",
    "workflowDeleter",
    "workflowArchiver",
    "userManager",
    "consentPageManager",
    "templateManager",
    "workflowCoManager",
    "workflowManager",
    "layoutManager",
    "organizationManager",
    "workflowInviter",
    "workflowCreator",
    "portalUser",
    "contactCreator",
    "signer",
    "approver",
    "developer",
    "selfAnonymizer",
    "exportViewer",
    "bulkViewer"
  ],
  "templateSelectionMode": "list",
  "allowedTemplates": [
    "wtm_Mr4wtcFXCbXPqsHX1oD1bjtD"
  ],
  "layoutSelectionMode": "listOrNull",
  "allowedLayouts": [
    "lay_HkS1puymUnG8HqTYoWUTb31y"
  ],
  "createUserAuthorizedGroups": [],
  "updateUserAuthorizedGroups": [],
  "deleteUserAuthorizedGroups": [],
  "viewUserAuthorizedGroups": [],
  "createWorkflowAuthorizedGroups": [],
  "updateWorkflowAuthorizedGroups": [],
  "deleteWorkflowAuthorizedGroups": [],
  "viewWorkflowAuthorizedGroups": [],
  "groupedInvitations": {
    "mode": "disabled",
    "activeDays": [
      "1",
      "2",
      "3",
      "4",
      "5"
    ],
    "sendingSlots": [
      {
        "time": "08:00",
        "zone": "Europe/Paris"
      },
      {
        "time": "17:00",
        "zone": "Europe/Paris"
      }
    ],
    "nextCheck": 1782821479149,
    "lastSend": 1782821479149
  }
}'

{
  "templateSelectionMode": "list",
  "layoutSelectionMode": "listOrNull",
  "allowedLayouts": [
    "lay_HkS1puymUnG8HqTYoWUTb31y"
  ],
  "allowedTemplates": [
    "wtm_Mr4wtcFXCbXPqsHX1oD1bjtD"
  ],
  "createUserAuthorizedGroups": [],
  "createWorkflowAuthorizedGroups": [],
  "created": 1782821479152,
  "deleteUserAuthorizedGroups": [],
  "deleteWorkflowAuthorizedGroups": [],
  "hideWorkflowRecipients": false,
  "id": "grp_HrJxdkGCFTtj7xTFdmp4GV8e",
  "isDefault": false,
  "isDisabled": false,
  "name": "Sharable optimizing website",
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updateUserAuthorizedGroups": [],
  "updateWorkflowAuthorizedGroups": [],
  "updated": 1782821479152,
  "userRoles": [
    "tenantManager",
    "groupManager",
    "userViewer",
    "workflowViewer",
    "workflowEvidenceDownloader",
    "workflowDeleter",
    "workflowArchiver",
    "userManager",
    "consentPageManager",
    "templateManager",
    "workflowCoManager",
    "workflowManager",
    "layoutManager",
    "organizationManager",
    "workflowInviter",
    "workflowCreator",
    "portalUser",
    "contactCreator",
    "signer",
    "approver",
    "developer",
    "selfAnonymizer",
    "exportViewer",
    "bulkViewer"
  ],
  "viewUserAuthorizedGroups": [],
  "viewWorkflowAuthorizedGroups": [],
  "description": "7 étage, 528 Passage de Caumartin, 27892 Toulouse",
  "groupedInvitations": {
    "activeDays": [
      "1",
      "2",
      "3",
      "4",
      "5"
    ],
    "mode": "disabled",
    "sendingSlots": [
      {
        "time": "08:00",
        "zone": "Europe/Paris"
      },
      {
        "time": "17:00",
        "zone": "Europe/Paris"
      }
    ]
  }
}

Crée un nouveau groupe dans le tenant.

Rôle requis

groupManager

Crée un nouveau groupe dans le tenant. <Note title="Rôle requis"> `groupManager` </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de chemin

tenantIdstringRequis

L'identifiant du tenant.

Requête

This endpoint expects an object.

namestringRequis

Le nom du groupe.

descriptionstringOptionnel

La description du groupe.

isDisabledbooleanOptionnel

Indique si le groupe est désactivé.

hideWorkflowRecipientsbooleanOptionnel

Indique si les autres destinataires d'un parapheur sont visibles par les destinataires de ce groupe.

userRoleslist of stringsOptionnel

La liste des rôles attribués aux utilisateurs de ce groupe.

templateSelectionModeenumOptionnel

Définit comment les créateurs de parapheurs du groupe peuvent ou doivent utiliser les modèles. Valeurs possibles : list, listOrNull, any ou anyOrNull.

allowedTemplateslist of stringsOptionnel

La liste des modèles utilisables par les utilisateurs de ce groupe.

layoutSelectionModeenumOptionnel

Définit comment les créateurs de parapheurs du groupe peuvent ou doivent utiliser les dispositions. Valeurs possibles : list, listOrNull, any ou anyOrNull.

allowedLayoutslist of stringsOptionnel

La liste des dispositions de parapheur utilisables par les utilisateurs de ce groupe.

createUserAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent créer ou transférer des utilisateurs dans ce groupe. self désigne le groupe courant.

updateUserAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent modifier les utilisateurs de ce groupe. self désigne le groupe courant.

deleteUserAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent anonymiser les utilisateurs de ce groupe. self désigne le groupe courant.

viewUserAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent consulter, rechercher et exporter les utilisateurs de ce groupe. self désigne le groupe courant.

createWorkflowAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent créer ou transférer des parapheurs dans ce groupe. self désigne le groupe courant.

updateWorkflowAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent modifier les parapheurs de ce groupe. self désigne le groupe courant.

deleteWorkflowAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent supprimer des parapheurs de ce groupe. self désigne le groupe courant.

viewWorkflowAuthorizedGroupslist of anyOptionnel

La liste des identifiants de groupes dont les membres peuvent consulter, rechercher et exporter les parapheurs de ce groupe. self désigne le groupe courant.

groupedInvitationsobjectOptionnel

Réponse

L’entité Group créée.

templateSelectionModeenum

Définit comment les créateurs de parapheurs du groupe peuvent ou doivent utiliser les modèles. Valeurs possibles : list, listOrNull, any ou anyOrNull.

layoutSelectionModeenum

Définit comment les créateurs de parapheurs du groupe peuvent ou doivent utiliser les dispositions. Valeurs possibles : list, listOrNull, any ou anyOrNull.

allowedLayoutslist of strings

La liste des dispositions de parapheur utilisables par les utilisateurs de ce groupe.

allowedTemplateslist of strings

La liste des modèles utilisables par les utilisateurs de ce groupe.

createUserAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent créer ou transférer des utilisateurs dans ce groupe.

createWorkflowAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent créer ou transférer des parapheurs dans ce groupe.

createdlong

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

deleteUserAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent anonymiser les utilisateurs de ce groupe.

deleteWorkflowAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent supprimer des parapheurs de ce groupe.

hideWorkflowRecipientsboolean

Indique si les autres destinataires d'un parapheur sont visibles par les destinataires de ce groupe.

idstring

L'identifiant du groupe.

isDefaultboolean

Indique si le groupe est le groupe par défaut du tenant.

isDisabledboolean

Indique si le groupe est désactivé.

namestring

Le nom du groupe.

tenantIdstring

L'identifiant du tenant auquel appartient le groupe.

updateUserAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent modifier les utilisateurs de ce groupe.

updateWorkflowAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent modifier les parapheurs de ce groupe.

updatedlong

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

userRoleslist of strings

La liste des rôles attribués aux utilisateurs de ce groupe.

viewUserAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent consulter, rechercher et exporter les utilisateurs de ce groupe.

viewWorkflowAuthorizedGroupslist of any

La liste des identifiants de groupes dont les membres peuvent consulter, rechercher et exporter les parapheurs de ce groupe.

descriptionstringOptionnel

La description du groupe.

groupedInvitationsobjectOptionnel

jobOperationstringOptionnel

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

Erreurs

400

Bad Request Error

403

Forbidden Error

404

Not Found Error