Consulter une page de consentement

GET

https://workflow-manager/api/consentPages/:consentPageId

GET

/api/consentPages/:consentPageId

curl https://workflow-manager/api/consentPages/consentPageId \
     -H "Authorization: Bearer <token>"

{
  "stepType": "signature",
  "signingMode": "server",
  "allowOrganization": true,
  "authenticateUser": false,
  "clientId": "clt01",
  "created": 1782821280796,
  "emUrl": "https://evidence-manager.lex-persona.com/",
  "hideDownloads": false,
  "hideMobileQrCode": true,
  "id": "cop_AfGTsGSh1mmatSUL5AWFo2Do",
  "isCountryRequired": false,
  "isDisabled": false,
  "name": "Cyan",
  "primaryColor": "#208cdf",
  "sharedPassphrase": "****************",
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "tsaUrl": "https://tsa.sunnystamp.com/tsa",
  "updated": 1782821280796,
  "verifyEmail": false,
  "verifyPhoneNumber": false,
  "logoResourceId": "res_mHJdVK9q7uKstGgs9RK1xCvg",
  "certificateFilterInvalidOnSign": false,
  "certificateFilterRequiredCommitmentValue": false
}

Renvoie une page de consentement existante.

Rôle requis

consentPageManager

Également autorisés sans rôle : tout utilisateur du tenant.

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.

Réponse

Consulter une page de consentement

stepTypeenum

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

Valeurs autorisées:

signingModeenum

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

Valeurs autorisées:

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.

Valeurs autorisées:

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.

certificateFilterInvalidOnSignbooleanOptionnel

Indique si les certificats non valides à la date de signature sont exclus.

certificateFilterRequiredCommitmentValuebooleanOptionnel

Indique si seuls les certificats destinés à la signature sont acceptés.

jobOperationstringOptionnel

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

Erreurs

403

Forbidden Error

404

Not Found Error