Rechercher des tenants

GET

https://workflow-manager/admin/api/tenants

GET

/admin/api/tenants

curl https://workflow-manager/admin/api/tenants \
     -u "<username>:<password>"

{
  "pageIndex": 1,
  "itemsPerPage": 1,
  "totalItems": 1,
  "items": [
    {
      "activateExternalArchive": true,
      "allowCommentsInSteps": true,
      "allowConsolidation": true,
      "allowExternalArchive": true,
      "allowWatchers": true,
      "allowedTenantStatus": [
        "string"
      ],
      "attachmentExtensions": [
        "string"
      ],
      "certificateEvidenceLanguage": "string",
      "createUserOnLogin": true,
      "created": 1,
      "darkColor": "string",
      "defaultAllowComments": true,
      "defaultCountry": "string",
      "defaultGroupId": "string",
      "domainName": "string",
      "downloadLinkTokenValidityDays": 3650,
      "forceFlattenPdf": true,
      "id": "string",
      "idpBaseUrl": "string",
      "idpClientId": "string",
      "idpClientSecret": "string",
      "idpScope": "string",
      "idpType": "string",
      "lockDocumentsAfterFirstValidation": true,
      "loginTokenTtl": 1,
      "maxAttachments": 10,
      "maxDocumentSize": 10485760,
      "maxDocuments": 200,
      "primaryColor": "string",
      "secondaryColor": "string",
      "smtpSenderName": "string",
      "technicalContactUrl": "string",
      "updated": 1,
      "allowSignatureOnHigherSignatureLevel": true,
      "allowSingleSignerMode": true,
      "allowSupportingDocumentsRequest": true,
      "consentVersion": "string",
      "createUserOnLoginGroupId": "string",
      "logoResourceId": "string",
      "requireSupportingDocuments": true,
      "tenantStatus": "string",
      "visual": {
        "allowVisual": true,
        "text": "string"
      },
      "organizationName": "string",
      "externalArchivingParameters": {
        "archiverId": "string",
        "filesToArchive": [
          "evidenceFiles"
        ],
        "metadata": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "jobOperation": "string"
    }
  ]
}

Recherche dans tous les tenants. Réservé aux administrateurs.

Rôle requis

Administrateur de la plateforme (back-office Goodflag). Inaccessible aux utilisateurs du tenant.

Recherche dans tous les tenants. Réservé aux administrateurs. <Note title="Rôle requis"> Administrateur de la plateforme (back-office Goodflag). Inaccessible aux utilisateurs du tenant. </Note>

Authentification

AuthorizationBasic

Identifiants d’administration, requis pour les endpoints /admin/api et /experimental/admin/api.

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel

La ou les valeurs de filtre du champ id.

items.domainNamestringOptionnel

La ou les valeurs de filtre du champ domainName.

items.tenantStatusstringOptionnel

La ou les valeurs de filtre du champ tenantStatus.

items.organizationNamestringOptionnel

La ou les valeurs de filtre du champ organizationName.

items.jobOperationstringOptionnel

La ou les valeurs de filtre du champ jobOperation.

items.jobErrorCodestringOptionnel

La ou les valeurs de filtre du champ jobErrorCode.

items.createdstringOptionnel

La ou les valeurs de filtre du champ created.

items.updatedstringOptionnel

La ou les valeurs de filtre du champ updated.

items.externalArchivingParameters.archiverIdstringOptionnel

La ou les valeurs de filtre du champ externalArchivingParameters.archiverId.

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 Tenant.

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