Modifier une page de consentement

curl -X PATCH https://workflow-manager/api/consentPages/consentPageId \
     -H "If-Match: If-Match" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "isDisabled": false,
  "name": "Marron",
  "authenticateUser": true,
  "clientId": "clt01",
  "emUrl": "https://evidence-manager.lex-persona.com/",
  "tsaUrl": "https://tsa.sunnystamp.com/tsa",
  "sharedPassphrase": "8i9eYGpTq9USkXymqvkxR7XT",
  "signingMode": "server",
  "verifyEmail": true,
  "verifyPhoneNumber": true,
  "strictCertificateControl": false,
  "isCountryRequired": true,
  "allowOrganization": true,
  "keystoreTypes": [
    "PKCS11",
    "OS"
  ],
  "logo": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA...",
  "primaryColor": "#208cdf",
  "hideMobileQrCode": false,
  "hideDownloads": false
}'

{
  "stepType": "signature",
  "signingMode": "server",
  "allowOrganization": true,
  "authenticateUser": true,
  "clientId": "clt01",
  "created": 1782821822992,
  "emUrl": "https://evidence-manager.lex-persona.com/",
  "hideDownloads": false,
  "hideMobileQrCode": false,
  "id": "cop_2jjxepRg1fhZGkjcJgzrp6S9",
  "isCountryRequired": true,
  "isDisabled": false,
  "name": "Marron",
  "primaryColor": "#208cdf",
  "sharedPassphrase": "****************",
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "tsaUrl": "https://tsa.sunnystamp.com/tsa",
  "updated": 1782821823074,
  "verifyEmail": true,
  "verifyPhoneNumber": true,
  "logoResourceId": "res_5tgm1LtBPFpGmZVzQsHgUP6K",
  "jobOperation": "purgeConsentPageResource"
}

Modifie une page de consentement existante.

Rôle requis

tenantManager OU consentPageManager

Modifie une page de consentement existante. <Note title="Rôle requis"> `tenantManager` OU `consentPageManager` </Note>

Authentification

AuthorizationBearer

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

Paramètres de chemin

consentPageIdstringRequis

L'identifiant de la page de consentement.

Requête

This endpoint expects an object.

isDisabledbooleanOptionnel

Indique si la page de consentement est désactivée.

namestringOptionnel

Le nom de la page de consentement.

authenticateUserbooleanOptionnel

Indique si l’utilisateur est authentifié auprès du fournisseur d’identité avant d’accéder aux documents.

clientIdstringOptionnel

L'identifiant client de la page de consentement.

emUrlstringOptionnel

L'URL de l'Evidence Manager qui sert la page de consentement.

tsaUrlstringOptionnel

Le serveur d’horodatage conforme à la RFC 3161 à utiliser lors de la signature.

sharedPassphrasestringOptionnel

La phrase secrète partagée de cette page de consentement.

signingModeenumOptionnel

Le mode de signature de cette page de consentement. Valeurs possibles : server, local.

verifyEmailbooleanOptionnel

Indique si l’adresse email de l’utilisateur est vérifiée par un mot de passe à usage unique avant la signature.

verifyPhoneNumberbooleanOptionnel

Indique si le numéro de téléphone de l’utilisateur est vérifié par un mot de passe à usage unique avant la signature.

strictCertificateControlbooleanOptionnel

Indique si le certificat utilisé lors d’une signature locale doit correspondre aux informations de l’utilisateur.

isCountryRequiredbooleanOptionnel

Indique si le pays de l'utilisateur est requis.

allowOrganizationbooleanOptionnel

Indique si les signataires peuvent signer en tant que représentant légal d’une organisation.

keystoreTypeslist of enumsOptionnel

Liste des types de magasins de clés utilisés par Odisia Desktop en mode de signature locale. Valeurs possibles : PKCS11, OS.

logostringOptionnel

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

primaryColorstringOptionnel

La couleur du portail.

hideMobileQrCodebooleanOptionnel

Masque le QR code Odisia Mobile.

hideDownloadsbooleanOptionnel

Masque les boutons de téléchargement.

Réponse

L’entité ConsentPage mise à jour.

stepTypeenum

Le type d’étapes avec lesquelles la page de consentement peut être utilisée : signature ou approval.

signingModeenum

Le mode de signature de cette page de consentement. Valeurs possibles : server, local.

allowOrganizationboolean

Indique si les signataires peuvent signer en tant que représentant légal d’une organisation.

authenticateUserboolean

Indique si l’utilisateur est authentifié auprès du fournisseur d’identité avant d’accéder aux documents.

clientIdstring

L'identifiant client de la page de consentement.

createdlong

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

emUrlstring

L'URL de l'Evidence Manager qui sert la page de consentement.

hideDownloadsboolean

Masque les boutons de téléchargement.

hideMobileQrCodeboolean

Masque le QR code Odisia Mobile.

idstring

L'identifiant de la page de consentement.

isCountryRequiredboolean

Indique si le pays de l'utilisateur est requis.

isDisabledboolean

Indique si la page de consentement est désactivée.

namestring

Le nom de la page de consentement.

primaryColorstring

La couleur du portail.

sharedPassphrasestring

La phrase secrète partagée de cette page de consentement.

tenantIdstring

L'identifiant du tenant auquel appartient la page de consentement.

tsaUrlstring

Le serveur d’horodatage conforme à la RFC 3161 à utiliser lors de la signature.

updatedlong

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

verifyEmailboolean

Indique si l’adresse email de l’utilisateur est vérifiée par un mot de passe à usage unique avant la signature.

verifyPhoneNumberboolean

Indique si le numéro de téléphone de l’utilisateur est vérifié par un mot de passe à usage unique avant la signature.

keystoreTypeslist of enumsOptionnel

Liste des types de magasins de clés utilisés par Odisia Desktop en mode de signature locale.

logoResourceIdstringOptionnel

L'identifiant de la ressource image du logo.

strictCertificateControlbooleanOptionnel

Indique si le certificat utilisé lors d’une signature locale doit correspondre aux informations de l’utilisateur.

jobOperationstringOptionnel

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

Erreurs

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

412

Precondition Failed Error

Authentification

Paramètres de chemin

En-têtes

Requête

Réponse

Erreurs