API ReferenceDocumentation APIToken PortailSignature Profiles

Consulter un profil de signature

Afficher en MarkdownOuvrir dans Claude
Renvoie un profil de signature existant. <Note title="Rôle requis"> Aucun. Autorisés : tout utilisateur du tenant. </Note>

Authentification

AuthorizationBearer

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

Paramètres de chemin

signatureProfileIdstringRequis
L'identifiant du profil de signature.

Réponse

Consulter un profil de signature
signatureTypeenum

Le type de signature appliqué par ce profil de signature. Valeurs possibles : pades, xades, xadesDetached, xadesDetachedManifest, cades, cadesDetached, helios.

createdlong

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

documentTypestring
Le type de document auquel s'applique le profil de signature.
forceScrollDocumentboolean

Indique si le signataire ou le validateur est obligé de lire le document.

idstring
L'identifiant du profil de signature.
isDefaultboolean

Indique si le profil de signature est le profil de signature par défaut du tenant.

isDisabledboolean

Indique si le profil de signature est désactivé.

namestring
Le nom du profil de signature.
pdfVisibleSignatureModestring
Le mode de signature visible du profil de signature.
tenantIdstring
L'identifiant du tenant auquel appartient le profil de signature.
updatedlong

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

signaturePolicyDigestAlgorithmKeyenumOptionnel

L’algorithme de hachage utilisé pour calculer l’empreinte de la politique de signature. Sans valeur spécifiée, l’algorithme de la politique de signature par défaut est appliqué. Valeurs possibles : NOSHA, SHA1, SHA256, SHA384, SHA512.

visualobjectOptionnel
pdfDefaultSignatureImagestringOptionnel

L’image par défaut incluse dans l’image de signature, dans le cas d’une signature PDF visible.

pdfSignatureImageHeightdoubleOptionnel
La hauteur de l'image de signature, dans le cas d'une signature PDF visible.
pdfSignatureImageTextstringOptionnel

Le texte inclus dans l’image de signature, dans le cas d’une signature PDF visible. Le modèle doit obligatoirement contenir la variable {{signerName}}. Il peut aussi contenir des variables facultatives comme {{date}}, {{signerOrganization}}, {{signerOrganizationTitle}} ou des références à des métadonnées comme {{data1}}, {{data2}}, etc. La date de signature peut être formatée avec la syntaxe SimpleDateFormat de Java, par exemple : {{date format=‘dd-MM-YYYY’}}.

pdfSignatureImageTextColorstringOptionnel
La couleur du texte inclus dans l'image de signature, dans le cas d'une signature PDF visible.
pdfSignatureImageTextFontstringOptionnel
La famille de police du texte inclus dans l'image de signature, dans le cas d'une signature PDF visible.
pdfSignatureImageTextSizedoubleOptionnel
La taille du texte inclus dans l'image de signature, dans le cas d'une signature PDF visible.
pdfSignatureImageWidthdoubleOptionnel
La largeur de l'image de signature, dans le cas d'une signature PDF visible.
signaturePolicyDigestValueBase64stringOptionnel

L’empreinte de la politique de signature. Sans valeur spécifiée, l’empreinte de la politique de signature par défaut est appliquée.

signaturePolicyIdstringOptionnel

L’OID de la politique de signature. Sans valeur spécifiée, l’OID de la politique de signature par défaut est appliqué.

signaturePolicyUristringOptionnel

L’URL d’accès au PDF de la politique de signature. Sans valeur spécifiée, l’URL de la politique de signature par défaut est appliquée.

userGriffOverrideEnabledbooleanOptionnel
Autorise l'ajout de la signature de l'utilisateur, dans le cas d'une signature PDF visible.

Erreurs

403
Forbidden Error
404
Not Found Error