Rechercher des pages de consentement

GET

https://workflow-manager/api/consentPages

GET

/api/consentPages

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

{
  "pageIndex": 1,
  "itemsPerPage": 1,
  "totalItems": 1,
  "items": [
    {
      "stepType": "approval",
      "signingMode": "local",
      "allowOrganization": true,
      "authenticateUser": true,
      "clientId": "string",
      "created": 1,
      "emUrl": "string",
      "hideDownloads": true,
      "hideMobileQrCode": true,
      "id": "string",
      "isCountryRequired": true,
      "isDisabled": true,
      "name": "string",
      "primaryColor": "string",
      "sharedPassphrase": "string",
      "tenantId": "string",
      "tsaUrl": "string",
      "updated": 1,
      "verifyEmail": true,
      "verifyPhoneNumber": true,
      "keystoreTypes": [
        "OS"
      ],
      "logoResourceId": "string",
      "strictCertificateControl": true,
      "jobOperation": "string"
    }
  ]
}

Recherche dans toutes les pages de consentement.

Rôle requis

consentPageManager

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

Recherche dans toutes les pages de consentement. <Note title="Rôle requis"> `consentPageManager` Également autorisés sans rôle : tout utilisateur du tenant. </Note>

Authentification

AuthorizationBearer

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

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel

La ou les valeurs de filtre du champ id.

items.tenantIdstringOptionnel

La ou les valeurs de filtre du champ tenantId.

items.isDefaultstringOptionnel

La ou les valeurs de filtre du champ isDefault.

items.isDisabledstringOptionnel

La ou les valeurs de filtre du champ isDisabled.

items.namestringOptionnel

La ou les valeurs de filtre du champ name.

items.stepTypestringOptionnel

La ou les valeurs de filtre du champ stepType.

items.clientIdstringOptionnel

La ou les valeurs de filtre du champ clientId.

items.createdstringOptionnel

La ou les valeurs de filtre du champ created.

items.updatedstringOptionnel

La ou les valeurs de filtre du champ updated.

sortBystringOptionnel

Le champ utilisé pour trier le résultat de la recherche.

sortOrderenumOptionnel

L’ordre de tri du résultat de la recherche.

Valeurs autorisées:

itemsPerPageintegerOptionnel1-50Par défaut 50

Le nombre d’éléments par page à renvoyer.

pageIndexintegerOptionnel>=0Par défaut 0

L’index de la page à renvoyer.

Réponse

Une page d’entités ConsentPage.

pageIndexintegerOptionnel

L'index de la page.

itemsPerPageintegerOptionnel

Le nombre d’éléments par page.

totalItemsintegerOptionnel

Le nombre total d’éléments, toutes pages comprises.

itemslist of objectsOptionnel

Erreurs

400

Bad Request Error

403

Forbidden Error